jirayu_sri/YouTube.js
1
0
Fork 0
mirror of https://github.com/LuanRT/YouTube.js.git synced 2026-06-22 05:58:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: add proper documentation (#763)

Browse Source 
* chore: generate API ref using `typedoc`

* chore: declutter readme and add links to ytjs.dev

* chore: clean up
This commit is contained in:
Luan
2024-09-23 17:32:50 -03:00
committed by GitHub
parent dd7f5cf778
commit 74659fd03f
853 changed files with 139814 additions and 1929 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
docs/api/namespaces/YT/classes/TranscriptInfo.md Normal file
View File

@@ -0,0 +1,101 @@
[youtubei.js](../../../README.md) / [YT](../README.md) / TranscriptInfo
# Class: TranscriptInfo
## Constructors
### new TranscriptInfo()
> **new TranscriptInfo**(`actions`, `response`): [`TranscriptInfo`](TranscriptInfo.md)
#### Parameters
• **actions**: [`Actions`](../../../classes/Actions.md)
• **response**: [`ApiResponse`](../../../interfaces/ApiResponse.md)
#### Returns
[`TranscriptInfo`](TranscriptInfo.md)
#### Defined in
[src/parser/youtube/TranscriptInfo.ts:12](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/TranscriptInfo.ts#L12)
## Properties
### transcript
> **transcript**: [`Transcript`](../../YTNodes/classes/Transcript.md)
#### Defined in
[src/parser/youtube/TranscriptInfo.ts:10](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/TranscriptInfo.ts#L10)
## Accessors
### languages
> `get` **languages**(): `string`[]
Returns available languages.
#### Returns
`string`[]
#### Defined in
[src/parser/youtube/TranscriptInfo.ts:45](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/TranscriptInfo.ts#L45)
***
### page
> `get` **page**(): [`IGetTranscriptResponse`](../../APIResponseTypes/type-aliases/IGetTranscriptResponse.md)
#### Returns
[`IGetTranscriptResponse`](../../APIResponseTypes/type-aliases/IGetTranscriptResponse.md)
#### Defined in
[src/parser/youtube/TranscriptInfo.ts:56](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/TranscriptInfo.ts#L56)
***
### selectedLanguage
> `get` **selectedLanguage**(): `string`
Returns the currently selected language.
#### Returns
`string`
#### Defined in
[src/parser/youtube/TranscriptInfo.ts:52](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/TranscriptInfo.ts#L52)
## Methods
### selectLanguage()
> **selectLanguage**(`language`): `Promise`\<[`TranscriptInfo`](TranscriptInfo.md)\>
Selects a language from the language menu and returns the updated transcript.
#### Parameters
• **language**: `string`
Language to select.
#### Returns
`Promise`\<[`TranscriptInfo`](TranscriptInfo.md)\>
#### Defined in
[src/parser/youtube/TranscriptInfo.ts:26](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/parser/youtube/TranscriptInfo.ts#L26)