Class Registry

constructor

• new Registry(parent?: Registry): Registry

• Parameters

  • Optionalparent: Registry

  Returns Registry

apiStability

ReadonlyasyncStore

Readonlydotprompt

Optionalparent

initializeAllPlugins

• initializeAllPlugins(): Promise<void>

• Initializes all plugins in the registry.

  Returns Promise<void>

initializePlugin

• initializePlugin(name: string): Promise<void | InitializedPlugin>

• Initializes a plugin already registered with registerPluginProvider.

  Parameters

  • name: string

    The name of the plugin to initialize.

  Returns Promise<void | InitializedPlugin>

  The plugin.

listActions

• listActions(): Promise<ActionsRecord>

• Returns all actions in the registry.

  Returns Promise<ActionsRecord>

  All actions in the registry.

listValues

• listValues<T>(type: string): Promise<Record<string, T>>

• Type Parameters

  • T

  Parameters

  • type: string

  Returns Promise<Record<string, T>>

lookupAction

• lookupAction<
      I extends ZodType<any, any, any, I>,
      O extends ZodType<any, any, any, O>,
      R extends Action<I, O, ZodTypeAny, ActionRunOptions<ZodTypeAny>>,
  >(
      key: string,
  ): Promise<R>

• Looks up an action in the registry.

  Type Parameters

  • I extends ZodType<any, any, any, I>
  • O extends ZodType<any, any, any, O>
  • R extends Action<I, O, ZodTypeAny, ActionRunOptions<ZodTypeAny>>

  Parameters

  • key: string

    The key of the action to lookup.

  Returns Promise<R>

  The action.

lookupPlugin

• lookupPlugin(name: string): undefined | PluginProvider

• Looks up a plugin.

  Parameters

  • name: string

    The name of the plugin to lookup.

  Returns undefined | PluginProvider

  The plugin provider.

lookupSchema

• lookupSchema(name: string): undefined | Schema

• Looks up a schema.

  Parameters

  • name: string

    The name of the schema to lookup.

  Returns undefined | Schema

  The schema.

lookupValue

• lookupValue<T = unknown>(type: string, key: string): Promise<undefined | T>

• Type Parameters

  • T = unknown

  Parameters

  • type: string
  • key: string

  Returns Promise<undefined | T>

registerAction

• registerAction<
      I extends ZodType<any, any, any, I>,
      O extends ZodType<any, any, any, O>,
  >(
      type: ActionType,
      action: Action<I, O, ZodTypeAny, ActionRunOptions<ZodTypeAny>>,
  ): void

• Registers an action in the registry.

  Type Parameters

  • I extends ZodType<any, any, any, I>
  • O extends ZodType<any, any, any, O>

  Parameters

  • type: ActionType

    The type of the action to register.
  • action: Action<I, O, ZodTypeAny, ActionRunOptions<ZodTypeAny>>

    The action to register.

  Returns void

registerActionAsync

• registerActionAsync<
      I extends ZodType<any, any, any, I>,
      O extends ZodType<any, any, any, O>,
  >(
      type: ActionType,
      name: string,
      action: PromiseLike<Action<I, O, ZodTypeAny, ActionRunOptions<ZodTypeAny>>>,
  ): void

• Registers an action promise in the registry.

  Type Parameters

  • I extends ZodType<any, any, any, I>
  • O extends ZodType<any, any, any, O>

  Parameters

  • type: ActionType
  • name: string
  • action: PromiseLike<Action<I, O, ZodTypeAny, ActionRunOptions<ZodTypeAny>>>

  Returns void

registerPluginProvider

• registerPluginProvider(name: string, provider: PluginProvider): void

• Registers a plugin provider. This plugin must be initialized before it can be used by calling initializePlugin or initializeAllPlugins.

  Parameters

  • name: string

    The name of the plugin to register.
  • provider: PluginProvider

    The plugin provider.

  Returns void

registerSchema

• registerSchema(name: string, data: Schema): void

• Registers a schema.

  Parameters

  • name: string

    The name of the schema to register.
  • data: Schema

    The schema to register (either a Zod schema or a JSON schema).

  Returns void

registerValue

• registerValue(type: string, name: string, value: any): void

• Parameters

  • type: string
  • name: string
  • value: any

  Returns void

StaticwithParent

• withParent(parent: Registry): Registry

• Creates a new registry overlaid onto the provided registry.

  Parameters

  • parent: Registry

    The parent registry.

  Returns Registry

  The new overlaid registry.