Interface StringOptions

interface StringOptions {
    $id?: string;
    $schema?: string;
    contentEncoding?: StringContentEncodingOption;
    contentMediaType?: string;
    default?: any;
    description?: string;
    examples?: any;
    format?: StringFormatOption;
    maxLength?: number;
    minLength?: number;
    pattern?: string;
    readOnly?: boolean;
    title?: string;
    writeOnly?: boolean;
}

Hierarchy (view full)

Properties

$id? $schema? contentEncoding? contentMediaType? default? description? examples? format? maxLength? minLength? pattern? readOnly? title? writeOnly?

Properties

Optional$id

$id?: string

Id for this schema

Optional$schema

$schema?: string

OptionalcontentEncoding

contentEncoding?: StringContentEncodingOption

The content encoding for this string

OptionalcontentMediaType

contentMediaType?: string

The content media type for this string

Optionaldefault

default?: any

Default value for this schema

Optionaldescription

description?: string

Description of this schema

Optionalexamples

examples?: any

Example values matching this schema

Optionalformat

format?: StringFormatOption

A format this string should match

OptionalmaxLength

maxLength?: number

The maximum string length

OptionalminLength

minLength?: number

The minimum string length

Optionalpattern

pattern?: string

A regular expression pattern this string should match

OptionalreadOnly

readOnly?: boolean

Optional annotation for readOnly

Optionaltitle

title?: string

Title of this schema

OptionalwriteOnly

writeOnly?: boolean

Optional annotation for writeOnly

Settings

Member Visibility

On This Page

Properties