#Function: parse()

Parses a value using a Standard Schema compatible schema. Returns a Result with the parsed value on success or validation errors on failure.

#Type Param

The Standard Schema V1 compatible schema type.

#Examples

import { Result } from '@praha/byethrow';
import { z } from 'zod';

const schema = z.object({ name: z.string() });
const result = Result.parse(schema, { name: 'John' });
// Result.Result<{ name: string }, ReadonlyArray<StandardSchemaV1.Issue>>

import { Result } from '@praha/byethrow';
import { z } from 'zod';

const schema = z.object({ name: z.string() });
const parser = Result.parse(schema);
const result = parser({ name: 'John' });
// Result.Result<{ name: string }, ReadonlyArray<StandardSchemaV1.Issue>>

#Call Signature

parse<S>(schema): (value) => Result<InferOutput<S>, readonly Issue[]>

Defined in: functions/parse.ts:42

#Type Parameters

#S

S extends StandardSchemaV1<unknown, unknown>

#Parameters

#schema

S

#Returns

(value): Result<InferOutput<S>, readonly Issue[]>

#Parameters

#value

unknown

#Returns

Result<InferOutput<S>, readonly Issue[]>

#Call Signature

parse<S>(schema, value): Result<InferOutput<S>, readonly Issue[]>

Defined in: functions/parse.ts:43

#Type Parameters

#S

S extends StandardSchemaV1<unknown, unknown>

#Parameters

#schema

S

#value

unknown

#Returns

Result<InferOutput<S>, readonly Issue[]>