Skip to main content Link Search Menu Expand Document (external link)
schema

Parser overview

Added in v1.0.0

Table of contents

decoding

decode

Signature

export declare const decode: <I, A>(
  schema: Schema.Schema<I, A>
) => (i: I, options?: AST.ParseOptions) => Effect.Effect<never, ParseResult.ParseError, A>

Added in v1.0.0

decodeEither

Signature

export declare const decodeEither: <I, A>(
  schema: Schema.Schema<I, A>
) => (i: I, options?: AST.ParseOptions) => Either.Either<ParseResult.ParseError, A>

Added in v1.0.0

decodeOption

Signature

export declare const decodeOption: <I, A>(
  schema: Schema.Schema<I, A>
) => (i: I, options?: AST.ParseOptions) => Option.Option<A>

Added in v1.0.0

decodePromise

Signature

export declare const decodePromise: <I, A>(
  schema: Schema.Schema<I, A>
) => (i: I, options?: AST.ParseOptions) => Promise<A>

Added in v1.0.0

decodeSync

Signature

export declare const decodeSync: <I, A>(schema: Schema.Schema<I, A>) => (i: I, options?: AST.ParseOptions) => A

Added in v1.0.0

encoding

encode

Signature

export declare const encode: <I, A>(
  schema: Schema.Schema<I, A>
) => (a: A, options?: AST.ParseOptions) => Effect.Effect<never, ParseResult.ParseError, I>

Added in v1.0.0

encodeEither

Signature

export declare const encodeEither: <I, A>(
  schema: Schema.Schema<I, A>
) => (a: A, options?: AST.ParseOptions) => Either.Either<ParseResult.ParseError, I>

Added in v1.0.0

encodeOption

Signature

export declare const encodeOption: <I, A>(
  schema: Schema.Schema<I, A>
) => (input: A, options?: AST.ParseOptions) => Option.Option<I>

Added in v1.0.0

encodePromise

Signature

export declare const encodePromise: <I, A>(
  schema: Schema.Schema<I, A>
) => (a: A, options?: AST.ParseOptions) => Promise<I>

Added in v1.0.0

encodeSync

Signature

export declare const encodeSync: <I, A>(schema: Schema.Schema<I, A>) => (a: A, options?: AST.ParseOptions) => I

Added in v1.0.0

parsing

parse

Signature

export declare const parse: <_, A>(
  schema: Schema.Schema<_, A>
) => (i: unknown, options?: AST.ParseOptions) => Effect.Effect<never, ParseResult.ParseError, A>

Added in v1.0.0

parseEither

Signature

export declare const parseEither: <_, A>(
  schema: Schema.Schema<_, A>
) => (i: unknown, options?: AST.ParseOptions) => Either.Either<ParseResult.ParseError, A>

Added in v1.0.0

parseOption

Signature

export declare const parseOption: <_, A>(
  schema: Schema.Schema<_, A>
) => (i: unknown, options?: AST.ParseOptions) => Option.Option<A>

Added in v1.0.0

parsePromise

Signature

export declare const parsePromise: <_, A>(
  schema: Schema.Schema<_, A>
) => (i: unknown, options?: AST.ParseOptions) => Promise<A>

Added in v1.0.0

parseSync

Signature

export declare const parseSync: <_, A>(schema: Schema.Schema<_, A>) => (i: unknown, options?: AST.ParseOptions) => A

Added in v1.0.0

utils

defaultParseOption

Signature

export declare const defaultParseOption: AST.ParseOptions

Added in v1.0.0”

validation

asserts

Signature

export declare const asserts: <_, A>(
  schema: Schema.Schema<_, A>
) => (a: unknown, options?: AST.ParseOptions) => asserts a is A

Added in v1.0.0

is

Signature

export declare const is: <_, A>(schema: Schema.Schema<_, A>) => (a: unknown) => a is A

Added in v1.0.0

validate

Signature

export declare const validate: <_, A>(
  schema: Schema.Schema<_, A>
) => (a: unknown, options?: AST.ParseOptions) => Effect.Effect<never, ParseResult.ParseError, A>

Added in v1.0.0

validateEither

Signature

export declare const validateEither: <_, A>(
  schema: Schema.Schema<_, A>
) => (a: unknown, options?: AST.ParseOptions) => Either.Either<ParseResult.ParseError, A>

Added in v1.0.0

validateOption

Signature

export declare const validateOption: <_, A>(
  schema: Schema.Schema<_, A>
) => (a: unknown, options?: AST.ParseOptions) => Option.Option<A>

Added in v1.0.0

validatePromise

Signature

export declare const validatePromise: <_, A>(
  schema: Schema.Schema<_, A>
) => (i: unknown, options?: AST.ParseOptions) => Promise<A>

Added in v1.0.0

validateSync

Signature

export declare const validateSync: <_, A>(schema: Schema.Schema<_, A>) => (a: unknown, options?: AST.ParseOptions) => A

Added in v1.0.0