Function validateInvocation

Parameters

• context: BasePluginContext & { invocation: Invocation<BaseInvocationArgs> }

  The validation plugin context containing the invocation to validate and execution context

  • invocation: Invocation<BaseInvocationArgs>

    Current invocation being processed

• validators: {
      hook: "invocation";
      name: string;
      trigger: {
          capabilityUri?: keyof JMAPServerCapabilities;
          dataType?: JMAPDataType;
          method?: JMAPMethodName;
      };
      validate(
          this: void,
          context: BasePluginContext & {
              invocation: Invocation<BaseInvocationArgs>;
          },
      ): MaybePromise<ValidationResult>;
  }[]

  The array of validators to execute

  • hook: "invocation"

    Discriminant property

  • name: string

    Plugin identifier

  • trigger: {
        capabilityUri?: keyof JMAPServerCapabilities;
        dataType?: JMAPDataType;
        method?: JMAPMethodName;
    }

    Defines when this plugin should run

    • OptionalcapabilityUri?: keyof JMAPServerCapabilities

      The capability URI of the invocation being processed.

      This differs from requiredCapabilityUri in that it is the capability URI of the specific invocation, rather than a general support requirement.

    • OptionaldataType?: JMAPDataType

      The data type of the invocation being processed.

    • Optionalmethod?: JMAPMethodName

      The method name of the invocation being processed.

  • validate: function

    • validate(
          this: void,
          context: BasePluginContext & { invocation: Invocation<BaseInvocationArgs> },
      ): MaybePromise<ValidationResult>

      Execute the validation logic

      Parameters

      • this: void
      • context: BasePluginContext & { invocation: Invocation<BaseInvocationArgs> }

        • invocation: Invocation<BaseInvocationArgs>

          Current invocation being processed

      Returns MaybePromise<ValidationResult>