RecordSchema
Generated by TypeDoc. Do not edit this page directly.
Class: RecordSchema<TValue>
Section titled “Class: RecordSchema<TValue>”Defined in: packages/core/src/schema/index.ts:313
Extends
Section titled “Extends”Schema<Record<string,InferInput<TValue>>,Record<string,InferOutput<TValue>>>
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
TValue extends Schema<any, any> |
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RecordSchema<TValue>(valueSchema): RecordSchema<TValue>;Defined in: packages/core/src/schema/index.ts:314
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
valueSchema | TValue |
Returns
Section titled “Returns”RecordSchema<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< | Record<string, InferInput<TValue>>| undefined, Record<string, InferOutput<TValue>>>;Defined in: packages/core/src/schema/index.ts:92
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | | Record<string, InferOutput<TValue>> | (() => TOutput) |
Returns
Section titled “Returns”DefaultSchema<
| Record<string, InferInput<TValue>>
| undefined, Record<string, InferOutput<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< | Record<string, InferInput<TValue>> | undefined, | Record<string, InferOutput<TValue>>| undefined>;Defined in: packages/core/src/schema/index.ts:88
Returns
Section titled “Returns”OptionalSchema<
| Record<string, InferInput<TValue>>
| undefined,
| Record<string, InferOutput<TValue>>
| undefined>
Inherited from
Section titled “Inherited from”parse()
Section titled “parse()”parse(input): TOutput;Defined in: packages/core/src/schema/index.ts:82
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | TInput |
Returns
Section titled “Returns”TOutput
Inherited from
Section titled “Inherited from”safeParse()
Section titled “safeParse()”safeParse(input): SafeParseResult<Record<string, InferOutput<TValue>>>;Defined in: packages/core/src/schema/index.ts:318
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”SafeParseResult<Record<string, InferOutput<TValue>>>
Overrides
Section titled “Overrides”toJsonSchema()
Section titled “toJsonSchema()”toJsonSchema(): JsonSchema;Defined in: packages/core/src/schema/index.ts:332