Nostalgic Perogi Monogramming

    @arrows/error
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.2 • Public • Published

    @arrows/error

    npm (scoped) CircleCI David (path) Codecov npm bundle size (scoped) GitHub

    Table of contents

    1. Introduction
    2. Installation
    3. API reference
    4. License

    Introduction

    The library contains a set of helper functions for error handling.

    The library has built-in type definitions, which provide an excellent IDE support.

    Installation

    Via NPM:

    npm i @arrows/error

    Via Yarn:

    yarn add @arrows/error

    API reference

    createErrorClass

    Creates custom error class that returns extended error object that can be serialized to JSON.

    Parameters

    • name - The error name (should be the same as the name of the variable to which the class is assigned)
    • message - Error message
    • serializeStacktrace An optional boolean flag, to indicate weather a stacktrace should be serialized (default: false)

    Returns

    • Returns custom error class that takes one optional argument - error details

    Interface

    (name , message, serializeStacktrace?) => custom_error_class
    

    Examples

    Create a custom error class:

    const MyError = createErrorClass('MyError', 'some message')

    Create a custom error class with serializable stacktrace:

    const MyError = createErrorClass('MyError', 'some message', true)

    License

    Project is under open, non-restrictive ISC license.

    Install

    npm i @arrows/error

    DownloadsWeekly Downloads

    7,510

    Version

    1.0.2

    License

    ISC

    Unpacked Size

    8.57 kB

    Total Files

    16

    Last publish

    Collaborators

    • caderek