Interface: StringOptions

Extends

• SchemaOptions

Properties

$id?

optional $id: string

Id for this schema

Inherited from

SchemaOptions.$id

Defined in

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

---

$schema?

optional $schema: string

Inherited from

SchemaOptions.$schema

Defined in

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

---

contentEncoding?

optional contentEncoding: StringContentEncodingOption

The content encoding for this string

Defined in

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

---

contentMediaType?

optional contentMediaType: string

The content media type for this string

Defined in

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

---

default?

optional default: any

Default value for this schema

Inherited from

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

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

SchemaOptions.examples

Defined in

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

---

format?

optional format: StringFormatOption

A format this string should match

Defined in

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

---

maxLength?

optional maxLength: number

The maximum string length

Defined in

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

---

minLength?

optional minLength: number

The minimum string length

Defined in

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

---

pattern?

optional pattern: string

A regular expression pattern this string should match

Defined in

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

---

readOnly?

optional readOnly: boolean

Optional annotation for readOnly

Inherited from

SchemaOptions.readOnly

Defined in

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

---

title?

optional title: string

Title of this schema

Inherited from

SchemaOptions.title

Defined in

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

---

writeOnly?

optional writeOnly: boolean

Optional annotation for writeOnly

Inherited from

SchemaOptions.writeOnly

Defined in

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