Client and server disagree on a HyperService's wire contract (contractHash mismatch).
Surfaced by Hyperlink.verifyConnection(node, { deep: true, serviceKey, contractHash })
and by default-on addressed Hyperlink.client verify (F4).
export class class ContractMismatchclass ContractMismatch {
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;
node: string;
url: string;
serviceKey: string;
expected: string;
actual: string | undefined;
}
Client and server disagree on a HyperService's wire contract (contractHash mismatch).
Surfaced by
Hyperlink.verifyConnection
(node, { deep: true, serviceKey, contractHash })
and by default-on addressed
Hyperlink.client
verify (F4).
ContractMismatch 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("ContractMismatch")<{
readonly node: stringnode: string;
readonly url: stringurl: string;
readonly serviceKey: stringserviceKey: string;
readonly expected: stringexpected: string;
readonly actual: string | undefinedactual: string | undefined;
}> {
override get ContractMismatch.message: stringmessage() {
const const got: stringgot = this.actual: string | undefinedactual === var undefinedundefined ? "(missing)" : this.actual: stringactual;
return (
`Node "${this.node: stringnode}" at ${this.url: stringurl} serves "${this.serviceKey: stringserviceKey}" with contract ` +
`${const got: stringgot}, but this client expects ${this.expected: stringexpected} — redeploy the stale side.`
);
}
}