Optional
Readonly
connectionIf there's a connection error it will be available here.
Readonly
connectionProvides the connection status of the Ably connection.
Readonly
currentlyA state value representing the set of client IDs that are currently typing in the room. It automatically updates based on typing events received from the room.
Optional
Readonly
errorA state value representing the current error state of the hook, this will be an instance of Ably.ErrorInfo or undefined
.
An error can occur during mount when initially fetching the current typing state; this does not mean that further
updates will not be received, and so the hook might recover from this state on its own.
Optional
Readonly
roomIf there's an error with the room it will be available here.
Readonly
roomProvides the status of the room.
Readonly
startA shortcut to the Typing.start method.
Start indicates that the current user is typing. This will emit a typingStarted event to inform listening clients and begin a timer, once the timer expires, a typingStopped event will be emitted. The timeout is configurable through the typingTimeoutMs parameter. If the current user is already typing, it will reset the timer and being counting down again without emitting a new event.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
Readonly
stopA shortcut to the Typing.stop method.
Stop indicates that the current user has stopped typing. This will emit a typingStopped event to inform listening clients, and immediately clear the typing timeout timer.
A promise which resolves upon success of the operation and rejects with an ErrorInfo object upon its failure.
Optional
Readonly
typingProvides access to the underlying Typing instance of the room.
Common status variables for chat features. Most hooks in this library implement this interface.