Skip to content

Interface: TTuple<T>

Extends

  • TSchema

Type Parameters

Type ParameterDefault type
T extends TSchema[]TSchema[]

Properties

[Hint]?

optional [Hint]: string

Inherited from

TSchema.[Hint]

Defined in

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


[Kind]

[Kind]: "Tuple"

Overrides

TSchema.[Kind]

Defined in

node_modules/@sinclair/typebox/build/cjs/type/tuple/tuple.d.ts:6


[OptionalKind]?

optional [OptionalKind]: string

Inherited from

TSchema.[OptionalKind]

Defined in

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


[ReadonlyKind]?

optional [ReadonlyKind]: string

Inherited from

TSchema.[ReadonlyKind]

Defined in

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


$id?

optional $id: string

Id for this schema

Inherited from

TSchema.$id

Defined in

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


$schema?

optional $schema: string

Inherited from

TSchema.$schema

Defined in

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


additionalItems?

optional additionalItems: false

Defined in

node_modules/@sinclair/typebox/build/cjs/type/tuple/tuple.d.ts:10


default?

optional default: any

Default value for this schema

Inherited from

TSchema.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

TSchema.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

TSchema.examples

Defined in

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


items?

optional items: T

Defined in

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


maxItems

maxItems: number

Defined in

node_modules/@sinclair/typebox/build/cjs/type/tuple/tuple.d.ts:12


minItems

minItems: number

Defined in

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


params

params: unknown[]

Inherited from

TSchema.params

Defined in

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


readOnly?

optional readOnly: boolean

Optional annotation for readOnly

Inherited from

TSchema.readOnly

Defined in

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


static

static: TupleStatic<T, unknown[], []>

Overrides

TSchema.static

Defined in

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


title?

optional title: string

Title of this schema

Inherited from

TSchema.title

Defined in

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


type

type: "array"

Defined in

node_modules/@sinclair/typebox/build/cjs/type/tuple/tuple.d.ts:8


writeOnly?

optional writeOnly: boolean

Optional annotation for writeOnly

Inherited from

TSchema.writeOnly

Defined in

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

Released under the MIT License.