Functions
Functions
mountDevtoolsHooks(options)
Returns: void
Arguments:
options: MountOptions
unmountDevtoolsHooks()
Returns: void
Arguments: none
useDevtools()
Returns: DevtoolsHost
Arguments: none
useStream(streamFactory, defaultValue, deps)
Subscribe to service API streams.
Returns: T
Arguments:
streamFactory: function
defaultValue: T
deps: DependencyList
create(schema, obj, [meta])
Creates a reactive object from a plain Javascript object. Optionally provides a TS-effect schema.
Returns: ReactiveObject<T>
Arguments:
schema: Schema<T, T, never>
obj: ExcludeId<T>
meta: object
createDocAccessor(obj, path)
Returns: DocAccessor<any>
Arguments:
obj: EchoReactiveObject<T>
path: KeyPath
createEchoObject(init)
Returns: EchoReactiveObject<T>
Arguments:
init: T
createSubscription(onUpdate)
Subscribe to database updates. Calls the callback when any object from the selection changes. Calls the callback when the selection changes. Always calls the callback on the first selection.update call.
Returns: SubscriptionHandle
Arguments:
onUpdate: function
fromCursor(accessor, cursor)
Returns: number
Arguments:
accessor: DocAccessor<any>
cursor: string
fullyQualifiedId(object)
Fully qualified id of a reactive object is a combination of the space id and the object id.
Returns: string
Arguments:
object: ReactiveObject<any>
getMeta(obj)
Returns: object
Arguments:
obj: T
getObjectCore(obj)
Returns: ObjectCore
Arguments:
obj: EchoReactiveObject<T>
getRangeFromCursor(accessor, cursor)
Returns: undefined | object
Arguments:
accessor: DocAccessor<any>
cursor: string
getSchema(obj)
Returns the schema for the given object if one is defined.
Returns: undefined | Schema<any, any, never>
Arguments:
obj: undefined | T
getSpace(object)
Returns: undefined | Space
Arguments:
object: ReactiveObject<any>
getTextInRange(accessor, start, end)
Returns: string
Arguments:
accessor: DocAccessor<any>
start: string
end: string
getType(obj)
Returns: undefined | Reference
Arguments:
obj: undefined | T
getTypename(obj)
Returns: undefined | string
Arguments:
obj: T
hasType(type)
Returns: function
Arguments:
type: function
internalDecodeReference(value)
Returns: Reference
Arguments:
value: any
isEchoObject(value)
Returns: value is EchoReactiveObject<any>
Arguments:
value: unknown
isSpace(object)
Returns: object is Space
Arguments:
object: unknown
loadObjectReferences(objOrArray, valueAccessor, [timeout])
EXPERIMENTAL - the API is subject to change.
Returns: Promise<[object Object] extends [object Object] ? [object Object] : [object Object]>
Arguments:
objOrArray: T | T[]
valueAccessor: function
timeout: object
toCursor(accessor, pos)
Returns: string
Arguments:
accessor: DocAccessor<any>
pos: number
toCursorRange(accessor, start, end)
Returns: string
Arguments:
accessor: DocAccessor<any>
start: number
end: number
useMembers(spaceKey)
Returns: SpaceMember[]
Arguments:
spaceKey: undefined | PublicKey
useQuery([spaceOrEcho], [filter], [options], [deps])
Create subscription.
Returns: T[]
Arguments:
filter: FilterSource<T>
options: QueryOptions
deps: any[]
useSpace([spaceKeyLike])
Get a specific Space using its key. The space is not guaranteed to be in the ready state. Returns the default space if no key is provided. Requires a ClientProvider somewhere in the parent tree.
Returns: undefined | Space
Arguments:
spaceKeyLike: PublicKeyLike
useSpaceInvitation([spaceKey], [invitationId])
Returns: InvitationStatus
Arguments:
spaceKey: PublicKey
invitationId: string
useSpaceInvitations([spaceKey])
Returns: CancellableInvitation[]
Arguments:
spaceKey: PublicKey
useSpaces(options)
Get all Spaces available to current user. Requires a ClientProvider somewhere in the parent tree. By default, only ready spaces are returned.
Returns: Space[]
Arguments:
options: UseSpacesParams
useSubscription(cb, selection)
Create reactive selection. Calls the callback when the selection changes and during the first render.
Returns: undefined | SubscriptionHandle
Arguments:
cb: function
selection: Selection
useContacts()
Returns all known Contacts across all Spaces. Contacts are known members of a common Space. Requires ClientContext to be set via ClientProvider.
Returns: Contact[]
Arguments: none
useDevices()
Returns: Device[]
Arguments: none
useHaloInvitation([invitationId])
Returns: InvitationStatus
Arguments:
invitationId: string
useHaloInvitations()
Returns: CancellableInvitation[]
Arguments: none
useIdentity()
Hook returning DXOS identity object. Requires ClientContext to be set via ClientProvider.
Returns: "null" | Identity
Arguments: none
useKeyStore(defaultKeys)
Settings store.
Returns: [Map<string, string>, function]
Arguments:
defaultKeys: string[]
AgentHostingProvider(props)
Returns: Element
Arguments:
props: object
ClientProvider(options)
Root component that provides the DXOS client instance to child components. To be used with the useClient hook.
Returns: Element
Arguments:
options: ClientProviderProps
Defaults([basePath])
JSON config.
Returns: Partial<Config>
Arguments:
basePath: string
Dynamics()
Provided dynamically by server.
Returns: Partial<Config>
Arguments: none
Envs([basePath])
ENV variable (key/value) map.
Returns: Partial<Config>
Arguments:
basePath: string
Local()
Development config.
Returns: Partial<Config>
Arguments: none
Remote(target, [authenticationToken])
Returns: Partial<Config>
Arguments:
target: undefined | string
authenticationToken: string
Storage()
Load config from storage.
Returns: Promise<Partial<Config>>
Arguments: none
createClientServices(config, [createWorker], [observabilityGroup], [signalTelemetryEnabled])
Create services from config.
Returns: Promise<ClientServicesProvider>
Arguments:
config: Config
createWorker: function
observabilityGroup: string
signalTelemetryEnabled: boolean
fromAgent([options])
Connects to locally running CLI daemon.
Returns: ClientServicesProvider
Arguments:
options: FromAgentOptions
fromHost([config], [params], [observabilityGroup], [signalTelemetryEnabled])
Creates stand-alone services without rpc.
Returns: Promise<ClientServicesProvider>
Arguments:
config: Config
params: ClientServicesHostParams
observabilityGroup: string
signalTelemetryEnabled: boolean
fromSocket(url, [authenticationToken])
Access to remote client via a socket.
Returns: Promise<ClientServicesProvider>
Arguments:
url: string
authenticationToken: string
fromWorker(config, options)
Creates services provider connected via worker.
Returns: Promise<WorkerClientServices>
Arguments:
config: undefined | Config
options: Omit<WorkerClientServicesParams, "config">
getUnixSocket(profile, [protocol])
Returns: string
Arguments:
profile: string
protocol: string
useAgentHostingClient()
Returns: "null" | AgentHostingProviderClient
Arguments: none
useClient()
Hook returning instance of DXOS client. Requires ClientContext to be set via ClientProvider.
Returns: Client
Arguments: none
useClientServices()
Returns: undefined | ClientServices
Arguments: none
useConfig()
Hook returning config object used to initialize the DXOS client instance. Requires ClientContext to be set via ClientProvider.
Returns: Config
Arguments: none
useMulticastObservable(observable)
Subscribe to a MulticastObservable and return the latest value.
Returns: T
Arguments:
observable: MulticastObservable<T>
useShell()
Helper hook to access the shell.
Returns: Shell
Arguments: none
useShellDisplay()
Hook to access the shell’s display state.
Returns: ShellDisplay
Arguments: none
useStatus()
Returns: undefined | "null" | SystemStatus
Arguments: none
useInvitationStatus([observable])
Returns: InvitationStatus
Arguments:
observable: CancellableInvitation
useNetworkStatus()
Creates a network status subscription.
Returns: NetworkStatus
Arguments: none
getWorkerServiceHost()
Returns: Promise<ClientServicesHost>
Arguments: none
onconnect(event)
Returns: Promise<void>
Arguments:
event: MessageEvent<any>