From 54ad09e65b16e16c1b547d373962c0569b23a6b5 Mon Sep 17 00:00:00 2001 From: Dominic Kramer Date: Wed, 17 May 2017 01:30:29 -0700 Subject: [PATCH 1/3] error-reporting: Fix README typos showing usage --- packages/error-reporting/README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/packages/error-reporting/README.md b/packages/error-reporting/README.md index 38cc7649694..bae3219a622 100644 --- a/packages/error-reporting/README.md +++ b/packages/error-reporting/README.md @@ -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')); @@ -199,7 +199,7 @@ server.route({ } }); -server.register({ register: errors.hapi }); +server.register(errors.hapi); ``` ### Using Koa @@ -207,18 +207,18 @@ server.register({ register: errors.hapi }); ```js 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); @@ -227,20 +227,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/ From a738e57b5671db2cf2db29705084de62a8dfd1e5 Mon Sep 17 00:00:00 2001 From: Dominic Kramer Date: Wed, 17 May 2017 09:28:29 -0700 Subject: [PATCH 2/3] Use Koa instead of koa since it is a constructor --- packages/error-reporting/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/error-reporting/README.md b/packages/error-reporting/README.md index bae3219a622..f1071a9dafc 100644 --- a/packages/error-reporting/README.md +++ b/packages/error-reporting/README.md @@ -206,8 +206,8 @@ server.register(errors.hapi); ```js var errors = require('@google-cloud/error-reporting')(); -var koa = require('koa'); -var app = new koa(); +var Koa = require('koa'); +var app = new Koa(); app.use(errors.koa); From e54d108e9fc2ea038a2e30043ee7eda0636eba05 Mon Sep 17 00:00:00 2001 From: Dominic Kramer Date: Thu, 18 May 2017 16:02:05 -0700 Subject: [PATCH 3/3] Address a GitHub comment --- packages/error-reporting/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/packages/error-reporting/README.md b/packages/error-reporting/README.md index f1071a9dafc..7bfbb6ba4aa 100644 --- a/packages/error-reporting/README.md +++ b/packages/error-reporting/README.md @@ -205,8 +205,9 @@ server.register(errors.hapi); ### Using Koa ```js -var errors = require('@google-cloud/error-reporting')(); var Koa = require('koa'); +var errors = require('@google-cloud/error-reporting')(); + var app = new Koa(); app.use(errors.koa);