Class Discovery<T>`Abstract`

Discovery of commissionable devices.

This is a cancelable promise; use cancel() to terminate discovery.

Type Parameters

T = unknown

Hierarchy (view full)

CancelablePromise<T>
- Discovery
  - ContinuousDiscovery
  - InstanceDiscovery

Index

Constructors

constructor

new Discovery<T>(owner, options): Discovery<T>
Type Parameters
- T = unknown
Parameters
- owner: ServerNode<RootEndpoint>
- options: undefined | Options
Returns Discovery<T>
Overrides CancelablePromise.constructor
- Defined in packages/node/src/behavior/system/controller/discovery/Discovery.ts:39

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Inherited from CancelablePromise.[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
Overrides CancelablePromise.cancel
- Defined in packages/node/src/behavior/system/controller/discovery/Discovery.ts:65

catch

catch<TResult>(onrejected?): CancelablePromise<T | 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<T | TResult>
A Promise for the completion of the callback.
Inherited from CancelablePromise.catch
- Defined in packages/general/dist/esm/util/Promises.d.ts:78

finally

finally(onfinally?): CancelablePromise<T>
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<T>
A Promise for the completion of the callback.
Inherited from CancelablePromise.finally
- Defined in packages/general/dist/esm/util/Promises.d.ts:79

`Protected` `Abstract`onComplete

onComplete(): MaybePromise<T>
Returns MaybePromise<T>
- Defined in packages/node/src/behavior/system/controller/discovery/Discovery.ts:57

`Protected` `Abstract`onDiscovered

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

then

then<TResult1, TResult2>(onfulfilled?, onrejected?): CancelablePromise<TResult1 | TResult2>
Attaches callbacks for the resolution and/or rejection of the Promise.
Type Parameters
- TResult1 = T
- TResult2 = never
Parameters
- Optionalonfulfilled: null | ((value: T) => 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 CancelablePromise.then
- Defined in packages/general/dist/esm/util/Promises.d.ts:77

toString

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

Returns string
- 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 CancelablePromise.is
- Defined in packages/general/dist/esm/util/Promises.d.ts:81

Class Discovery<T>Abstract

Type Parameters

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Discovery<T>

Accessors

[toStringTag]

Returns string

Methods

cancel

Returns void

catch

Type Parameters

Parameters

Returns CancelablePromise<T | TResult>

finally

Parameters

Returns CancelablePromise<T>

Protected AbstractonComplete

Returns MaybePromise<T>

Protected AbstractonDiscovered

Parameters

Returns void

then

Type Parameters

Parameters

Returns CancelablePromise<TResult1 | TResult2>

toString

Returns string

Staticis

Type Parameters

Parameters

Returns value is CancelablePromise<T>

Settings

On This Page

Class Discovery<T>`Abstract`

`Protected` `Abstract`onComplete

`Protected` `Abstract`onDiscovered

`Static`is