Interface: SchemaOptions

Extended by

• ArrayOptions
• DateOptions
• NumberOptions
• StringOptions

Indexable

[prop: string]: any

Properties

$id?

optional $id: string

Id for this schema

Defined in

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

---

$schema?

optional $schema: string

Defined in

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

---

default?

optional default: any

Default value for this schema

Defined in

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

---

description?

optional description: string

Description of this schema

Defined in

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

---

examples?

optional examples: any

Example values matching this schema

Defined in

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

---

readOnly?

optional readOnly: boolean

Optional annotation for readOnly

Defined in

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

---

title?

optional title: string

Title of this schema

Defined in

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

---

writeOnly?

optional writeOnly: boolean

Optional annotation for writeOnly

Defined in

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