Class RunAgainError

Raised when a function wants to yield to the scheduler to not exceed platform limits. The scheduler will re-run the function after the yield. It is assumed that the function can be retried with the same input. The function might have produced side-effects on the first run.

Hierarchy

{
    cause?: unknown;
    context: Record<string, unknown>;
    name: "RunAgainError";
    stack?: string;
    get _tag(): Name;
    get message(): string;
}
- RunAgainError

Index

Constructors

constructor

new RunAgainError(options?: BaseErrorOptions): RunAgainError
Parameters
- Optionaloptions: BaseErrorOptions
Returns RunAgainError
Inherited from BaseError.extend(RUN_AGAIN_ERROR_CODE, RUN_AGAIN_MESSAGE).constructor
- Defined in packages/common/errors/dist/types/src/base.d.ts:25

Properties

`Optional`cause

cause?: unknown

context

context: Record<string, unknown>

name

name: "RunAgainError"

`Optional`stack

stack?: string

`Static`name

name: "RunAgainError"

`Static` `Optional`prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

`Static`stackTraceLimit

stackTraceLimit: number

Accessors

_tag

get _tag(): Name
Returns Name
Inherited from BaseError.extend(RUN_AGAIN_ERROR_CODE, RUN_AGAIN_MESSAGE)._tag
- Defined in packages/common/errors/dist/types/src/base.d.ts:32

message

get message(): string
Fallback message.

Returns string
Inherited from BaseError.extend(RUN_AGAIN_ERROR_CODE, RUN_AGAIN_MESSAGE).message
- Defined in packages/common/errors/dist/types/src/base.d.ts:31

Methods

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from BaseError.extend(RUN_AGAIN_ERROR_CODE, RUN_AGAIN_MESSAGE).captureStackTrace
- Defined in packages/common/errors/dist/types/src/base.d.ts:58

`Static`extend

extend<Name extends string = string>(name: Name, message?: string): any
Type Parameters
- Name extends string = string
Parameters
- name: Name
- Optionalmessage: string
Returns any
Inherited from BaseError.extend(RUN_AGAIN_ERROR_CODE, RUN_AGAIN_MESSAGE).extend
- Defined in packages/common/errors/dist/types/src/base.d.ts:57

`Static`is

is(error: unknown): error is BaseError<string>
Name equality, not an instanceof, so an error rebuilt from the wire still matches. A subclass that renames itself therefore does NOT match its parent, so define siblings rather than a renaming subclass.
Parameters
- error: unknown
Returns error is BaseError<string>
Inherited from BaseError.extend(RUN_AGAIN_ERROR_CODE, RUN_AGAIN_MESSAGE).is
- Defined in packages/common/errors/dist/types/src/base.d.ts:41

`Static`isError

isError(error: unknown): error is Error
Parameters
- error: unknown
Returns error is Error
Inherited from BaseError.extend(RUN_AGAIN_ERROR_CODE, RUN_AGAIN_MESSAGE).isError
- Defined in packages/common/errors/dist/types/src/base.d.ts:34

`Static`wrap

wrap(
    options?: Omit<BaseErrorOptions, "cause"> & { ifTypeDiffers?: boolean },
): (
    error: unknown,
) => {
    cause?: unknown;
    context: Record<string, unknown>;
    name: "RunAgainError";
    stack?: string;
    get _tag(): Name;
    get message(): string;
}
Returns a catch/mapError callback that wraps a thrown value in this class.
Parameters
- Optionaloptions: Omit<BaseErrorOptions, "cause"> & { ifTypeDiffers?: boolean }
  - ifTypeDiffers
    Pass an error of this class through untouched.
  - OptionalifTypeDiffers?: boolean
    Pass an error of this class through untouched.
Returns (
    error: unknown,
) => {
    cause?: unknown;
    context: Record<string, unknown>;
    name: "RunAgainError";
    stack?: string;
    get _tag(): Name;
    get message(): string;
}
Inherited from BaseError.extend(RUN_AGAIN_ERROR_CODE, RUN_AGAIN_MESSAGE).wrap
- Defined in packages/common/errors/dist/types/src/base.d.ts:46

Class RunAgainError

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RunAgainError

Properties

Optionalcause

context

name

Optionalstack

Staticname

Static OptionalprepareStackTrace

StaticstackTraceLimit

Accessors

_tag

Returns Name

message

Returns string

Methods

StaticcaptureStackTrace

Parameters

Returns void

Staticextend

Type Parameters

Parameters

Returns any

Staticis

Parameters

Returns error is BaseError<string>

StaticisError

Parameters

Returns error is Error

Staticwrap

Parameters

ifTypeDiffers

OptionalifTypeDiffers?: boolean

Returns ( error: unknown,) => { cause?: unknown; context: Record<string, unknown>; name: "RunAgainError"; stack?: string; get _tag(): Name; get message(): string;}

Settings

On This Page

`Optional`cause

`Optional`stack

`Static`name

`Static` `Optional`prepareStackTrace

`Static`stackTraceLimit

`Static`captureStackTrace

`Static`extend

`Static`is

`Static`isError

`Static`wrap

`Optional`ifTypeDiffers?: boolean

Returns (
error: unknown,
) => {
cause?: unknown;
context: Record<string, unknown>;
name: "RunAgainError";
stack?: string;
get _tag(): Name;
get message(): string;
}