mirror of
https://github.com/LuanRT/YouTube.js.git
synced 2026-06-19 20:41:17 +00:00
chore: add proper documentation (#763)
* chore: generate API ref using `typedoc` * chore: declutter readme and add links to ytjs.dev * chore: clean up
This commit is contained in:
45
docs/api/classes/Platform.md
Normal file
45
docs/api/classes/Platform.md
Normal file
@@ -0,0 +1,45 @@
|
||||
[youtubei.js](../README.md) / Platform
|
||||
|
||||
# Class: Platform
|
||||
|
||||
## Constructors
|
||||
|
||||
### new Platform()
|
||||
|
||||
> **new Platform**(): [`Platform`](Platform.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`Platform`](Platform.md)
|
||||
|
||||
## Accessors
|
||||
|
||||
### shim
|
||||
|
||||
> `get` `static` **shim**(): [`PlatformShim`](../namespaces/Types/interfaces/PlatformShim.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
[`PlatformShim`](../namespaces/Types/interfaces/PlatformShim.md)
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/utils/Utils.ts:18](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Utils.ts#L18)
|
||||
|
||||
## Methods
|
||||
|
||||
### load()
|
||||
|
||||
> `static` **load**(`platform`): `void`
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **platform**: [`PlatformShim`](../namespaces/Types/interfaces/PlatformShim.md)
|
||||
|
||||
#### Returns
|
||||
|
||||
`void`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[src/utils/Utils.ts:15](https://github.com/LuanRT/YouTube.js/blob/eb21af33db708f0355f4fb15881f5d4fabc7b06c/src/utils/Utils.ts#L15)
|
||||
Reference in New Issue
Block a user