OptionalSchema
Generated by TypeDoc. Do not edit this page directly.
Class: OptionalSchema<TInput, TOutput>
Section titled “Class: OptionalSchema<TInput, TOutput>”Defined in: packages/core/src/schema/index.ts:373
Extends
Section titled “Extends”Schema<TInput|undefined,TOutput|undefined>
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
TInput |
TOutput |
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new OptionalSchema<TInput, TOutput>(inner): OptionalSchema<TInput, TOutput>;Defined in: packages/core/src/schema/index.ts:374
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
inner | Schema<TInput, TOutput> |
Returns
Section titled “Returns”OptionalSchema<TInput, TOutput>
Overrides
Section titled “Overrides”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<TInput | undefined, TOutput | undefined>;Defined in: packages/core/src/schema/index.ts:92
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | TOutput | (() => TOutput | undefined) | undefined |
Returns
Section titled “Returns”DefaultSchema<TInput | undefined, TOutput | undefined>
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”optional()
Section titled “optional()”optional(): OptionalSchema<TInput | undefined, TOutput | undefined>;Defined in: packages/core/src/schema/index.ts:88
Returns
Section titled “Returns”OptionalSchema<TInput | undefined, TOutput | undefined>
Inherited from
Section titled “Inherited from”parse()
Section titled “parse()”parse(input): TOutput | undefined;Defined in: packages/core/src/schema/index.ts:82
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | TInput | undefined |
Returns
Section titled “Returns”TOutput | undefined
Inherited from
Section titled “Inherited from”safeParse()
Section titled “safeParse()”safeParse(input): SafeParseResult<TOutput | undefined>;Defined in: packages/core/src/schema/index.ts:378
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”SafeParseResult<TOutput | undefined>
Overrides
Section titled “Overrides”toJsonSchema()
Section titled “toJsonSchema()”toJsonSchema(): JsonSchema;Defined in: packages/core/src/schema/index.ts:383