flowingts / TSchema

Interface: TSchema

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:23

Estende

• TKind
• SchemaOptions

Indexável

[prop: string]: any

Propriedades

[Hint]?

optional [Hint]?: string

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:26

---

[Kind]

[Kind]: string

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:21

Herdado de

TKind.[Kind]

---

[OptionalKind]?

optional [OptionalKind]?: string

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:25

---

[ReadonlyKind]?

optional [ReadonlyKind]?: string

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:24

---

$id?

optional $id?: string

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:5

Id for this schema

Herdado de

SchemaOptions.$id

---

$schema?

optional $schema?: string

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:3

Herdado de

SchemaOptions.$schema

---

default?

optional default?: any

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:11

Default value for this schema

Herdado de

SchemaOptions.default

---

description?

optional description?: string

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:9

Description of this schema

Herdado de

SchemaOptions.description

---

examples?

optional examples?: any

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:13

Example values matching this schema

Herdado de

SchemaOptions.examples

---

params

params: unknown[]

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:27

---

readOnly?

optional readOnly?: boolean

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:15

Optional annotation for readOnly

Herdado de

SchemaOptions.readOnly

---

static

static: unknown

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:28

---

title?

optional title?: string

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:7

Title of this schema

Herdado de

SchemaOptions.title

---

writeOnly?

optional writeOnly?: boolean

Definido em: node_modules/.pnpm/@sinclair+typebox@0.34.52/node_modules/@sinclair/typebox/build/esm/type/schema/schema.d.mts:17

Optional annotation for writeOnly

Herdado de

SchemaOptions.writeOnly