Class BehaviorAbstract

Behavior implements functionality for an Endpoint. Endpoint agents are implemented as a composition of behaviors.

Most behaviors associated 1:1 with a Matter cluster type as implemented by ClusterBehavior. But you can also extend Behavior directly to add other types of composable logic to an endpoint.

You probably want to build your behavior using one of the standard implementations offered by Matter.js.

Hierarchy (view full)

Constructors

constructor

Properties

events state dependencies? early Events id Internal schema? State

Accessors

[reference] agent context endpoint env session defaults supervisor

Methods

[asyncDispose] asAdmin callback initialize reactTo toString set supports

Constructors

constructor

Properties

Readonlyevents

events: EventEmitter

Access the behavior's events.

Readonlystate

state: {}

Access the behavior's state.

Static Optionaldependencies

dependencies?: Iterable<Type, any, any>

Explicitly reference other Behaviors as dependencies, ensuring this behavior is destroyed first.

This probably won't be commonly necessary. If it is we can instrument Agent to collect dependencies automatically.

Static Readonlyearly

early: boolean = false

By default behaviors load lazily as they are accessed. You can set this flag to true to force behaviors to load immediately when the endpoint initializes.

StaticEvents

Events: typeof EventEmitter = EventEmitter

Implementation of the events property. Subclasses may override to extend.

Static Readonlyid

id: string

Each behavior implementation has an ID that uniquely identifies the type of behavior. An Endpoint may only have one behavior with the specified ID.

Endpoint instances store each behavior in a property with the same name as the behavior's ID.

EndpointBuilder also uses the ID when replacing behaviors using the with() builder method.

StaticInternal

Internal: (new () => {}) = EmptyState

Implementation of internal state. Subclasses may override to extend.

Static Optional Readonlyschema

schema?: Schema

A behavior's schema controls access to data, commands and events.

Schema is inferred from the methods and properties of the behavior but you can specify explicitly for additional control.

StaticState

State: (new () => {}) = EmptyState

Implementation of endpoint-scoped state. Subclasses may override to extend.

Accessors

[reference]

agent

context

endpoint

env

session

Staticdefaults

Staticsupervisor

Methods

[asyncDispose]

asAdmin

  • asAdmin(fn): void

  • Execute logic with elevated privileges.

    The provided function executes with privileges escalated to offline mode. This is not commonly necessary.

    Elevated logic effectively ignores ACLs so should be used with care.

    Note that interactions with the behavior will remain elevated until the synchronous completion of this call. You should only elevate privileges for synchronous logic.

    Parameters

    • fn: (() => void)

      the elevated logic

        • (): void

        • Returns void

    Returns void

Protectedcallback

  • callback<A, R>(reactor, options?): ((...args: A) => undefined | R)

  • Create a generic callback function that has the same properties as a Reactor.

    Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!

    Type Parameters

    • A extends any[]
    • R

    Parameters

    Returns ((...args: A) => undefined | R)

      • (...args): undefined | R

      • Parameters

        • Rest...args: A

        Returns undefined | R

initialize

  • initialize(_options?): MaybePromise

  • Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

    This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

    Parameters

    • Optional_options: {}

      Returns MaybePromise

    ProtectedreactTo

    toString

    Staticset

    Staticsupports

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods