EnumSchema
Generated by TypeDoc. Do not edit this page directly.
Class: EnumSchema<TValues>
Section titled “Class: EnumSchema<TValues>”Defined in: packages/core/src/schema/index.ts:337
Extends
Section titled “Extends”Schema<unknown,TValues[number]>
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
TValues extends readonly [string, ...string[]] |
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new EnumSchema<TValues>(values): EnumSchema<TValues>;Defined in: packages/core/src/schema/index.ts:338
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
values | TValues |
Returns
Section titled “Returns”EnumSchema<TValues>
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, TValues[number]>;Defined in: packages/core/src/schema/index.ts:92
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | TValues[number] | (() => TValues[number]) |
Returns
Section titled “Returns”DefaultSchema<unknown, TValues[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”optional()
Section titled “optional()”optional(): OptionalSchema<unknown, TValues[number] | undefined>;Defined in: packages/core/src/schema/index.ts:88
Returns
Section titled “Returns”OptionalSchema<unknown, TValues[number] | undefined>
Inherited from
Section titled “Inherited from”parse()
Section titled “parse()”parse(input): TValues[number];Defined in: packages/core/src/schema/index.ts:82
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”TValues[number]
Inherited from
Section titled “Inherited from”safeParse()
Section titled “safeParse()”safeParse(input): SafeParseResult<TValues[number]>;Defined in: packages/core/src/schema/index.ts:342
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”SafeParseResult<TValues[number]>
Overrides
Section titled “Overrides”toJsonSchema()
Section titled “toJsonSchema()”toJsonSchema(): JsonSchema;Defined in: packages/core/src/schema/index.ts:348