Class CallableFunctionString

Hierarchy

Constructors

constructor

Properties

$comment? default? deprecated? description? enum? examples? format? id maxLength? minLength? name pattern? readOnly? title? type writeOnly?

Methods

toJSON toJSONBase fromJSON isStringSchema

Constructors

constructor

  • Parameters

    • name: string
    • options: Omit<{
          $comment?: string;
          default?: any;
          deprecated?: boolean;
          description?: string;
          enum?: string[];
          examples?: any[];
          format?: "date" | "date-time" | "time" | "duration" | "email" | "idn-email" | "hostname" | "idn-hostname" | "ipv4" | "ipv6" | "uuid" | "uri" | "uri-reference" | "iri" | "iri-reference" | "uri-template" | "json-pointer" | "relative-json-pointer" | "regex";
          maxLength?: number;
          minLength?: number;
          pattern?: string;
          readOnly?: boolean;
          title?: string;
          type: "string";
          writeOnly?: boolean;
      }, "type"> = {}

    Returns CallableFunctionString

Properties

Optional $comment

$comment?: string

Optional default

default?: any

Optional deprecated

deprecated?: boolean

Optional description

description?: string

Optional enum

enum?: string[]

Optional examples

examples?: any[]

Optional format

format?: "date" | "date-time" | "time" | "duration" | "email" | "idn-email" | "hostname" | "idn-hostname" | "ipv4" | "ipv6" | "uuid" | "uri" | "uri-reference" | "iri" | "iri-reference" | "uri-template" | "json-pointer" | "relative-json-pointer" | "regex"

id

id: string = ...

A UUID generated for this parameter by the library.

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

name

name: string

Optional pattern

pattern?: string

Optional readOnly

readOnly?: boolean

Optional title

title?: string

Readonly type

type: "string" = "string"

Optional writeOnly

writeOnly?: boolean

Methods

toJSON

  • Serializes the parameter into a JSON object.

    Returns {
        $comment?: string;
        default?: any;
        deprecated?: boolean;
        description?: string;
        enum?: string[];
        examples?: any[];
        format?: "date" | "date-time" | "time" | "duration" | "email" | "idn-email" | "hostname" | "idn-hostname" | "ipv4" | "ipv6" | "uuid" | "uri" | "uri-reference" | "iri" | "iri-reference" | "uri-template" | "json-pointer" | "relative-json-pointer" | "regex";
        maxLength?: number;
        minLength?: number;
        pattern?: string;
        readOnly?: boolean;
        title?: string;
        type: "string";
        writeOnly?: boolean;
    }

    • Optional $comment?: string
    • Optional default?: any
    • Optional deprecated?: boolean
    • Optional description?: string
    • Optional enum?: string[]
    • Optional examples?: any[]
    • Optional format?: "date" | "date-time" | "time" | "duration" | "email" | "idn-email" | "hostname" | "idn-hostname" | "ipv4" | "ipv6" | "uuid" | "uri" | "uri-reference" | "iri" | "iri-reference" | "uri-template" | "json-pointer" | "relative-json-pointer" | "regex"
    • Optional maxLength?: number
    • Optional minLength?: number
    • Optional pattern?: string
    • Optional readOnly?: boolean
    • Optional title?: string
    • type: "string"
    • Optional writeOnly?: boolean

Protected toJSONBase

  • Returns {
        $comment?: string;
        default?: any;
        deprecated?: boolean;
        description?: string;
        examples?: any[];
        readOnly?: boolean;
        title?: string;
        writeOnly?: boolean;
    }

    • Optional $comment?: string
    • Optional default?: any
    • Optional deprecated?: boolean
    • Optional description?: string
    • Optional examples?: any[]
    • Optional readOnly?: boolean
    • Optional title?: string
    • Optional writeOnly?: boolean

Static fromJSON

  • Parameters

    • name: string
    • json: {
          $comment?: string;
          default?: any;
          deprecated?: boolean;
          description?: string;
          enum?: string[];
          examples?: any[];
          format?: "date" | "date-time" | "time" | "duration" | "email" | "idn-email" | "hostname" | "idn-hostname" | "ipv4" | "ipv6" | "uuid" | "uri" | "uri-reference" | "iri" | "iri-reference" | "uri-template" | "json-pointer" | "relative-json-pointer" | "regex";
          maxLength?: number;
          minLength?: number;
          pattern?: string;
          readOnly?: boolean;
          title?: string;
          type: "string";
          writeOnly?: boolean;
      }
      • Optional $comment?: string
      • Optional default?: any
      • Optional deprecated?: boolean
      • Optional description?: string
      • Optional enum?: string[]
      • Optional examples?: any[]
      • Optional format?: "date" | "date-time" | "time" | "duration" | "email" | "idn-email" | "hostname" | "idn-hostname" | "ipv4" | "ipv6" | "uuid" | "uri" | "uri-reference" | "iri" | "iri-reference" | "uri-template" | "json-pointer" | "relative-json-pointer" | "regex"
      • Optional maxLength?: number
      • Optional minLength?: number
      • Optional pattern?: string
      • Optional readOnly?: boolean
      • Optional title?: string
      • type: "string"
      • Optional writeOnly?: boolean

    Returns CallableFunctionString

Static isStringSchema

  • Whether the given JsonSchema is a JsonSchemaString.

    Note: This method does not check if the schema is valid, only if it has properties unique to string schemas.

    Parameters

    Returns json is {
        $comment?: string;
        default?: any;
        deprecated?: boolean;
        description?: string;
        enum?: string[];
        examples?: any[];
        format?: "date" | "date-time" | "time" | "duration" | "email" | "idn-email" | "hostname" | "idn-hostname" | "ipv4" | "ipv6" | "uuid" | "uri" | "uri-reference" | "iri" | "iri-reference" | "uri-template" | "json-pointer" | "relative-json-pointer" | "regex";
        maxLength?: number;
        minLength?: number;
        pattern?: string;
        readOnly?: boolean;
        title?: string;
        type: "string";
        writeOnly?: boolean;
    }

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc