@blackglory/errors

Common errors.

Usage no npm install needed!

<script type="module">
  import blackgloryErrors from 'https://cdn.skypack.dev/@blackglory/errors';
</script>

README

errors

Common errors.

Install

npm install --save @blackglory/errors
# or
yarn add @blackglory/errors

API

type CustomErrorConstructor<T extends CustomError = CustomError> =
  new (message?: string) => T

interface SerializableError {
  name: string
  message: string
  stack: string | null
  ancestors: string[]
}

CustomError

class CustomError extends Error {}

CustomError has better default behaviors than Error:

  • console.error prints the correct exception name, not Error.
  • instanceof operator matches based on names rather than inheritance relationships, which helps SerializableError instanceof CustomError.

AssertionError

class AssertionError extends CustomError {}

normalize

function normalize(err: Error): SerializableError

hydrate

function hydrate(err: SerializableError): Error

isSerializableError

function isSerializableError(val: unknown): val is SerializableError

assert

/**
 * @throws {AssertionError}
 */
function assert(condition: unknown, message: string): asserts condition

getErrorNames

function getErrorNames(err: Error | SerializableError): Iterable<string>

traverseErrorPrototypeChain

function traverseErrorPrototypeChain(err: Error): Iterable<Error>