npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

throwable-error

v0.1.1

Published

Efficient multi-inheritant Error objects

Downloads

12

Readme

throwable-error

NPM

🧨 Efficient, multi-inheritant, dynamically-generated, Error pseudo-classes with instanceof super-powers.

This project is written in Typescript but can be used both as an ES module or CJS module.

Notice

This project is in beta stage, major API modifications and simplifications are very likely to occur in upcoming major releases.

Install

npm install --save throwable-error

Usage

Main concept.

  • Errors are generally defined in the main scope of the application.
  • You can use the getThrowableError method to generate a pseudo-class by providing an errorName and a mapperFunction.
  • The mapperFunction basically receives the new Error constructor arguments and returns them with the proper internal object structure the Error will have: The "inner" constructor of this library will incorporate returned values as properties in the new generated Error pseudo-class.

getThrowableError

Function getThrowableError(name, { mapperFn?, extendFrom? })

Get an efficient, multi-inheritant, dynamically-generated, Error pseudo-class with instanceof super-powers.

Parameters

| Name | Type | Description | | :----------- | :------------------------- | :--------------------------------------------- | | name | string | Class name. | | mapperFn | MapperFunctionType<any> | Mapper function for the constructor arguments. | | extendFrom | ExtendFromType<any> | Class to extend from. |

Returns

The new Error pseudo-class with type ThrowableErrorConstructor<A, ThrowableError>

Type parameters

| Name | Type | Description | | :--- | :------------------------------------------------------------------------------- | :--------------------- | | A | A: ThrowableErrorConstructorArguments = ThrowableErrorConstructorArguments | Constructor arguments. |

Examples

Note: The ThrowableErrorConstructorArguments type already includes the originalError property on its declaration.

Simple example:

const WebSocketError = getThrowableError(
  'WebSocketError',
  (userMessage: string, details?: { originalError?: Error }) => ({
    userMessage,
    originalError: details?.originalError || undefined,
  }),
);

Inheritant example (new error extending from WebSocketError in previous example:

const WebSocketJSONError = getThrowableError<
  'WebSocketJSONError',
  ThrowableErrorConstructorArguments & [string, { data: any }]
  >(
    'WebSocketJSONError',
    (userMessage: string, details?: { originalError?: Error; data?: any }) => ({
      userMessage,
      originalError: details?.originalError || undefined,
      data: details?.data || undefined,
    }),
   WebSocketError,
  );

Throwing these errors is straightforward

throw new WebSocketError('Unable to connect');

throw new WebSocketError('Unable to connect', {
  originalError: new Error('test'),
});

throw new WebSocketJSONError('Unable to parse content');

throw new WebSocketJSONError('Unable to parse content', {
  originalError: new Error('test'),
});

throw new WebSocketJSONError('Unable to parse content', {
  data: '1234errorjsoncontent',
  originalError: new Error('test'),
});

Instanceof properties:

import {ThrowableError} from 'throwable-error';

const testErr = new WebSocketJSONError('test');

console.log(testErr instanceof WebSocketJSONError); # true
console.log(testErr instanceof WebSocketError); # true
console.log(testErr instanceof ThrowableError); # true