Skip to content

Commit

Permalink
docs: regenerate api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@hyrious
hyrious committed Nov 13, 2023
1 parent c480e1b commit 9ce5a9b
Show file tree
Hide file tree
Showing 21 changed files with 481 additions and 458 deletions.
99 changes: 50 additions & 49 deletions packages/fastboard-core/docs/classes/FastboardApp.md
View file

Large diffs are not rendered by default.

40 changes: 20 additions & 20 deletions packages/fastboard-core/docs/classes/FastboardPlayer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ FastboardPlayerBase<TEventData\>.constructor

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:22](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L22)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:22](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L22)

## Properties

Expand All @@ -86,7 +86,7 @@ FastboardPlayerBase.\_destroyed

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:29](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L29)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:29](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L29)

___

Expand All @@ -98,7 +98,7 @@ Will become true after buffering.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:114](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L114)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:114](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L114)

___

Expand All @@ -110,7 +110,7 @@ Player current time in milliseconds.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:94](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L94)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:94](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L94)

___

Expand All @@ -122,7 +122,7 @@ Playback duration in milliseconds.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:139](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L139)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:139](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L139)

___

Expand All @@ -136,7 +136,7 @@ FastboardPlayerBase.manager

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:25](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L25)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:25](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L25)

___

Expand All @@ -148,7 +148,7 @@ Player state, like "is it playing?".

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:106](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L106)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:106](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L106)

___

Expand All @@ -160,7 +160,7 @@ Playback speed, default `1`.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:124](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L124)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:124](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L124)

___

Expand All @@ -174,7 +174,7 @@ FastboardPlayerBase.player

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:24](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L24)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:24](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L24)

___

Expand All @@ -188,7 +188,7 @@ FastboardPlayerBase.sdk

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:23](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L23)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:23](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L23)

___

Expand All @@ -200,7 +200,7 @@ Get state of room at that time, like "who was in the room?".

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:146](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L146)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:146](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L146)

___

Expand All @@ -214,7 +214,7 @@ FastboardPlayerBase.syncedStore

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:26](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L26)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:26](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L26)

## Methods

Expand All @@ -236,7 +236,7 @@ Move window-manager's collector to some place.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:86](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L86)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:86](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L86)

___

Expand All @@ -258,7 +258,7 @@ Render this player to some DOM.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:78](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L78)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:78](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L78)

___

Expand All @@ -276,7 +276,7 @@ FastboardPlayerBase.destroy

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:61](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L61)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:61](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L61)

___

Expand All @@ -292,7 +292,7 @@ Change player state to paused.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:170](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L170)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:170](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L170)

___

Expand All @@ -308,7 +308,7 @@ Change player state to playing.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:162](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L162)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:162](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L162)

___

Expand All @@ -330,7 +330,7 @@ Seek to some time in milliseconds.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:154](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L154)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:154](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L154)

___

Expand All @@ -352,7 +352,7 @@ Set playback speed, a shortcut for `speed.set(x)`.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:186](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L186)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:186](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L186)

___

Expand All @@ -368,4 +368,4 @@ Change player state to stopped.

#### Defined in

[packages/fastboard-core/src/impl/FastboardPlayer.ts:178](https://github.com/netless-io/fastboard/blob/1326312/packages/fastboard-core/src/impl/FastboardPlayer.ts#L178)
[packages/fastboard-core/src/impl/FastboardPlayer.ts:178](https://github.com/netless-io/fastboard/blob/c480e1b/packages/fastboard-core/src/impl/FastboardPlayer.ts#L178)
38 changes: 19 additions & 19 deletions packages/fastboard-core/docs/classes/Storage.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:25
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:25

## Properties

Expand All @@ -71,7 +71,7 @@ node_modules/.pnpm/@[email protected][email protected]/node_module

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:44
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:44

___

Expand All @@ -81,7 +81,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:24
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:24

___

Expand All @@ -91,7 +91,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:21
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:21

___

Expand All @@ -101,7 +101,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:20
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:20

___

Expand All @@ -111,7 +111,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:22
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:22

___

Expand All @@ -121,7 +121,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:45
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:45

___

Expand All @@ -131,7 +131,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:23
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:23

___

Expand All @@ -141,7 +141,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:19
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:19

___

Expand All @@ -151,7 +151,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:18
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:18

___

Expand Down Expand Up @@ -184,7 +184,7 @@ Remove a listener from the eventName.

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:40
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:40

___

Expand Down Expand Up @@ -217,7 +217,7 @@ Add a listener to the eventName.

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:36
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:36

## Accessors

Expand All @@ -231,7 +231,7 @@ node_modules/.pnpm/@[email protected][email protected]/node_module

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:43
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:43

___

Expand All @@ -245,7 +245,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:26
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:26

___

Expand All @@ -259,7 +259,7 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:27
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:27

## Methods

Expand All @@ -275,7 +275,7 @@ delete synced storage data and disconnect from synced storage

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:32
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:32

___

Expand All @@ -291,7 +291,7 @@ Disconnect from synced storage and release listeners

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:42
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:42

___

Expand All @@ -307,7 +307,7 @@ reset storage state to default state

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:30
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:30

___

Expand All @@ -327,4 +327,4 @@ ___

#### Defined in

node_modules/.pnpm/@netless[email protected][email protected].42/node_modules/@netless/synced-store/dist/storage.d.ts:28
node_modules/.pnpm/@netless[email protected][email protected].44/node_modules/@netless/synced-store/dist/storage.d.ts:28
Loading

0 comments on commit 9ce5a9b

Please sign in to comment.