Functions
Functions
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)
Returns: Partial<Config>
Arguments:
target: undefined | string
createClientServices(config)
Create services from config.
Returns: Promise<ClientServicesProvider>
Arguments:
config: Config
fromAgent([options])
Connects to locally running CLI daemon.
Returns: ClientServicesProvider
Arguments:
options: FromAgentOptions
fromHost([config], [params])
Creates stand-alone services without rpc.
Returns: Promise<ClientServicesProvider>
Arguments:
config: Config
params: ClientServicesHostParams
fromIFrame([config], [options])
Create services provider proxy connected via iFrame to host.
Returns: Promise<ClientServicesProvider>
Arguments:
config: Config
options: Omit<Partial<IFrameClientServicesProxyOptions>, "source">
fromSocket(url)
Access to remote client via a socket.
Returns: Promise<ClientServicesProvider>
Arguments:
url: string
getUnixSocket(profile, [protocol])
Returns: string
Arguments:
profile: string
protocol: string
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
useStatus()
Returns: undefined | "null" | SystemStatus
Arguments: none