https://github.com/karimsa/trashcan
safe error handling in production environments
https://github.com/karimsa/trashcan
Last synced: 3 months ago
JSON representation
safe error handling in production environments
- Host: GitHub
- URL: https://github.com/karimsa/trashcan
- Owner: karimsa
- Created: 2015-04-23T21:28:18.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-06-04T16:50:08.000Z (about 9 years ago)
- Last Synced: 2025-03-11T21:03:58.607Z (3 months ago)
- Language: JavaScript
- Size: 370 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Trashcan
Safe error handling in production mode.
[](https://nodei.co/npm/trashcan/)
## Usage
Install via npm (`npm install --save trashcan`) and then take advantage of the API to catch and handle errors.
## Table of Contents
Aside from the auto-catching `uncaughtException` events on `process`, trashcan is useful for making sure the exception doesn't get that far.
Use it in your code to not worry about errors in every callback you make.
*Unless otherwise specified, all trashcan methods should be chainable. So you can do a lot of error handling at once, if you wish. For a more
detailed spec, see [the github page](https://ohdb.github.io/trashcan).*
- [Error Handling](#error-handling)
- [Asynchronous Callback Errors](#asynchronous-callbacks)
- [Synchronous Errors](#synchronous-errors)
- [Error Events](#error-events)
- [Promise Rejections](#promise-rejections)
- [Custom Errors](#custom-errors)
### Error Handling
```javascript
var tc = require('trashcan')
// handle the errors manually
tc.on('error', function (err) {
// do stuff with the error
})
// or auto-email the admin
tc.on('error', tc.notify('[email protected]'))
// or to a server log
tc.on('error', tc.log('./server.log'))
```
*tc.notify() uses nodemailer in the background, and can either be passed nodemailer transport configuration as the second argument or that
configuration can be saved into a file called `.mailrc` in your project folder.*
### Asynchronous Callback Errors
```javascript
var tc = require('trashcan')
, fs = require('fs')
fs.readFile('./my-file.txt', 'utf8', tc(function (data) {
// handle file data
}))
```
### Synchronous Errors
```javascript
var tc = require('trashcan')
, fs = require('fs')
tc(function () {
var data = fs.readFileSync('./my-file.txt', 'utf8')
// handle file data
}).exec(function (err) {
// optional error handler
// (error will be thrown through trashcan
// before this function is called)
})
```
### Error Events
```javascript
var tc = require('trashcan')
, http = require('http').Server(function () { /* server logic */ })
// grab all errors from the server
tc.catch(http)
```
### Promise Rejections
```javascript
var tc = require('trashcan')
// grab your promise, however
var promise = require('q').defer()
// pass it forwards
tc.swear(promise, function ( /* arguments */ ) {
// handle success
})
```
### Custom Errors
```javascript
var tc = require('trashcan')
// throw the error manually
tc.throw(trash)
```
## License
GPLv3.
```
trashcan: safe error handling in production mode.
Copyright (C) 2015 Online Health Database
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
```