Github Link

      Interface FilterAnnotations<A>

      Since

      1.0.0

      interface FilterAnnotations {
          arbitrary?: ((...args) => Arbitrary<any>);
          default?: unknown;
          description?: string;
          documentation?: string;
          equivalence?: (() => Equivalence<A>);
          examples?: ExamplesAnnotation;
          identifier?: string;
          jsonSchema?: object;
          message?: MessageAnnotation<A>;
          pretty?: ((...args) => Pretty<any>);
          title?: string;
          typeId?: symbol | {
              id: symbol;
              params: unknown;
          };
      }

      Type Parameters

      • A

      Hierarchy

      Properties

      arbitrary? default? description? documentation? equivalence? examples? identifier? jsonSchema? message? pretty? title? typeId?

      Properties

      Optional Readonly arbitrary

      arbitrary?: ((...args) => Arbitrary<any>)

      Type declaration

      Optional Readonly default

      default?: unknown

      Optional Readonly description

      description?: string

      Optional Readonly documentation

      documentation?: string

      Optional Readonly equivalence

      equivalence?: (() => Equivalence<A>)

      Type declaration

      Optional Readonly examples

      examples?: ExamplesAnnotation

      Optional Readonly identifier

      identifier?: string

      Optional Readonly jsonSchema

      jsonSchema?: object

      Optional Readonly message

      message?: MessageAnnotation<A>

      Optional Readonly pretty

      pretty?: ((...args) => Pretty<any>)

      Type declaration

      Optional Readonly title

      title?: string

      Optional Readonly typeId

      typeId?: symbol | {
          id: symbol;
          params: unknown;
      }

      Type declaration

      • id: symbol
      • params: unknown

      Settings

      Member Visibility

      Theme

      On This Page