Optional
message: stringThe error message.
Optional
options: { cause?: unknown }Readonly
isReadonly
isOptional
causeReadonly
[Readonly
[Readonly
[Readonly
[Static
Readonly
TypeStatic
Readonly
EncodedStatic
Readonly
ContextStatic
Readonly
[Static
Readonly
astStatic
Readonly
fieldsStatic
Readonly
identifierStatic
Readonly
_Readonly
_Optional
stackStatic
retryableOptional
options: { isInternal?: boolean; cause?: unknown }Static
nonOptional
options: { isInternal?: boolean; cause?: unknown }Static
pipeStatic
makeStatic
annotationsMerges a set of new annotations with existing ones, potentially overwriting any duplicates.
Static
extendimport { Schema } from "effect"
class MyClass extends Schema.Class<MyClass>("MyClass")({
myField: Schema.String
}) {
myMethod() {
return this.myField + "my"
}
}
class NextClass extends MyClass.extend<NextClass>("NextClass")({
nextField: Schema.Number
}) {
nextMethod() {
return this.myMethod() + this.myField + this.nextField
}
}
Static
transformimport { Effect, Schema } from "effect"
class MyClass extends Schema.Class<MyClass>("MyClass")({
myField: Schema.String
}) {
myMethod() {
return this.myField + "my"
}
}
class NextClass extends MyClass.transformOrFail<NextClass>("NextClass")({
nextField: Schema.Number
}, {
decode: (i) =>
Effect.succeed({
myField: i.myField,
nextField: i.myField.length
}),
encode: (a) => Effect.succeed({ myField: a.myField })
}) {
nextMethod() {
return this.myMethod() + this.myField + this.nextField
}
}
Static
transformimport { Effect, Schema } from "effect"
class MyClass extends Schema.Class<MyClass>("MyClass")({
myField: Schema.String
}) {
myMethod() {
return this.myField + "my"
}
}
class NextClass extends MyClass.transformOrFailFrom<NextClass>("NextClass")({
nextField: Schema.Number
}, {
decode: (i) =>
Effect.succeed({
myField: i.myField,
nextField: i.myField.length
}),
encode: (a) => Effect.succeed({ myField: a.myField })
}) {
nextMethod() {
return this.myMethod() + this.myField + this.nextField
}
}
Error for task timeout scenarios, automatically retryable by default.
When thrown from within a task's run function, this marks the task execution as
timed_out
rather thanfailed
. Timeout errors are retryable by default since timeouts are often transient.Automatic vs Manual Timeouts
timeoutMs
is exceededExample