npm - @livekit/components-js-docs - Versions diffs - 0.0.5 → 0.1.1 - Mend

@livekit/components-js-docs 0.0.5 → 0.1.1

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 (427) hide show

package/generated-docs/core/issourcewitoptions.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isSourceWitOptions",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # isSourceWitOptions
@@ -6,6 +13,6 @@
 ```typescript
 export declare function isSourceWitOptions(
-  source: SourcesArray[number],
+  source: SourcesArray[number]
 ): source is TrackSourceWithOptions;
 ```

package/generated-docs/core/istrackreference.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isTrackReference",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.types.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # isTrackReference

package/generated-docs/core/istrackreferencepinned.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isTrackReferencePinned",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.utils.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # isTrackReferencePinned
@@ -9,7 +16,7 @@ Check if the `TrackReference` is pinned.
 ```typescript
 export declare function isTrackReferencePinned(
   trackReference: TrackReferenceOrPlaceholder,
-  pinState: PinState | undefined,
+  pinState: PinState | undefined
 ): boolean;
 ```

package/generated-docs/core/istrackreferenceplaceholder.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isTrackReferencePlaceholder",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.types.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # isTrackReferencePlaceholder
@@ -6,6 +13,6 @@
 ```typescript
 export declare function isTrackReferencePlaceholder(
-  trackReference?: TrackReferenceOrPlaceholder,
+  trackReference?: TrackReferenceOrPlaceholder
 ): trackReference is TrackReferencePlaceholder;
 ```

package/generated-docs/core/log.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "log variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/logger.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## log variable
+# log variable
 **Signature:**

package/generated-docs/core/mediatoggletype.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "MediaToggleType type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaToggle.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## MediaToggleType type
+# MediaToggleType type
 **Signature:**

package/generated-docs/{react → core}/messagedecoder.md RENAMED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "MessageDecoder type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## MessageDecoder type
+# MessageDecoder type
 **Signature:**

package/generated-docs/{react → core}/messageencoder.md RENAMED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "MessageEncoder type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## MessageEncoder type
+# MessageEncoder type
 **Signature:**

package/generated-docs/core/mutedobserver.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "mutedObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # mutedObserver
@@ -5,8 +12,5 @@
 **Signature:**
 ```typescript
-export declare function mutedObserver(
-  participant: Participant,
-  source: Track.Source,
-): Observable<boolean>;
+export declare function mutedObserver(trackRef: TrackReferenceOrPlaceholder): Observable<boolean>;
 ```

package/generated-docs/core/observeparticipantevents.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "observeParticipantEvents",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # observeParticipantEvents

package/generated-docs/core/observeparticipantmedia.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "observeParticipantMedia",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # observeParticipantMedia
@@ -6,6 +13,6 @@
 ```typescript
 export declare function observeParticipantMedia<T extends Participant>(
-  participant: T,
+  participant: T
 ): Observable<ParticipantMedia<T>>;
 ```

package/generated-docs/core/observeroomevents.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "observeRoomEvents",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # observeRoomEvents

package/generated-docs/core/observetrackevents.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "observeTrackEvents",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/track.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # observeTrackEvents

package/generated-docs/core/participantclickevent.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ParticipantClickEvent interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantClickEvent interface
+# ParticipantClickEvent interface
 **Signature:**

package/generated-docs/core/participantclickevent.participant.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantClickEvent.participant property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantClickEvent.participant property
+# ParticipantClickEvent.participant property
 **Signature:**

package/generated-docs/core/participantclickevent.track.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantClickEvent.track property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantClickEvent.track property
+# ParticipantClickEvent.track property
 **Signature:**

package/generated-docs/core/participanteventselector.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "participantEventSelector",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # participantEventSelector
@@ -7,6 +14,6 @@
 ```typescript
 export declare function participantEventSelector<T extends ParticipantEvent>(
   participant: Participant,
-  event: T,
+  event: T
 ): Observable<Parameters<ParticipantEventCallbacks[Extract<T, keyof ParticipantEventCallbacks>]>>;
 ```

package/generated-docs/core/participantfilter.md CHANGED Viewed

@@ -1,9 +1,16 @@
+---
+{
+  "title": "ParticipantFilter type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantFilter type
+# ParticipantFilter type
 **Signature:**
 ```typescript
-export type ParticipantFilter = Parameters<Participant[]['filter']>['0'];
+export type ParticipantFilter = Parameters<Participant[]["filter"]>["0"];
 ```

package/generated-docs/core/participantinfoobserver.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "participantInfoObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # participantInfoObserver

package/generated-docs/core/participantmedia.cameratrack.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantMedia.cameraTrack property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantMedia.cameraTrack property
+# ParticipantMedia.cameraTrack property
 **Signature:**

package/generated-docs/core/participantmedia.iscameraenabled.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantMedia.isCameraEnabled property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantMedia.isCameraEnabled property
+# ParticipantMedia.isCameraEnabled property
 **Signature:**

package/generated-docs/core/participantmedia.ismicrophoneenabled.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantMedia.isMicrophoneEnabled property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantMedia.isMicrophoneEnabled property
+# ParticipantMedia.isMicrophoneEnabled property
 **Signature:**

package/generated-docs/core/participantmedia.isscreenshareenabled.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantMedia.isScreenShareEnabled property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantMedia.isScreenShareEnabled property
+# ParticipantMedia.isScreenShareEnabled property
 **Signature:**

package/generated-docs/core/participantmedia.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ParticipantMedia interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantMedia interface
+# ParticipantMedia interface
 **Signature:**

package/generated-docs/core/participantmedia.microphonetrack.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantMedia.microphoneTrack property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantMedia.microphoneTrack property
+# ParticipantMedia.microphoneTrack property
 **Signature:**

package/generated-docs/core/participantmedia.participant.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantMedia.participant property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ParticipantMedia.participant property
+# ParticipantMedia.participant property
 **Signature:**

package/generated-docs/core/participantpermissionobserver.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "participantPermissionObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # participantPermissionObserver
@@ -6,8 +13,8 @@
 ```typescript
 export declare function participantPermissionObserver(
-  participant: Participant,
+  participant: Participant
 ): Observable<
-  import('livekit-client/dist/src/proto/livekit_models_pb').ParticipantPermission | undefined
+  import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined
 >;
 ```

package/generated-docs/core/pin_default_state.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "PIN_DEFAULT_STATE variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## PIN_DEFAULT_STATE variable
+# PIN_DEFAULT_STATE variable
 **Signature:**

package/generated-docs/core/pinstate.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "PinState type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## PinState type
+# PinState type
 **Signature:**

package/generated-docs/core/receivedchatmessage.from.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ReceivedChatMessage.from property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ReceivedChatMessage.from property
+# ReceivedChatMessage.from property
 **Signature:**

package/generated-docs/core/receivedchatmessage.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ReceivedChatMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ReceivedChatMessage interface
+# ReceivedChatMessage interface
 **Signature:**

package/generated-docs/core/receiveddatamessage.from.md CHANGED Viewed

@@ -1,6 +1,10 @@
+---
+{ "title": "ReceivedDataMessage.from property" }
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ReceivedDataMessage.from property
+# ReceivedDataMessage.from property
 **Signature:**

package/generated-docs/core/receiveddatamessage.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ReceivedDataMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ReceivedDataMessage interface
+# ReceivedDataMessage interface
 **Signature:**

package/generated-docs/core/requireonlyone.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "RequireOnlyOne type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## RequireOnlyOne type
+# RequireOnlyOne type
 **Signature:**

package/generated-docs/core/roomaudioplaybackallowedobservable.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "roomAudioPlaybackAllowedObservable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # roomAudioPlaybackAllowedObservable

package/generated-docs/core/roomeventselector.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "roomEventSelector",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # roomEventSelector
@@ -7,6 +14,6 @@
 ```typescript
 export declare function roomEventSelector<T extends RoomEvent>(
   room: Room,
-  event: T,
+  event: T
 ): Observable<Parameters<RoomEventCallbacks[T]>>;
 ```

package/generated-docs/core/roominfoobserver.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "roomInfoObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # roomInfoObserver

package/generated-docs/core/roomobserver.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "roomObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # roomObserver

package/generated-docs/core/screenshareobserver.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "screenShareObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # screenShareObserver

package/generated-docs/core/screensharetrackmap.md CHANGED Viewed

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ScreenShareTrackMap type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
-## ScreenShareTrackMap type
+# ScreenShareTrackMap type
 **Signature:**

package/generated-docs/core/selectgridlayout.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "selectGridLayout",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/grid-layouts.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # selectGridLayout
@@ -9,6 +16,6 @@ export declare function selectGridLayout(
   layouts: GridLayoutDefinition[],
   participantCount: number,
   width: number,
-  height: number,
+  height: number
 ): GridLayoutDefinition;
 ```

package/generated-docs/core/sendmessage.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "sendMessage",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # sendMessage
@@ -11,7 +18,7 @@ export declare function sendMessage(
   localParticipant: LocalParticipant,
   payload: Uint8Array,
   topic?: string,
-  options?: DataSendOptions,
+  options?: DataSendOptions
 ): Promise<void>;
 ```

package/generated-docs/core/setdifference.md CHANGED Viewed

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setDifference",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/set-helper.ts"
+}
+---
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 # setDifference