PluginCatalog
Public TypeScript members of PluginCatalog.
Generated from the pinned SDK source. Use the matching installation. Each source link points to this baseline.
Compose Effect operations with yield* inside a scoped workflow. Properties expose sub-clients and state.
revision
get revision(): bigintall
all(): readonly PluginApiDescriptor[]get
get(pluginId: string): PluginApiDescriptor | undefinedrequireDescriptor
requireDescriptor(pluginId: string): PluginApiDescriptorrequire
require<T extends SoulFireExtension>(
module: SoulFirePluginModule<T>,
): Effect.Effect<T, SoulFirePluginError>service
service<T extends DescService>(
pluginId: string,
service: T,
): Client<T>refresh
refresh(
options?: CallOptions,
): Effect.Effect<readonly PluginApiDescriptor[], SoulFireOperationError>descriptorSet
descriptorSet(
pluginId: string,
options?: CallOptions,
): Effect.Effect<Uint8Array, SoulFireOperationError>reflective
reflective(
pluginId: string,
options?: CallOptions,
): Effect.Effect<ReflectivePlugin, SoulFireOperationError>watch
watch(
options?: CallOptions,
): Stream.Stream<PluginApiEvent, SoulFireOperationError>events
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.
events(
options: WatchPluginEventOptions = {},
): Stream.Stream<PluginEvent, SoulFireOperationError>typedEvents
Watches one advertised event type and decodes each DATA payload.
typedEvents<T extends DescMessage>(
pluginId: string,
schema: T,
options: Omit<WatchPluginEventOptions, "pluginIds" | "typeUrls"> = {},
): Stream.Stream<TypedPluginEvent<T>, SoulFireOperationError>How is this page?
Last updated on