StandardSchemaV1
Interfaces
Props
Defined in: packages/core/src/standardSchema.ts:11
Type Parameters
| Type Parameter | Default type |
|---|---|
Input |
unknown |
Output |
Input |
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
version |
readonly |
1 |
packages/core/src/standardSchema.ts:12 |
vendor |
readonly |
string |
packages/core/src/standardSchema.ts:13 |
validate |
readonly |
(value) => | Result<Output> | Promise<Result<Output>> |
packages/core/src/standardSchema.ts:14 |
types? |
readonly |
Types<Input, Output> |
packages/core/src/standardSchema.ts:17 |
SuccessResult
Defined in: packages/core/src/standardSchema.ts:20
Type Parameters
| Type Parameter |
|---|
Output |
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
value |
readonly |
Output |
packages/core/src/standardSchema.ts:21 |
issues? |
readonly |
undefined |
packages/core/src/standardSchema.ts:22 |
FailureResult
Defined in: packages/core/src/standardSchema.ts:24
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
issues |
readonly |
readonly Issue[] |
packages/core/src/standardSchema.ts:25 |
Issue
Defined in: packages/core/src/standardSchema.ts:27
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
message |
readonly |
string |
packages/core/src/standardSchema.ts:28 |
path? |
readonly |
readonly ( | PropertyKey | PathSegment)[] |
packages/core/src/standardSchema.ts:29 |
PathSegment
Defined in: packages/core/src/standardSchema.ts:31
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
key |
readonly |
PropertyKey |
packages/core/src/standardSchema.ts:32 |
Types
Defined in: packages/core/src/standardSchema.ts:34
Type Parameters
| Type Parameter | Default type |
|---|---|
Input |
unknown |
Output |
Input |
Properties
| Property | Modifier | Type | Defined in |
|---|---|---|---|
input |
readonly |
Input |
packages/core/src/standardSchema.ts:35 |
output |
readonly |
Output |
packages/core/src/standardSchema.ts:36 |
Type Aliases
Result
type Result<Output> =
| SuccessResult<Output>
| FailureResult;Defined in: packages/core/src/standardSchema.ts:19
Type Parameters
| Type Parameter |
|---|
Output |
InferInput
type InferInput<Schema> = NonNullable<Schema["~standard"]["types"]>["input"];Defined in: packages/core/src/standardSchema.ts:38
Type Parameters
| Type Parameter |
|---|
Schema extends StandardSchemaV1 |
InferOutput
type InferOutput<Schema> = NonNullable<Schema["~standard"]["types"]>["output"];Defined in: packages/core/src/standardSchema.ts:41
Type Parameters
| Type Parameter |
|---|
Schema extends StandardSchemaV1 |