Skip to content

Interface: ArrayOptions ​

Extends ​

Properties ​

$id? ​

optional $id: string

Id for this schema

Inherited from ​

SchemaOptions.$id

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/schema/schema.d.ts:5


$schema? ​

optional $schema: string

Inherited from ​

SchemaOptions.$schema

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/schema/schema.d.ts:3


contains? ​

optional contains: TSchema

A schema for which some elements should match

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/array/array.d.ts:13


default? ​

optional default: any

Default value for this schema

Inherited from ​

SchemaOptions.default

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/schema/schema.d.ts:11


description? ​

optional description: string

Description of this schema

Inherited from ​

SchemaOptions.description

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/schema/schema.d.ts:9


examples? ​

optional examples: any

Example values matching this schema

Inherited from ​

SchemaOptions.examples

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/schema/schema.d.ts:13


maxContains? ​

optional maxContains: number

A maximum number of contains schema matches

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/array/array.d.ts:17


maxItems? ​

optional maxItems: number

The maximum number of items in this array

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/array/array.d.ts:9


minContains? ​

optional minContains: number

A minimum number of contains schema matches

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/array/array.d.ts:15


minItems? ​

optional minItems: number

The minimum number of items in this array

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/array/array.d.ts:7


readOnly? ​

optional readOnly: boolean

Optional annotation for readOnly

Inherited from ​

SchemaOptions.readOnly

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/schema/schema.d.ts:15


title? ​

optional title: string

Title of this schema

Inherited from ​

SchemaOptions.title

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/schema/schema.d.ts:7


uniqueItems? ​

optional uniqueItems: boolean

Should this schema contain unique items

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/array/array.d.ts:11


writeOnly? ​

optional writeOnly: boolean

Optional annotation for writeOnly

Inherited from ​

SchemaOptions.writeOnly

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/schema/schema.d.ts:17

Released under the MIT License.