Class PayloadPluginResolver

constructor

• new PayloadPluginResolver(
      plugins?: PayloadPlugin<DeepRestrictToStringKeys<{ schema: string }>>[],
      defaultPlugin?: PayloadPlugin<DeepRestrictToStringKeys<{ schema: string }>>,
  ): PayloadPluginResolver

• Parameters

  • Optionalplugins: PayloadPlugin<DeepRestrictToStringKeys<{ schema: string }>>[]

    Param: plugins

    The initial set of plugins

  • defaultPlugin: PayloadPlugin<DeepRestrictToStringKeys<{ schema: string }>> = ...

    Param: defaultPlugin

    Specifies the plugin to be used if no plugins resolve

  Returns PayloadPluginResolver

schema

plugins

• plugins(): PayloadPlugin[]

• Returns PayloadPlugin[]

  Description

  Create list of plugins, optionally filtered by ability to witness/divine

register

• register<TPlugin extends PayloadPlugin = PayloadPlugin>(
      plugin: TPlugin,
  ): PayloadPluginResolver

• Type Parameters

  • TPlugin extends PayloadPlugin = PayloadPlugin

  Parameters

  • plugin: TPlugin

  Returns PayloadPluginResolver

resolve

• resolve(schema?: string): PayloadPlugin

• Parameters

  • Optionalschema: string

  Returns PayloadPlugin

• resolve(payload: DeepRestrictToStringKeys<{ schema: string }>): PayloadPlugin

• Parameters

  • payload: DeepRestrictToStringKeys<{ schema: string }>

  Returns PayloadPlugin

schemas

• schemas(): string[]

• Returns string[]

  Description

  Create list of schema, optionally filtered by ability to witness/divine

validate

• validate(
      payload: DeepRestrictToStringKeys<{ schema: string }>,
  ): undefined | Validator<DeepRestrictToStringKeys<{ schema: string }>>

• Parameters

  • payload: DeepRestrictToStringKeys<{ schema: string }>

  Returns undefined | Validator<DeepRestrictToStringKeys<{ schema: string }>>

wrap

• wrap(
      payload: DeepRestrictToStringKeys<{ schema: string }>,
  ): undefined | PayloadWrapper

• Parameters

  • payload: DeepRestrictToStringKeys<{ schema: string }>

  Returns undefined | PayloadWrapper