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