Skip to main content

Type Alias: UsePeersResult<PeerMetadata, ServerMetadata>

UsePeersResult<PeerMetadata, ServerMetadata>: object

Defined in: packages/react-native-client/src/hooks/usePeers.ts:143

Result type for the usePeers hook.

Type Parameters

Type ParameterDefault typeDescription
PeerMetadata extends GenericMetadataGenericMetadataType for peer-specific metadata
ServerMetadata extends GenericMetadataGenericMetadataType for server-specific metadata

Type declaration

localPeer

localPeer: PeerWithTracks<PeerMetadata, ServerMetadata> | null

peers

peers: Peer<PeerMetadata, ServerMetadata>[]

remotePeers

remotePeers: PeerWithTracks<PeerMetadata, ServerMetadata>[]