NumberSchema
Generated by TypeDoc. Do not edit this page directly.
Class: NumberSchema
Section titled “Class: NumberSchema”Defined in: packages/core/src/schema/index.ts:171
Extends
Section titled “Extends”Schema<unknown,number>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new NumberSchema(): NumberSchema;Returns
Section titled “Returns”NumberSchema
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”| Property | Modifier | Type | Default value | Inherited from | Defined in |
|---|---|---|---|---|---|
isHarnessSchema | readonly | true | true | Schema.isHarnessSchema | packages/core/src/schema/index.ts:76 |
Methods
Section titled “Methods”default()
Section titled “default()”default(value): DefaultSchema<unknown, number>;Defined in: packages/core/src/schema/index.ts:92
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | number | (() => number) |
Returns
Section titled “Returns”DefaultSchema<unknown, number>
Inherited from
Section titled “Inherited from”describe()
Section titled “describe()”describe(description): this;Defined in: packages/core/src/schema/index.ts:96
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
description | string |
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”int(): this;Defined in: packages/core/src/schema/index.ts:177
Returns
Section titled “Returns”this
max(value): this;Defined in: packages/core/src/schema/index.ts:187
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | number |
Returns
Section titled “Returns”this
min(value): this;Defined in: packages/core/src/schema/index.ts:182
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | number |
Returns
Section titled “Returns”this
optional()
Section titled “optional()”optional(): OptionalSchema<unknown, number | undefined>;Defined in: packages/core/src/schema/index.ts:88
Returns
Section titled “Returns”OptionalSchema<unknown, number | undefined>
Inherited from
Section titled “Inherited from”parse()
Section titled “parse()”parse(input): number;Defined in: packages/core/src/schema/index.ts:82
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”number
Inherited from
Section titled “Inherited from”positive()
Section titled “positive()”positive(): this;Defined in: packages/core/src/schema/index.ts:192
Returns
Section titled “Returns”this
safeParse()
Section titled “safeParse()”safeParse(input): SafeParseResult<number>;Defined in: packages/core/src/schema/index.ts:197
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”SafeParseResult<number>
Overrides
Section titled “Overrides”toJsonSchema()
Section titled “toJsonSchema()”toJsonSchema(): JsonSchema;Defined in: packages/core/src/schema/index.ts:216