Giter VIP home page Giter VIP logo

faulty's Introduction

faulty

A utility function to create custom error objects in Javascript.

Installation

Install via npm:

% npm install faulty

Usage

var createError = require('faulty');
// => [Function]

var MyError = createError('MyError');
// => [Function: MyError]

MyError.name
// => 'MyError'

var err = new MyError('something bad has just happened');
// => [MyError: something bad has just happened]

err instanceof Error
// => true

err instanceof MyError
// => true

err.name
// => 'MyError'

err.message
// => 'something bad has just happened'

err.stack
// => 'MyError: something bas has just happened\n  at <...stack trace...>'

var err2 = new MyError('another error', { foo: 'bar', baz: 123 });
// => [MyError: another error]

err2.foo
// => 'bar'

err2.baz
// => 'baz'

var WrappedError = createError('WrappedError', function(message, originalError) {
  this.originalError = originalError;
});

var err3 = new WrappedError('see second arg', new Error('foo'))
// => [WrappedError: see second arg]

err3.originalError
// => [Error: foo]

Contributing

Here's a quick guide:

  1. Fork the repo and make install.

  2. Run the tests. We only take pull requests with passing tests, and it's great to know that you have a clean slate: make test.

  3. Add a test for your change. Only refactoring and documentation changes require no new tests. If you are adding functionality or are fixing a bug, we need a test!

  4. Make the test pass.

  5. Push to your fork and submit a pull request.

Licence

Released under The MIT License.

faulty's People

Contributors

martinandert avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.