@livekit/components-js-docs 0.1.41 → 0.1.43

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/generated-docs/core/islocal.md +1 -1
  2. package/generated-docs/core/isremote.md +1 -1
  3. package/generated-docs/core/legacychatmessage.ignore.md +1 -1
  4. package/generated-docs/core/legacychatmessage.md +3 -3
  5. package/generated-docs/core/legacyreceivedchatmessage.ignore.md +1 -1
  6. package/generated-docs/core/legacyreceivedchatmessage.md +3 -3
  7. package/generated-docs/react/hook/usechat.md +2 -2
  8. package/generated-docs/react/hook/usemediadeviceselect.md +1 -1
  9. package/generated-docs/react/hook/useparticipants.md +1 -1
  10. package/generated-docs/react/hook/usespeakingparticipants.md +1 -1
  11. package/generated-docs/react/hook/usetracktoggle.md +2 -2
  12. package/package.json +2 -2
package/generated-docs/core/islocal.md CHANGED
@@ -12,5 +12,5 @@
12
12
  **Signature:**
13
13
 
14
14
  ```typescript
15
- export declare function isLocal(p: Participant): boolean;
15
+ export declare function isLocal(p: Participant): p is LocalParticipant;
16
16
  ```
package/generated-docs/core/isremote.md CHANGED
@@ -12,5 +12,5 @@
12
12
  **Signature:**
13
13
 
14
14
  ```typescript
15
- export declare function isRemote(p: Participant): boolean;
15
+ export declare function isRemote(p: Participant): p is RemoteParticipant;
16
16
  ```
package/generated-docs/core/legacychatmessage.ignore.md CHANGED
@@ -9,5 +9,5 @@
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- ignore?: true;
12
+ ignore?: boolean;
13
13
  ```
package/generated-docs/core/legacychatmessage.md CHANGED
@@ -19,6 +19,6 @@ export interface LegacyChatMessage extends ChatMessage
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | --------------------------------------------- | ---- | ------------ |
24
- | [ignore?](./core/legacychatmessage.ignore.md) | true | _(Optional)_ |
22
+ | Property | Type | Description |
23
+ | --------------------------------------------- | ------- | ------------ |
24
+ | [ignore?](./core/legacychatmessage.ignore.md) | boolean | _(Optional)_ |
package/generated-docs/core/legacyreceivedchatmessage.ignore.md CHANGED
@@ -9,5 +9,5 @@
9
9
  **Signature:**
10
10
 
11
11
  ```typescript
12
- ignore?: true;
12
+ ignore?: boolean;
13
13
  ```
package/generated-docs/core/legacyreceivedchatmessage.md CHANGED
@@ -19,6 +19,6 @@ export interface LegacyReceivedChatMessage extends ReceivedChatMessage
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | ----------------------------------------------------- | ---- | ------------ |
24
- | [ignore?](./core/legacyreceivedchatmessage.ignore.md) | true | _(Optional)_ |
22
+ | Property | Type | Description |
23
+ | ----------------------------------------------------- | ------- | ------------ |
24
+ | [ignore?](./core/legacyreceivedchatmessage.ignore.md) | boolean | _(Optional)_ |
package/generated-docs/react/hook/usechat.md CHANGED
@@ -28,8 +28,8 @@ import { useChat } from "@livekit/components-react";
28
28
 
29
29
  ```typescript
30
30
  {
31
- send: (message: string) => Promise<import("livekit-client").ChatMessage>;
32
- update: (message: string, originalMessageOrId: string | import("livekit-client").ChatMessage) => Promise<{
31
+ send: (message: string) => Promise<import('livekit-client').ChatMessage>;
32
+ update: (message: string, originalMessageOrId: string | import('livekit-client').ChatMessage) => Promise<{
33
33
  readonly message: string;
34
34
  readonly editTimestamp: number;
35
35
  readonly id: string;
package/generated-docs/react/hook/usemediadeviceselect.md CHANGED
@@ -55,6 +55,6 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
55
55
  devices: MediaDeviceInfo[];
56
56
  className: string;
57
57
  activeDeviceId: string;
58
- setActiveMediaDevice: (id: string, options?: import("@livekit/components-core").SetMediaDeviceOptions | undefined) => Promise<void>;
58
+ setActiveMediaDevice: (id: string, options?: import('@livekit/components-core').SetMediaDeviceOptions) => Promise<void>;
59
59
  }
60
60
  ```
package/generated-docs/react/hook/useparticipants.md CHANGED
@@ -40,5 +40,5 @@ const participants = useParticipants();
40
40
  ## Returns
41
41
 
42
42
  ```typescript
43
- (import("livekit-client").RemoteParticipant | import("livekit-client").LocalParticipant)[]
43
+ (import('livekit-client').RemoteParticipant | import('livekit-client').LocalParticipant)[]
44
44
  ```
package/generated-docs/react/hook/usespeakingparticipants.md CHANGED
@@ -28,5 +28,5 @@ const activeSpeakers = useSpeakingParticipants();
28
28
  ## Returns
29
29
 
30
30
  ```typescript
31
- import("livekit-client").Participant[]
31
+ import('livekit-client').Participant[]
32
32
  ```
package/generated-docs/react/hook/usetracktoggle.md CHANGED
@@ -30,9 +30,9 @@ return <button {...buttonProps}>{enabled ? "disable" : "enable"}</button>;
30
30
 
31
31
  ```typescript
32
32
  {
33
- toggle: ((forceState?: boolean | undefined) => Promise<void>) |
33
+ toggle: ((forceState?: boolean) => Promise<void>) |
34
34
  ((
35
- forceState?: boolean | undefined,
35
+ forceState?: boolean,
36
36
  captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined
37
37
  ) => Promise<boolean | undefined>);
38
38
  enabled: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@livekit/components-js-docs",
3
- "version": "0.1.41",
3
+ "version": "0.1.43",
4
4
  "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -8,7 +8,7 @@
8
8
  "directory": "/docs/beta-docs"
9
9
  },
10
10
  "dependencies": {
11
- "@livekit/components-react": "2.6.3"
11
+ "@livekit/components-react": "2.6.5"
12
12
  },
13
13
  "author": "",
14
14
  "license": "Apache-2.0",