Class PartsBehavior

Provides access to child endpoints.

Hierarchy (view full)

Implements

Constructors

constructor

Properties

events state dependencies? early Events id Internal schema? State

Accessors

[reference] agent context endpoint env session defaults supervisor

Methods

[asyncDispose] [iterator] add asAdmin callback clear delete has indexOf 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

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

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

Static Readonlyid

id = "parts"

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 () => {})

Implementation of internal state. Subclasses may override to extend.

Type declaration

    • new (): {}

    • Implementation of internal state. Subclasses may override to extend.

      Returns {}

    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 () => {})

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

    Type declaration

      • new (): {}

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

        Returns {}

      Accessors

      [reference]

      • get [reference](): Datasource<StateType>

      • Returns Datasource<StateType>

      agent

      • get agent(): Agent

      • The agent that owns the behavior.

        Returns Agent

      context

      • get context(): ActionContext

      • The context in which the behavior operates.

        Returns ActionContext

      endpoint

      • get endpoint(): Endpoint<Empty>

      • The endpoint that owns behavior's agent.

        Returns Endpoint<Empty>

      env

      • get env(): Environment

      • The endpoint's environment.

        Returns Environment

      session

      • get session(): SecureSession

      • The session in which the behavior has been invoked.

        Returns SecureSession

      Staticdefaults

      • get defaults(): Record<string, any>

      • Default state values.

        Returns Record<string, any>

      Staticsupervisor

      • get supervisor(): RootSupervisor

      • The data supervisor for the behavior. The supervisor controls validation and access to behavior data.

        Returns RootSupervisor

      Methods

      [asyncDispose]

      • [asyncDispose](): MaybePromise

      • Release resources. This is the public API for releasing application resources held by behaviors in internal state.

        Returns MaybePromise

      [iterator]

      • [iterator](): Generator<Instance<Empty>, void, unknown>

      • Returns Generator<Instance<Empty>, void, unknown>

      add

      • add(child): void

      • Parameters

        Returns void

      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

      clear

      • clear(): void

      • Returns void

      delete

      • delete(child): boolean

      • Parameters

        Returns boolean

      has

      • has(child): boolean

      • Parameters

        Returns boolean

      indexOf

      • indexOf(child): number

      • Parameters

        Returns number

      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

        • reactTo<O>(observable, reactor, options?): void

        • Install a Reactor.

          Important: The reactor MUST be a real JS function - arrow functions will not work!

          Type Parameters

          Parameters

          Returns void

        toString

        • toString(): string

        • Description used in diagnostic messages.

          Returns string

        Staticset

        • set<This>(this, defaults): This

        • Create a new behavior with different default state values.

          Type Parameters

          Parameters

          Returns This

        Staticsupports

        • supports(other): boolean

        • Does this behavior support functionality of a specific implementation?

          Parameters

          Returns boolean

        Settings

        Member Visibility

        On This Page

        Constructors
        Properties
        Accessors
        Methods