Class DaemonOptions

DaemonOptions are options for connecting to a daemon process.

Hierarchy

Options
- DaemonOptions

Index

Constructors

Properties

daemonAddress namespace pollInterval transport

Methods

client defaults interceptor

Constructors

constructor

new DaemonOptions(opts?): DaemonOptions
Parameters
- Optional opts: Partial<DaemonOptions>
Returns DaemonOptions
Overrides Options.constructor
- Defined in src/useWebmesh.ts:27

Properties

daemonAddress

daemonAddress: string

namespace

namespace: string

pollInterval

pollInterval: number

transport

transport: Transport

Methods

client

client(): DaemonClient
client returns a client for the daemon.

Returns DaemonClient
the client for the daemon.
Inherited from Options.client
- Defined in node_modules/@webmeshproject/api/utils/daemon.ts:110

`Static` defaults

defaults(): DaemonOptions
defaults returns the default options.

Returns DaemonOptions
the default options.
Inherited from Options.defaults
- Defined in node_modules/@webmeshproject/api/utils/daemon.ts:69

`Static` interceptor

interceptor(namespace): Interceptor
interceptor returns an interceptor that sets the namespace header on RPC requests.
Parameters
- namespace: string
Returns Interceptor
the interceptor for the daemon.
Inherited from Options.interceptor
- Defined in node_modules/@webmeshproject/api/utils/daemon.ts:81

Generated using TypeDoc