TaggedError

const TaggedError: <Self>(identifier?) => <Tag, Fields>(tag, fieldsOr, annotations?) => [Self] extends [never] ? MissingSelfGeneric<"TaggedError", ""Tag”, ”> : TaggedErrorClass<Self, Tag, object & Fields>

Defined in: node_modules/.pnpm/effect@3.15.2/node_modules/effect/dist/dts/Schema.d.ts:4438

Type Parameters

Self

Self = never

Parameters

identifier?

string

Returns

<Tag, Fields>(tag, fieldsOr, annotations?): [Self] extends [never] ? MissingSelfGeneric<"TaggedError", ""Tag”, ”> : TaggedErrorClass<Self, Tag, object & Fields>

Type Parameters

Tag

Tag extends string

Fields

Fields extends Fields

Parameters

tag

Tag

fieldsOr

Fields | HasFields<Fields>

annotations?

ClassAnnotations<Self, Simplify<Type<object & Fields>>>

Returns

[Self] extends [never] ? MissingSelfGeneric<"TaggedError", ""Tag”, ”> : TaggedErrorClass<Self, Tag, object & Fields>

Example

import { Schema } from "effect"

class MyError extends Schema.TaggedError<MyError>("MyError")(
  "MyError",
  {
    module: Schema.String,
    method: Schema.String,
    description: Schema.String
  }
) {
  get message(): string {
    return `${this.module}.${this.method}: ${this.description}`
  }
}

Since

3.10.0