Fail-loud when an HttpApi group id collides with the metrics nest key.
Source src/internal/httpApiClientSpec.ts:2211 lines
export class class MetricsKeyCollisionclass MetricsKeyCollision {
message: string;
name: string;
stack: string;
cause: unknown;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
toString: () => string;
toJSON: () => unknown;
_tag: Tag;
metricsKey: string;
apiId: string;
}
Fail-loud when an HttpApi group id collides with the metrics nest key.
MetricsKeyCollision extends import DataData.const TaggedError: <Tag extends string>(
tag: Tag
) => new <A extends Record<string, any> = {}>(
args: Types.VoidIfEmpty<{
readonly [P in keyof A as P extends "_tag"
? never
: P]: A[P]
}>
) => Cause.YieldableError & {
readonly _tag: Tag
} & Readonly<A>
Creates a tagged error class with a _tag discriminator.
When to use
Use when you need domain errors with discriminated-union handling.
Details
Like
Error
, but instances also carry a readonly _tag property,
enabling Effect.catchTag and Effect.catchTags for tag-based recovery.
The _tag is excluded from the constructor argument. Yielding an instance
inside Effect.gen fails the effect with this error.
Example (Recovering by tag)
import { Data, Effect } from "effect"
class NotFound extends Data.TaggedError("NotFound")<{
readonly resource: string
}> {}
class Forbidden extends Data.TaggedError("Forbidden")<{
readonly reason: string
}> {}
const program = Effect.gen(function*() {
return yield* new NotFound({ resource: "/users/42" })
})
const recovered = program.pipe(
Effect.catchTag("NotFound", (e) =>
Effect.succeed(`missing: ${e.resource}`))
)
TaggedError("MetricsKeyCollision")<{
readonly metricsKey: stringmetricsKey: string;
readonly apiId: stringapiId: string;
}> {
override get MetricsKeyCollision.message: stringmessage(): string {
return (
`HttpApi group id "${this.metricsKey: stringmetricsKey}" collides with Gate.HttpApiClient nest key ` +
`on api "${this.apiId: stringapiId}". Rename the group or pass metricsKey: "…" (const).`
);
}
}