ParseResult overview
Added in v1.0.0
Table of contents
constructors
fail
Signature
export declare const fail: (
error: ParseError | ParseIssue | ReadonlyArray.NonEmptyReadonlyArray<ParseIssue>
) => ParseResult<never>
Added in v1.0.0
forbidden
Signature
export declare const forbidden: Forbidden
Added in v1.0.0
index
Signature
export declare const index: (index: number, errors: readonly [ParseIssue, ...ParseIssue[]]) => Index
Added in v1.0.0
key
Signature
export declare const key: (key: PropertyKey, errors: readonly [ParseIssue, ...ParseIssue[]]) => Key
Added in v1.0.0
missing
Signature
export declare const missing: Missing
Added in v1.0.0
succeed
Signature
export declare const succeed: <A>(a: A) => ParseResult<A>
Added in v1.0.0
try
Signature
export declare const try: <A>(options: { try: LazyArg<A>; catch: (e: unknown) => ParseError; }) => ParseResult<A>
Added in v1.0.0
type
Signature
export declare const type: (expected: AST.AST, actual: unknown, message?: string) => Type
Added in v1.0.0
unexpected
Signature
export declare const unexpected: (ast: Option.Option<AST.AST>) => Unexpected
Added in v1.0.0
unionMember
Signature
export declare const unionMember: (errors: readonly [ParseIssue, ...ParseIssue[]]) => UnionMember
Added in v1.0.0
model
Forbidden (interface)
The Forbidden variant of the ParseIssue type represents an error that occurs when an Effect is encounter but disallowed from execution.
Signature
export interface Forbidden {
readonly _tag: "Forbidden"
}
Added in v1.0.0
Index (interface)
The Index decode error indicates that there was an error at a specific index in an array or tuple. The errors field contains the decode errors for that index. This error is typically used when decoding an array or tuple with a schema that has constraints on the elements. For example, you might use an Index decode error to indicate that a specific element in an array did not match the expected type or value.
Signature
export interface Index {
readonly _tag: "Index"
readonly index: number
readonly errors: ReadonlyArray.NonEmptyReadonlyArray<ParseIssue>
}
Added in v1.0.0
Key (interface)
The Key variant of the ParseIssue type represents an error that occurs when a key in an object is invalid. This error typically occurs when the actual value is not a valid key type (e.g. a string or number) or when the key is not present in the object being decoded. In either case, the key field of the error will contain the invalid key value. This error is typically used in combination with the Unexpected error, which indicates that an unexpected key was found in the object being decoded.
Signature
export interface Key {
readonly _tag: "Key"
readonly key: PropertyKey
readonly errors: ReadonlyArray.NonEmptyReadonlyArray<ParseIssue>
}
Added in v1.0.0
Missing (interface)
Error that occurs when a required key or index is missing.
Signature
export interface Missing {
readonly _tag: "Missing"
}
Added in v1.0.0
ParseIssue (type alias)
ParseErrors is a type that represents the different types of errors that can occur when decoding a value.
Signature
export type ParseIssue = Type | Index | Key | Missing | Unexpected | UnionMember | Forbidden
Added in v1.0.0
Type (interface)
The Type variant of the ParseIssue type represents an error that occurs when the actual value is not of the expected type. The expected field specifies the expected type, and the actual field contains the value that caused the error. This error can occur when trying to decode a value using a schema that is only able to decode values of a specific type, and the actual value is not of that type. For example, if you are using a schema to decode a string value and the actual value is a number, a Type decode error would be returned.
Signature
export interface Type {
readonly _tag: "Type"
readonly expected: AST.AST
readonly actual: unknown
readonly message: Option.Option<string>
}
Added in v1.0.0
Unexpected (interface)
Error that occurs when an unexpected key or index is present.
Signature
export interface Unexpected {
readonly _tag: "Unexpected"
readonly ast: Option.Option<AST.AST>
}
Added in v1.0.0
UnionMember (interface)
Error that occurs when a member in a union has an error.
Signature
export interface UnionMember {
readonly _tag: "UnionMember"
readonly errors: ReadonlyArray.NonEmptyReadonlyArray<ParseIssue>
}
Added in v1.0.0
optimisation
bimap
Signature
export declare const bimap: <A, B>(
self: ParseResult<A>,
f: (error: ParseError) => ParseError,
g: (a: A) => B
) => ParseResult<B>
Added in v1.0.0
eitherOrUndefined
Signature
export declare const eitherOrUndefined: <A>(self: ParseResult<A>) => Either.Either<ParseError, A> | undefined
Added in v1.0.0
flatMap
Signature
export declare const flatMap: <A, B>(self: ParseResult<A>, f: (self: A) => ParseResult<B>) => ParseResult<B>
Added in v1.0.0
map
Signature
export declare const map: <A, B>(self: ParseResult<A>, f: (self: A) => B) => ParseResult<B>
Added in v1.0.0
mapLeft
Signature
export declare const mapLeft: <A>(self: ParseResult<A>, f: (error: ParseError) => ParseError) => ParseResult<A>
Added in v1.0.0
orElse
Signature
export declare const orElse: <A>(self: ParseResult<A>, f: (error: ParseError) => ParseResult<A>) => ParseResult<A>
Added in v1.0.0
utils
ParseError (interface)
Signature
export interface ParseError {
readonly _tag: "ParseError"
readonly errors: ReadonlyArray.NonEmptyReadonlyArray<ParseIssue>
}
Added in v1.0.0
ParseResult (interface)
Signature
export interface ParseResult<A> extends Effect.Effect<never, ParseError, A> {}
Added in v1.0.0
parseError
Signature
export declare const parseError: (errors: readonly [ParseIssue, ...ParseIssue[]]) => ParseError
Added in v1.0.0