Interface ArrayOptions

interface ArrayOptions {
    $id?: string;
    $schema?: string;
    contains?: TSchema;
    default?: any;
    description?: string;
    examples?: any;
    maxContains?: number;
    maxItems?: number;
    minContains?: number;
    minItems?: number;
    readOnly?: boolean;
    title?: string;
    uniqueItems?: boolean;
    writeOnly?: boolean;
}

Hierarchy (view full)

Properties

$id? $schema? contains? default? description? examples? maxContains? maxItems? minContains? minItems? readOnly? title? uniqueItems? writeOnly?

Properties

Optional$id

$id?: string

Id for this schema

Optional$schema

$schema?: string

Optionalcontains

contains?: TSchema

A schema for which some elements should match

Optionaldefault

default?: any

Default value for this schema

Optionaldescription

description?: string

Description of this schema

Optionalexamples

examples?: any

Example values matching this schema

OptionalmaxContains

maxContains?: number

A maximum number of contains schema matches

OptionalmaxItems

maxItems?: number

The maximum number of items in this array

OptionalminContains

minContains?: number

A minimum number of contains schema matches

OptionalminItems

minItems?: number

The minimum number of items in this array

OptionalreadOnly

readOnly?: boolean

Optional annotation for readOnly

Optionaltitle

title?: string

Title of this schema

OptionaluniqueItems

uniqueItems?: boolean

Should this schema contain unique items

OptionalwriteOnly

writeOnly?: boolean

Optional annotation for writeOnly

Settings

Member Visibility

On This Page

Properties