Class PluginCatalog

Index

Constructors

constructor

new PluginCatalog(
    transport: Transport,
    plugins?: readonly PluginApiDescriptor[],
    revision?: bigint,
): PluginCatalog
Parameters
- transport: Transport
- plugins: readonly PluginApiDescriptor[] = []
- revision: bigint = 0n
Returns PluginCatalog
- Defined in sdk/typescript/src/plugins.ts:328

Accessors

revision

get revision(): bigint
Returns bigint
- Defined in sdk/typescript/src/plugins.ts:339

Methods

all

all(): readonly PluginApiDescriptor[]
Returns readonly PluginApiDescriptor[]
- Defined in sdk/typescript/src/plugins.ts:343

descriptorSet

descriptorSet(
pluginId: string,
options?: CallOptions,
): Effect<Uint8Array<ArrayBufferLike>, SoulFireOperationError>
Parameters
- pluginId: string
- Optionaloptions: CallOptions
Returns Effect<Uint8Array<ArrayBufferLike>, SoulFireOperationError>
- Defined in sdk/typescript/src/plugins.ts:410

events

events(
options?: WatchPluginEventOptions,
): Stream<PluginEvent, SoulFireOperationError>
Watches the normalized event stream published by installed plugins.

The initial READY envelope reports whether the requested sequence could be resumed. Plugin events are live and are not retained by the server.
Parameters
- options: WatchPluginEventOptions = {}
Returns Stream<PluginEvent, SoulFireOperationError>
- Defined in sdk/typescript/src/plugins.ts:509

get

get(pluginId: string): PluginApiDescriptor | undefined
Parameters
- pluginId: string
Returns PluginApiDescriptor | undefined
- Defined in sdk/typescript/src/plugins.ts:347

reflective

reflective(
pluginId: string,
options?: CallOptions,
): Effect<ReflectivePlugin, SoulFireOperationError>
Parameters
- pluginId: string
- Optionaloptions: CallOptions
Returns Effect<ReflectivePlugin, SoulFireOperationError>
- Defined in sdk/typescript/src/plugins.ts:446

refresh

refresh(
options?: CallOptions,
): Effect<readonly PluginApiDescriptor[], SoulFireOperationError>
Parameters
- Optionaloptions: CallOptions
Returns Effect<readonly PluginApiDescriptor[], SoulFireOperationError>
- Defined in sdk/typescript/src/plugins.ts:398

require

require<T extends SoulFireExtension>(
module: SoulFirePluginModule<T>,
): Effect<T, SoulFirePluginError>
Type Parameters
- T extends SoulFireExtension
Parameters
- module: SoulFirePluginModule<T>
Returns Effect<T, SoulFirePluginError>
- Defined in sdk/typescript/src/plugins.ts:359

requireDescriptor

requireDescriptor(pluginId: string): PluginApiDescriptor
Parameters
- pluginId: string
Returns PluginApiDescriptor
- Defined in sdk/typescript/src/plugins.ts:351

service

service<T extends DescService>(pluginId: string, service: T): Client<T>
Type Parameters
- T extends DescService
Parameters
- pluginId: string
- service: T
Returns Client<T>
- Defined in sdk/typescript/src/plugins.ts:380

typedEvents

typedEvents<T extends DescMessage>(
    pluginId: string,
    schema: T,
    options?: Omit<WatchPluginEventOptions, "pluginIds" | "typeUrls">,
): Stream<TypedPluginEvent<T>, SoulFireOperationError>
Watches one advertised event type and decodes each DATA payload.
Type Parameters
- T extends DescMessage
Parameters
- pluginId: string
- schema: T
- options: Omit<WatchPluginEventOptions, "pluginIds" | "typeUrls"> = {}
Returns Stream<TypedPluginEvent<T>, SoulFireOperationError>
- Defined in sdk/typescript/src/plugins.ts:532

watch

watch(options?: CallOptions): Stream<PluginApiEvent, SoulFireOperationError>
Parameters
- Optionaloptions: CallOptions
Returns Stream<PluginApiEvent, SoulFireOperationError>
- Defined in sdk/typescript/src/plugins.ts:478

Class PluginCatalog

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PluginCatalog

Accessors

revision

Returns bigint

Methods

all

Returns readonly PluginApiDescriptor[]

descriptorSet

Parameters

Returns Effect<Uint8Array<ArrayBufferLike>, SoulFireOperationError>

events

Parameters

Returns Stream<PluginEvent, SoulFireOperationError>

get

Parameters

Returns PluginApiDescriptor | undefined

reflective

Parameters

Returns Effect<ReflectivePlugin, SoulFireOperationError>

refresh

Parameters

Returns Effect<readonly PluginApiDescriptor[], SoulFireOperationError>

require

Type Parameters

Parameters

Returns Effect<T, SoulFirePluginError>

requireDescriptor

Parameters

Returns PluginApiDescriptor

service

Type Parameters

Parameters

Returns Client<T>

typedEvents

Type Parameters

Parameters

Returns Stream<TypedPluginEvent<T>, SoulFireOperationError>

watch

Parameters

Returns Stream<PluginApiEvent, SoulFireOperationError>

Settings

On This Page