Interface CapabilityManager

Interface for the Capability Manager. Provides methods for contributing, removing, and accessing capabilities.

interface CapabilityManager {
    atom<T>(interfaceDef: Capability.InterfaceDef<T>): Atom<T[]>;
    atomByModule<T>(
        interfaceDef: Capability.InterfaceDef<T>,
    ): Atom<Record<string, T[]>>;
    contribute<T>(
        args: {
            implementation: T;
            interface: Capability.InterfaceDef<T>;
            module: string;
        },
    ): void;
    get<T>(interfaceDef: Capability.InterfaceDef<T>): T;
    getAll<T>(interfaceDef: Capability.InterfaceDef<T>): T[];
    remove<T>(
        interfaceDef: Capability.InterfaceDef<T>,
        implementation: T,
    ): void;
    waitFor<T>(interfaceDef: Capability.InterfaceDef<T>): Effect<T, Error>;
}

Index

Methods

atom atomByModule contribute get getAll remove waitFor

Methods

atom

atom<T>(interfaceDef: Capability.InterfaceDef<T>): Atom<T[]>
Get the Atom reference to the available capabilities for a given interface. Primarily useful for deriving other Atom values based on the capabilities or for subscribing to changes in the capabilities.
Type Parameters
- T
Parameters
- interfaceDef: Capability.InterfaceDef<T>
Returns Atom<T[]>
An atom reference to the available capabilities.
- Defined in packages/sdk/app-framework/src/core/capability-manager.ts:42

atomByModule

atomByModule<T>(
interfaceDef: Capability.InterfaceDef<T>,
): Atom<Record<string, T[]>>
Get capabilities grouped by the module that contributed them.
Type Parameters
- T
Parameters
- interfaceDef: Capability.InterfaceDef<T>
Returns Atom<Record<string, T[]>>
An atom containing a record from module ID to capability implementations.
- Defined in packages/sdk/app-framework/src/core/capability-manager.ts:67

contribute

contribute<T>(
    args: {
        implementation: T;
        interface: Capability.InterfaceDef<T>;
        module: string;
    },
): void
Type Parameters
- T
Parameters
- args: { implementation: T; interface: Capability.InterfaceDef<T>; module: string }
Returns void
- Defined in packages/sdk/app-framework/src/core/capability-manager.ts:32

get

get<T>(interfaceDef: Capability.InterfaceDef<T>): T
Requests a single capability from the capability manager.
Type Parameters
- T
Parameters
- interfaceDef: Capability.InterfaceDef<T>
Returns T
The capability.

Throws
If no capability is found.
- Defined in packages/sdk/app-framework/src/core/capability-manager.ts:55

getAll

getAll<T>(interfaceDef: Capability.InterfaceDef<T>): T[]
Get capabilities from the capability manager.
Type Parameters
- T
Parameters
- interfaceDef: Capability.InterfaceDef<T>
Returns T[]
An array of capabilities.
- Defined in packages/sdk/app-framework/src/core/capability-manager.ts:48

remove

remove<T>(interfaceDef: Capability.InterfaceDef<T>, implementation: T): void
Type Parameters
- T
Parameters
- interfaceDef: Capability.InterfaceDef<T>
- implementation: T
Returns void
- Defined in packages/sdk/app-framework/src/core/capability-manager.ts:34

waitFor

waitFor<T>(interfaceDef: Capability.InterfaceDef<T>): Effect<T, Error>
Waits for a capability to be available.
Type Parameters
- T
Parameters
- interfaceDef: Capability.InterfaceDef<T>
Returns Effect<T, Error>
The capability.
- Defined in packages/sdk/app-framework/src/core/capability-manager.ts:61

Interface CapabilityManager

Index

Methods

Methods

atom

Type Parameters

Parameters

Returns Atom<T[]>

atomByModule

Type Parameters

Parameters

Returns Atom<Record<string, T[]>>

contribute

Type Parameters

Parameters

Returns void

get

Type Parameters

Parameters

Returns T

Throws

getAll

Type Parameters

Parameters

Returns T[]

remove

Type Parameters

Parameters

Returns void

waitFor

Type Parameters

Parameters

Returns Effect<T, Error>

Settings

On This Page