Interface: TObject<T>

Extends

• TSchema.ObjectOptions

Type Parameters

Type Parameter	Default type
T extends TProperties	TProperties

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]: "Object"

Overrides

TSchema.[Kind]

Defined in

node_modules/@sinclair/typebox/build/cjs/type/object/object.d.ts:33

---

[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

---

additionalProperties?

optional additionalProperties: TAdditionalProperties

Additional property constraints for this object

Overrides

ObjectOptions.additionalProperties

Defined in

node_modules/@sinclair/typebox/build/cjs/type/object/object.d.ts:35

---

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

---

maxProperties?

optional maxProperties: number

The maximum number of properties allowed on this object

Inherited from

ObjectOptions.maxProperties

Defined in

node_modules/@sinclair/typebox/build/cjs/type/object/object.d.ts:30

---

minProperties?

optional minProperties: number

The minimum number of properties allowed on this object

Inherited from

ObjectOptions.minProperties

Defined in

node_modules/@sinclair/typebox/build/cjs/type/object/object.d.ts:28

---

params

params: unknown[]

Inherited from

TSchema.params

Defined in

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

---

properties

properties: T

Defined in

node_modules/@sinclair/typebox/build/cjs/type/object/object.d.ts:37

---

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

---

required?

optional required: string[]

Defined in

node_modules/@sinclair/typebox/build/cjs/type/object/object.d.ts:38

---

static

static: Evaluate<Readonly<Partial<Pick<{ [K in string | number | symbol]: Static<T[K], unknown[]> }, ReadonlyOptionalPropertyKeys<T>>>> & Readonly<Pick<{ [K in string | number | symbol]: Static<T[K], unknown[]> }, ReadonlyPropertyKeys<T>>> & Partial<Pick<{ [K in string | number | symbol]: Static<T[K], unknown[]> }, OptionalPropertyKeys<T>>> & Required<Pick<{ [K in string | number | symbol]: Static<T[K], unknown[]> }, Exclude<keyof T, ReadonlyOptionalPropertyKeys<T> | ReadonlyPropertyKeys<T> | OptionalPropertyKeys<T>>>>>

Overrides

TSchema.static

Defined in

node_modules/@sinclair/typebox/build/cjs/type/object/object.d.ts:34

---

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: "object"

Defined in

node_modules/@sinclair/typebox/build/cjs/type/object/object.d.ts:36

---

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