Github Link

      Interface DocAnnotations<A>

      Since

      1.0.0

      interface DocAnnotations {
          default?: unknown;
          description?: string;
          documentation?: string;
          examples?: ExamplesAnnotation;
          identifier?: string;
          message?: MessageAnnotation<A>;
          title?: string;
      }

      Type Parameters

      • A

      Hierarchy

      Properties

      default? description? documentation? examples? identifier? message? title?

      Properties

      Optional Readonly default

      default?: unknown

      Optional Readonly description

      description?: string

      Optional Readonly documentation

      documentation?: string

      Optional Readonly examples

      examples?: ExamplesAnnotation

      Optional Readonly identifier

      identifier?: string

      Optional Readonly message

      message?: MessageAnnotation<A>

      Optional Readonly title

      title?: string

      Settings

      Member Visibility

      Theme

      On This Page