LaminaError

The one error class of @laminapdf/sdk (ADR 0026 §7). message, hint and didYouMean never hold document text (ADR 0026 §4); that goes in data, marked untrusted on the code’s page at docsUrl.

Example

try {
  Document.open(bytes, { password: "secret" });
} catch (e) {
  if (isLaminaError(e, "wrong-password")) askAgain();
  else throw e;
}

Extends

• Error

Type Parameters

C

C extends ErrorCode = ErrorCode

Constructors

Constructor

new LaminaError<C>(diagnostic, options?): LaminaError<C>

Parameters

diagnostic

Diagnostic<C>

the ADR 0026 §1 object.

options?

cause, when wrapping another error.

cause?

unknown

Returns

LaminaError<C>

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown

Inherited from

Error.cause

---

code

readonly code: C

The stable code (fixtures/codes.json).

---

data?

readonly optional data?: Readonly<Record<string, unknown>>

Code-specific fields, documented on the code’s page (the only place document text appears).

---

didYouMean?

readonly optional didYouMean?: readonly string[]

For usage errors: the closest known names (lamina’s own vocabulary).

---

docsUrl

readonly docsUrl: string

The code’s page.

---

hint?

readonly optional hint?: string

One actionable sentence for this code.

---

kind

readonly kind: ErrorKind

What the caller can do about it.

---

location?

readonly optional location?: Location

Where in the input or the document.

---

message

message: string

Inherited from

Error.message

---

name

readonly name: "LaminaError" = "LaminaError"

Overrides

Error.name

---

stack?

optional stack?: string

Inherited from

Error.stack

Accessors

ranges

Get Signature

get ranges(): readonly object[] | undefined

For data-pending: the byte ranges a range document needs fetched before the call can succeed (data.ranges); undefined for other codes. Document.ensure fetches them.

Returns

readonly object[] | undefined

Methods

toJSON()

toJSON(): Diagnostic<C>

The ADR 0026 §1 object (for logs, workers and --json output); optional fields omitted.

Returns

Diagnostic<C>