Skip to content
/ nanoerror Public

Small module to create code errors with format support.

License

Notifications You must be signed in to change notification settings

geut/nanoerror

Repository files navigation

nanoerror

Build Status JavaScript Style Guide standard-readme compliant

Small module to create code errors with format support.

Install

$ npm install nanoerror

Usage

const createError = require('nanoerror')

const ERR_EXAMPLE = createError('ERR_EXAMPLE', 'An error with the args: %s %j')

try {
  throw new ERR_EXAMPLE('arg1', { somejson: true })
} catch (err) {
  console.log(err.code) // ERR_EXAMPLE
  console.log(err.message) // An error with the args: arg1 {"somejson": true}
}

API

const ERR = createError(code: string, message: string)

Creates a new nanoerror class.

err.isNanoerror => boolean

Returns true if the err is a nanoerror instance.

ERR.equals(err) => boolean

Returns true if the err belongs to a specific nanoerror class.

ERR.from(err) => ERR

Creates an error based on the options of another one.

Issues

🐛 If you found an issue we encourage you to report it on github. Please specify your OS and the actions to reproduce it.

Contributing

đŸ‘„ Ideas and contributions to the project are welcome. You must follow this guideline.

License

MIT © A GEUT project