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

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"
  ]
>

Source

Since v1.0.0

SystemErrorReason (type alias)

Signature

type SystemErrorReason = typeof SystemErrorReason.Type

Source

Since v1.0.0

Models

BadArgument (class)

Signature

declare class BadArgument

Source

Since v1.0.0

[TypeId] (property)

Signature

readonly [TypeId]: unique symbol

Source

Since v1.0.0

Module

Signature

declare const Module: Schema.Literal<
  ["Clipboard", "Command", "FileSystem", "KeyValueStore", "Path", "Stream", "Terminal"]
>

Source

Since v1.0.0

PlatformError

Signature

declare const PlatformError: Schema.Union<[typeof BadArgument, typeof SystemError]>

Source

Since v1.0.0

PlatformError (type alias)

Signature

type PlatformError = BadArgument | SystemError

Source

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>

Source

Since v1.0.0

models

SystemError (class)

Signature

declare class SystemError

Source

Since v1.0.0

[TypeId] (property)

Signature

readonly [TypeId]: unique symbol

Source

Since v1.0.0

refinements

isPlatformError

Signature

declare const isPlatformError: (u: unknown) => u is PlatformError

Source

Since v1.0.0

type id

TypeId

Signature

declare const TypeId: unique symbol

Source

Since v1.0.0

TypeId (type alias)

Signature

type TypeId = typeof TypeId

Source

Since v1.0.0