Error.ts overview
Since v1.0.0
Exports Grouped by Category
Model
SystemErrorReason
Signature
declare const SystemErrorReason: Schema.Literal<
[
"AlreadyExists",
"BadResource",
"Busy",
"InvalidData",
"NotFound",
"PermissionDenied",
"TimedOut",
"UnexpectedEof",
"Unknown",
"WouldBlock",
"WriteZero"
]
>
Since v1.0.0
SystemErrorReason (type alias)
Signature
type SystemErrorReason = typeof SystemErrorReason.Type
Since v1.0.0
Models
BadArgument (class)
Signature
declare class BadArgument
Since v1.0.0
[TypeId] (property)
Signature
readonly [TypeId]: unique symbol
Since v1.0.0
Module
Signature
declare const Module: Schema.Literal<
["Clipboard", "Command", "FileSystem", "KeyValueStore", "Path", "Stream", "Terminal"]
>
Since v1.0.0
PlatformError
Signature
declare const PlatformError: Schema.Union<[typeof BadArgument, typeof SystemError]>
Since v1.0.0
PlatformError (type alias)
Signature
type PlatformError = BadArgument | SystemError
Since v1.0.0
error
TypeIdError
Signature
declare const TypeIdError: <const TypeId extends symbol, const Tag extends string>(
typeId: TypeId,
tag: Tag
) => new <A extends Record<string, any>>(
args: Simplify<A>
) => Cause.YieldableError & Record<TypeId, TypeId> & { readonly _tag: Tag } & Readonly<A>
Since v1.0.0
models
SystemError (class)
Signature
declare class SystemError
Since v1.0.0
[TypeId] (property)
Signature
readonly [TypeId]: unique symbol
Since v1.0.0
refinements
isPlatformError
Signature
declare const isPlatformError: (u: unknown) => u is PlatformError
Since v1.0.0
type id
TypeId
Signature
declare const TypeId: unique symbol
Since v1.0.0
TypeId (type alias)
Signature
type TypeId = typeof TypeId
Since v1.0.0