Skip to content

Interface: NumberOptions ​

Extends ​

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


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


exclusiveMaximum? ​

optional exclusiveMaximum: number

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/number/number.d.ts:4


exclusiveMinimum? ​

optional exclusiveMinimum: number

Defined in ​

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


maximum? ​

optional maximum: number

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/number/number.d.ts:6


minimum? ​

optional minimum: number

Defined in ​

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


multipleOf? ​

optional multipleOf: number

Defined in ​

node_modules/@sinclair/typebox/build/cjs/type/number/number.d.ts:8


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

Released under the MIT License.