https://github.com/bigpipe/500-pagelet
Default 500 Pagelet used if anything fails in BigPipe
https://github.com/bigpipe/500-pagelet
Last synced: about 1 year ago
JSON representation
Default 500 Pagelet used if anything fails in BigPipe
- Host: GitHub
- URL: https://github.com/bigpipe/500-pagelet
- Owner: bigpipe
- License: mit
- Created: 2014-12-24T10:01:40.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-10-26T13:42:21.000Z (over 5 years ago)
- Last Synced: 2025-03-18T07:22:50.357Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 500 Pagelet
[![Version npm][version]](http://browsenpm.org/package/500-pagelet)[![Build Status][build]](https://travis-ci.org/bigpipe/500-pagelet)[![Dependencies][david]](https://david-dm.org/bigpipe/500-pagelet)[![Coverage Status][cover]](https://coveralls.io/r/bigpipe/500-pagelet?branch=master)
[version]: http://img.shields.io/npm/v/500-pagelet.svg?style=flat-square
[build]: http://img.shields.io/travis/bigpipe/500-pagelet/master.svg?style=flat-square
[david]: https://img.shields.io/david/bigpipe/500-pagelet.svg?style=flat-square
[cover]: http://img.shields.io/coveralls/bigpipe/500-pagelet/master.svg?style=flat-square
This Pagelet is responsible for displaying server errors. By
default the 500 Pagelet is provided with BigPipe. However, if you
need a custom 500 you can extend this Pagelet. For example to change
the default view.
## Installation
The 500 Pagelet is distributed through the node package manager (npm).
```
npm install --save 500-pagelet
```
## Support
Create an issue. Every question you have is a bug in our
documentation and that should be corrected. So please, don't hesitate to create
issues, many of them.
### Example
In this example the 500 Pagelet is extended with a custom view.
BigPipe will automatically discover this extended version
if it is provided to BigPipe alongside the other pagelets.
Note that the enviroment variable can be overruled to manage the
data that is displayed.
```js
'use strict';
//
// Extend the 500 Pagelet with a custom view.
//
var Fivehundred = require('500-pagelet').extend({
view: '/path/to/my/custom-view.html', // your custom layout
env: 'development' // defaults to process.env.NODE_ENV
});
//
// Initialise BigPipe server.
//
var pipe = require('bigpipe').createServer(2000, {
pagelets: [ Fivehundred, ... ]
});
```
### API
The following methods are available on the 500 Pagelet instance. Most are
only used internally. There is rarely a reason to call these methods.
#### new Fivehundred()
**public**, _returns Pagelet_.
The 500 constructor expects several options to be provided, these
include: `req`, `res` and `pipe`. The last option is a reference
to the [BigPipe] instance, mainly to ensure the same [Temper]
instance is re-used. All code examples assume your file is setup as:
```js
'use strict';
var Fivehundred = require('500-pagelet');
, fivehundred = new Fivehundred({ options }, new Error('failure'));
```
#### Bootstrap.get()
**private**, _returns Pagelet_.
Extracts the data from the provided Error to render the template.
If the environment is _production_ the `Error.stack` will not be
provided to the template.
```js
fivehundred.get(function render(error, data) {
// provide data to pagelet.render
});
```
## Debugging
The library makes use the `diagnostics` module from Pagelet.
To display the 500 Pagelet specific debug messages, supply the
following before running the program or
```bash
DEBUG=pagelet:500 node ...
```
## Testing
Tests are automatically run on [Travis CI] to ensure that everything is
functioning as intended. For local development we automatically install a
[pre-commit] hook that runs the `npm test` command every time you commit changes.
This ensures that we don't push any broken code in to this project.
To run tests locally, make sure the development dependencies are installed.
```bash
npm test
npm run coverage
```
## License
500-pagelet is released under MIT.
[Travis CI]: http://travisci.org
[Temper]: http://github.com/bigpipe/temper
[pre-commit]: http://github.com/observing/pre-commit