joinRoom
joinRoom(
__namedParameters):object
Defined in: client/src/index.ts:103
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”object
bind: <
T>(key,initial,isValue,onChange) =>Binding<T>
Type Parameters
Section titled “Type Parameters”T
Parameters
Section titled “Parameters”string
initial
Section titled “initial”T
isValue
Section titled “isValue”(value) => value is T
onChange
Section titled “onChange”(value) => void
Returns
Section titled “Returns”Binding<T>
doc:
Doc
events
Section titled “events”events:
object
events.subscribe()
Section titled “events.subscribe()”subscribe(
listener): () =>void
Parameters
Section titled “Parameters”listener
Section titled “listener”(event) => void
Returns
Section titled “Returns”() => void
input:
object
input.send
Section titled “input.send”send: (
input) =>void
Parameters
Section titled “Parameters”{ button?: "left" | "right" | "middle" | "none"; clickCount?: number; kind: "move" | "down" | "up"; modifiers?: number; type: "mouse"; x: number; y: number; } | { deltaX: number; deltaY: number; modifiers?: number; type: "wheel"; x: number; y: number; } | { code: string; key: string; kind: "down" | "up"; modifiers?: number; text?: string; type: "key"; } | { text: string; type: "text"; } | { type: "navigate"; url: string; } | { type: "back"; } | { type: "forward"; } | { type: "reload"; } | { type: "claim"; } | { type: "release"; } | { type: "status"; } | { button?: "left" | "right" | "middle"; kind: "move" | "down" | "up"; type: "mouse"; x: number; y: number; } | { amount: number; direction: "down" | "up"; type: "wheel"; } | { keys: string[]; type: "key"; } | { text: string; type: "text"; } | { type: "claim"; } | { type: "release"; } | { score?: number; signal: "attention" | "gesture" | "speaking"; type: "signal"; value: string; }
Returns
Section titled “Returns”void
objects
Section titled “objects”objects:
object
objects.array
Section titled “objects.array”array: (
name) =>YArray<unknown>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”YArray<unknown>
objects.fragment
Section titled “objects.fragment”fragment: (
name) =>YXmlFragment
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”YXmlFragment
objects.map
Section titled “objects.map”map: (
name) =>YMap<unknown>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”YMap<unknown>
objects.names
Section titled “objects.names”names: () =>
string[]
Returns
Section titled “Returns”string[]
objects.text
Section titled “objects.text”text: (
name) =>YText
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”YText
presence
Section titled “presence”presence:
object
presence.list
Section titled “presence.list”list: () =>
Peer[]
Returns
Section titled “Returns”Peer[]
presence.set()
Section titled “presence.set()”set(
fields):void
Parameters
Section titled “Parameters”fields
Section titled “fields”Record<string, unknown>
Returns
Section titled “Returns”void
provider
Section titled “provider”provider:
HocuspocusProvider
leave()
Section titled “leave()”leave():
void
Returns
Section titled “Returns”void