JsonTypeBuilder | /src/typebox.ts | typebox@0.31.20

Module

x/typebox/src/typebox.ts>JsonTypeBuilder#Index

Json Schema Type Builder with Static Type Resolution for TypeScript

sinclairzx81/typebox

Go to Latest

compiler errors system value

TemplateLiteralDslParser

TemplateLiteralFinite

TemplateLiteralGenerator

TemplateLiteralParser

TemplateLiteralPattern

TemplateLiteralResolver

JavaScriptTypeBuilder

JsonTypeBuilder

KeyArrayResolverError

TemplateLiteralFiniteError

TemplateLiteralGeneratorError

TemplateLiteralParserError

TemplateLiteralPatternError

TransformDecodeBuilder

TransformEncodeBuilder

TypeGuardUnknownTypeError

FormatRegistryValidationFunction

IntersectOptional

IntersectResolve

IntersectType

IsTemplateLiteralFinite

IsTemplateLiteralFiniteArray

IsTemplateLiteralFiniteCheck

ReadonlyOptionalPropertyKeys

StringContentEncodingOption

StringFormatOption

SymbolValue

TAdditionalProperties

TConstructorParameterArray

TConstructorParameters

TExcludeTemplateLiteral

TExcludeTemplateLiteralResult

TExtends

TExtract

TExtractArray

TExtractTemplateLiteral

TExtractTemplateLiteralResult

TIntrinsicTemplateLiteral

TRecordFromIntegerKey

TRecordFromLiteralNumberKey

TRecordFromLiteralStringKey

TRecordFromNumberKey

TRecordFromStringKey

TRecordFromTemplateLiteralKey

TRecordFromTemplateLiteralKeyFinite

TRecordFromTemplateLiteralKeyInfinite

TRecordFromUnion

TRecordFromUnionLiteralNumber

TRecordFromUnionLiteralString

TTemplateLiteralConst

TTemplateLiteralDslParser

TTemplateLiteralDslParserTemplate

TTemplateLiteralDslParserTerminal

TTemplateLiteralDslParserUnion

TTemplateLiteralDslParserUnionLiteral

TTemplateLiteralKeyRest

TTemplateLiteralKind

TTemplateLiteralUnion

TTransformResolve

TTupleRest

TUnevaluatedProperties

TUnionLiteralKeyRest

TUnionTemplateLiteral

TupleToIntersect

TupleToUnion

TypeRegistryValidationFunction

method JsonTypeBuilder.prototype.Index

import { JsonTypeBuilder } from "https://deno.land/x/typebox@0.31.20/src/typebox.ts";

Index<T extends TArray, K extends TNumber>(

schema: T,

keys: K,

options?: SchemaOptions,

): AssertType<T["items"]>

[Json] Returns an Indexed property type for the given keys

Index<T extends TTuple, K extends (keyof Static<T>)[]>(

schema: T,

keys: [...K],

options?: SchemaOptions,

): TIndex<T, Assert<K, TPropertyKey[]>>

[Json] Returns an Indexed property type for the given keys

Index<T extends TTuple, K extends TNumber>(

schema: T,

keys: K,

options?: SchemaOptions,

): UnionType<AssertRest<T["items"]>>

[Json] Returns an Indexed property type for the given keys

Index<T extends TSchema, K extends TTemplateLiteral>(

schema: T,

keys: K,

options?: SchemaOptions,

): TIndex<T, TTemplateLiteralKeyRest<K>>

[Json] Returns an Indexed property type for the given keys

Index<T extends TSchema, K extends TLiteral<TPropertyKey>>(

schema: T,

keys: K,

options?: SchemaOptions,

): TIndex<T, [K["const"]]>

[Json] Returns an Indexed property type for the given keys

Index<T extends TSchema, K extends (keyof Static<T>)[]>(

schema: T,

keys: [...K],

options?: SchemaOptions,

): TIndex<T, Assert<K, TPropertyKey[]>>

[Json] Returns an Indexed property type for the given keys

Index<T extends TSchema, K extends TUnion<TLiteral<TPropertyKey>[]>>(

schema: T,

keys: K,

options?: SchemaOptions,

): TIndex<T, TUnionLiteralKeyRest<K>>

[Json] Returns an Indexed property type for the given keys

Index<T extends TSchema, K extends TSchema>(

schema: T,

key: K,

options?: SchemaOptions,

): TSchema

[Json] Returns an Indexed property type for the given keys

Type Parameters

T extends TArray

K extends TNumber

Parameters

schema: T

keys: K

optional

options: SchemaOptions

Returns

AssertType<T["items"]>

[Json] Returns an Indexed property type for the given keys

Type Parameters

T extends TTuple

K extends (keyof Static<T>)[]

Parameters

schema: T

keys: [...K]

optional

options: SchemaOptions

Returns

TIndex<T, Assert<K, TPropertyKey[]>>

[Json] Returns an Indexed property type for the given keys

Type Parameters

T extends TTuple

K extends TNumber

Parameters

schema: T

keys: K

optional

options: SchemaOptions

Returns

UnionType<AssertRest<T["items"]>>

[Json] Returns an Indexed property type for the given keys

Type Parameters

T extends TSchema

K extends TTemplateLiteral

Parameters

schema: T

keys: K

optional

options: SchemaOptions

Returns

TIndex<T, TTemplateLiteralKeyRest<K>>

[Json] Returns an Indexed property type for the given keys

Type Parameters

T extends TSchema

K extends TLiteral<TPropertyKey>

Parameters

schema: T

keys: K

optional

options: SchemaOptions

Returns

TIndex<T, [K["const"]]>

[Json] Returns an Indexed property type for the given keys

Type Parameters

T extends TSchema

K extends (keyof Static<T>)[]

Parameters

schema: T

keys: [...K]

optional

options: SchemaOptions

Returns

TIndex<T, Assert<K, TPropertyKey[]>>

[Json] Returns an Indexed property type for the given keys

Type Parameters

T extends TSchema

K extends TUnion<TLiteral<TPropertyKey>[]>

Parameters

schema: T

keys: K

optional

options: SchemaOptions

Returns

TIndex<T, TUnionLiteralKeyRest<K>>

[Json] Returns an Indexed property type for the given keys

Type Parameters

T extends TSchema

K extends TSchema

Parameters

schema: T

key: K

optional

options: SchemaOptions

Returns

TSchema