Class PayloadPluginResolver

constructor

• new PayloadPluginResolver(
      plugins?: PayloadPlugin<Payload>[],
      defaultPlugin?: PayloadPlugin<Payload>,
  ): PayloadPluginResolver

  Parameters

  • Optionalplugins: PayloadPlugin<Payload>[]

    Param: plugins

    The initial set of plugins

  • defaultPlugin: PayloadPlugin<Payload> = ...

    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: Payload): PayloadPlugin

  Parameters

  • payload: Payload

  Returns PayloadPlugin

schemas

• schemas(): string[]

  Returns string[]

  Description

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

validate

• validate(payload: Payload): undefined | Validator<Payload>

  Parameters

  • payload: Payload

  Returns undefined | Validator<Payload>

wrap

• wrap(payload: Payload): undefined | PayloadWrapper<Payload>

  Parameters

  • payload: Payload

  Returns undefined | PayloadWrapper<Payload>