RiffleError

Defined in: errors.ts:34

Thrown by createRiffle and its returned instance for an invalid option or a call after destroy(). Branch on code, never on message: messages are not part of the API and may change between versions.

Example

import { createRiffle, RiffleError } from '@rpxl/riffle'

try {
  createRiffle(el, { count: -1 })
} catch (error) {
  if (error instanceof RiffleError && error.code === 'INVALID_COUNT') {
    // count must be a non-negative integer
  }
}

Extends

• Error

Constructors

Constructor

new RiffleError(code, message, recoverable?): RiffleError

Defined in: errors.ts:40

Parameters

code

RiffleErrorCode

message

string

recoverable?

boolean = false

Returns

RiffleError

Overrides

Error.constructor

Properties

code

readonly code: RiffleErrorCode

Defined in: errors.ts:36

Which validation failed. Branch on this, never on message.

---

recoverable

readonly recoverable: boolean

Defined in: errors.ts:38

Reserved for future use; always false today.