ArraySchema
Generated by TypeDoc. Do not edit this page directly.
Class: ArraySchema<TItem>
Section titled “Class: ArraySchema<TItem>”Defined in: packages/core/src/schema/index.ts:238
Extends
Section titled “Extends”Schema<InferInput<TItem>[],InferOutput<TItem>[]>
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
TItem extends Schema<any, any> |
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ArraySchema<TItem>(item): ArraySchema<TItem>;Defined in: packages/core/src/schema/index.ts:239
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
item | TItem |
Returns
Section titled “Returns”ArraySchema<TItem>
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<InferInput<TItem>[] | undefined, InferOutput<TItem>[]>;Defined in: packages/core/src/schema/index.ts:92
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
value | | InferOutput<TItem>[] | (() => InferOutput<TItem>[]) |
Returns
Section titled “Returns”DefaultSchema<InferInput<TItem>[] | undefined, InferOutput<TItem>[]>
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<InferInput<TItem>[] | undefined, | InferOutput<TItem>[]| undefined>;Defined in: packages/core/src/schema/index.ts:88
Returns
Section titled “Returns”OptionalSchema<InferInput<TItem>[] | undefined,
| InferOutput<TItem>[]
| undefined>
Inherited from
Section titled “Inherited from”parse()
Section titled “parse()”parse(input): InferOutput<TItem>[];Defined in: packages/core/src/schema/index.ts:82
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | InferInput<TItem>[] |
Returns
Section titled “Returns”InferOutput<TItem>[]
Inherited from
Section titled “Inherited from”safeParse()
Section titled “safeParse()”safeParse(input): SafeParseResult<InferOutput<TItem>[]>;Defined in: packages/core/src/schema/index.ts:243
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | unknown |
Returns
Section titled “Returns”SafeParseResult<InferOutput<TItem>[]>
Overrides
Section titled “Overrides”toJsonSchema()
Section titled “toJsonSchema()”toJsonSchema(): JsonSchema;Defined in: packages/core/src/schema/index.ts:255