Type alias RuleSeed<T, O>

Type declaration

• Optional Readonly defaultOptions?: O

• Optional Readonly defaultSeverity?: Severity

• Optional Readonly defaultValue?: T

• fix?:function

  • fix(context: {
        document: Document<T, O>;
        report: {
            (report: Report<T, O>): undefined;
            (report: CheckerReport<T, O>): boolean;
        };
        reports: ({
            message: string;
        } | {
            message: string;
        } | {
            message: string;
        })[];
        t: Translator;
        translate: Translator;
    }): void | Promise<void>

  • Parameters

    • context: {
          document: Document<T, O>;
          report: {
              (report: Report<T, O>): undefined;
              (report: CheckerReport<T, O>): boolean;
          };
          reports: ({
              message: string;
          } | {
              message: string;
          } | {
              message: string;
          })[];
          t: Translator;
          translate: Translator;
      }

      • document: Document<T, O>

      • report: {
            (report: Report<T, O>): undefined;
            (report: CheckerReport<T, O>): boolean;
        }

        • • (report: Report<T, O>): undefined

          • Parameters

            • report: Report<T, O>

            Returns undefined

          • (report: CheckerReport<T, O>): boolean

          • Parameters

            • report: CheckerReport<T, O>

            Returns boolean

      • reports: ({
            message: string;
        } | {
            message: string;
        } | {
            message: string;
        })[]

      • t: Translator

      • translate: Translator

    Returns void | Promise<void>

• verify:function

  • verify(context: {
        document: Document<T, O>;
        report: {
            (report: Report<T, O>): undefined;
            (report: CheckerReport<T, O>): boolean;
        };
        reports: ({
            message: string;
        } | {
            message: string;
        } | {
            message: string;
        })[];
        t: Translator;
        translate: Translator;
    }): void | Promise<void>

  • Parameters

    • context: {
          document: Document<T, O>;
          report: {
              (report: Report<T, O>): undefined;
              (report: CheckerReport<T, O>): boolean;
          };
          reports: ({
              message: string;
          } | {
              message: string;
          } | {
              message: string;
          })[];
          t: Translator;
          translate: Translator;
      }

      • document: Document<T, O>

      • report: {
            (report: Report<T, O>): undefined;
            (report: CheckerReport<T, O>): boolean;
        }

        • • (report: Report<T, O>): undefined

          • Parameters

            • report: Report<T, O>

            Returns undefined

          • (report: CheckerReport<T, O>): boolean

          • Parameters

            • report: CheckerReport<T, O>

            Returns boolean

      • reports: ({
            message: string;
        } | {
            message: string;
        } | {
            message: string;
        })[]

      • t: Translator

      • translate: Translator

    Returns void | Promise<void>