Skip to content

Rulvar API reference


Rulvar API reference / @rulvar/rulvar / RulvarError

Abstract Class: RulvarError ​

Defined in: packages/core/dist/index.d.ts

Base class for all engine-raised errors. "Retryable" means the engine's own retry machinery (RetryPolicy under the journal) MAY retry; it never means a provider SDK autoretry, which is disabled.

Extends ​

  • Error

Extended by ​

Constructors ​

Constructor ​

ts
new RulvarError(message, opts?): RulvarError;

Defined in: packages/core/dist/index.d.ts

Parameters ​

ParameterType
messagestring
opts?{ cause?: unknown; data?: Json; retryable?: boolean; }
opts.cause?unknown
opts.data?Json
opts.retryable?boolean

Returns ​

RulvarError

Overrides ​

ts
Error.constructor

Properties ​

PropertyModifierTypeDefined in
codeabstractErrorCodepackages/core/dist/index.d.ts
data?readonlyJsonpackages/core/dist/index.d.ts
retryablereadonlybooleanpackages/core/dist/index.d.ts

Methods ​

toWire() ​

ts
toWire(): WireError;

Defined in: packages/core/dist/index.d.ts

Returns ​

WireError