Skip to content

error-reporting: Fix README typos showing usage #2316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephenplusplus merged 3 commits into from
May 19, 2017
Merged

error-reporting: Fix README typos showing usage #2316

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54ad09e
error-reporting: Fix README typos showing usage
DominicKramer May 17, 2017
a738e57
Use Koa instead of koa since it is a constructor
DominicKramer May 17, 2017
e54d108
Address a GitHub comment
DominicKramer May 18, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions packages/error-reporting/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,10 +162,10 @@ errors.report('My error message');

```js
var express = require('express');
var app = express();
// Will create an errors instance based off env variables
var errors = require('@google-cloud/error-reporting')();

var app = express();

app.get('/error', (req, res, next) => {
res.send('Something broke!');
next(new Error('Custom error message'));
Expand Down Expand Up @@ -199,26 +199,27 @@ server.route({
}
});

server.register({ register: errors.hapi });
server.register(errors.hapi);
```

### Using Koa

```js
var Koa = require('koa');
var errors = require('@google-cloud/error-reporting')();
var koa = require('koa');
var app = koa();

var app = new Koa();

app.use(errors.koa);

app.use(function *(next) {
//This will set status and message
this.throw('Error Message', 500);
//This will set status and message
this.throw('Error Message', 500);
});

// response
app.use(function *(){
this.body = 'Hello World';
this.body = 'Hello World';
});

app.listen(3000);
Expand All @@ -227,20 +228,20 @@ app.listen(3000);
### Using Restify

```js
var restify = require('restify');
var errors = require('@google-cloud/error-reporting')();

function respond(req, res, next) {
next(new Error('this is a restify error'));
}

var restify = require('restify');
var errors = require('@google-cloud/error-reporting')();

var server = restify.createServer();

server.use(errors.restify(server));
server.get('/hello/:name', respond);
server.head('/hello/:name', respond);

server.listen(8080);
server.listen(3000);
```

[gcloud-sdk]: https://cloud.google.com/sdk/gcloud/
Expand Down