Class InstanceDiscovery

Locates a single node and returns it.

Throws an error if the node is not located.

Hierarchy (view full)

Discovery<ClientNode>
- InstanceDiscovery
  - CommissioningDiscovery

Index

Constructors

Accessors

Methods

cancel catch finally onComplete onDiscovered then toString is

Constructors

constructor

new InstanceDiscovery(owner, options?): InstanceDiscovery
Parameters
- owner: ServerNode<RootEndpoint>
- Optionaloptions: Options
Returns InstanceDiscovery
Overrides Discovery.constructor
- Defined in packages/node/src/behavior/system/controller/discovery/InstanceDiscovery.ts:20

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Inherited from Discovery.[toStringTag]
- Defined in packages/general/dist/esm/util/Promises.d.ts:80

Methods

cancel

cancel(): void
Terminate discovery.

This will not abort node initialization but it will terminate any active discoveries. The discovery result will be the same as if the discovery had timed out.

Returns void
Inherited from Discovery.cancel
- Defined in packages/node/src/behavior/system/controller/discovery/Discovery.ts:65

catch

catch<TResult>(onrejected?): CancelablePromise<ClientNode | TResult>
Attaches a callback for only the rejection of the Promise.
Type Parameters
- TResult = never
Parameters
- Optionalonrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)
  The callback to execute when the Promise is rejected.
Returns CancelablePromise<ClientNode | TResult>
A Promise for the completion of the callback.
Inherited from Discovery.catch
- Defined in packages/general/dist/esm/util/Promises.d.ts:78

finally

finally(onfinally?): CancelablePromise<ClientNode>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
- Optionalonfinally: null | (() => void)
  The callback to execute when the Promise is settled (fulfilled or rejected).
Returns CancelablePromise<ClientNode>
A Promise for the completion of the callback.
Inherited from Discovery.finally
- Defined in packages/general/dist/esm/util/Promises.d.ts:79

`Protected`onComplete

onComplete(): MaybePromise<ClientNode>
Returns MaybePromise<ClientNode>
Overrides Discovery.onComplete
- Defined in packages/node/src/behavior/system/controller/discovery/InstanceDiscovery.ts:29

`Protected`onDiscovered

onDiscovered(node): void
Parameters
- node: ClientNode
Returns void
Overrides Discovery.onDiscovered
- Defined in packages/node/src/behavior/system/controller/discovery/InstanceDiscovery.ts:24

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): CancelablePromise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = ClientNode
- TResult2 = never
Parameters
- Optionalonfulfilled: null | ((value: ClientNode) => TResult1 | PromiseLike<TResult1>)
  The callback to execute when the Promise is resolved.
- Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
  The callback to execute when the Promise is rejected.
Returns CancelablePromise<TResult1 | TResult2>
A Promise for the completion of which ever callback is executed.
Inherited from Discovery.then
- Defined in packages/general/dist/esm/util/Promises.d.ts:77

toString

toString(): string
Returns a string representation of an object.

Returns string
Inherited from Discovery.toString
- Defined in packages/node/src/behavior/system/controller/discovery/Discovery.ts:74

`Static`is

is<T>(value): value is CancelablePromise<T>
Type Parameters
- T
Parameters
- value: MaybePromise<T>
Returns value is CancelablePromise<T>
Inherited from Discovery.is
- Defined in packages/general/dist/esm/util/Promises.d.ts:81