From 626e6267ae4814253741680466d593dc9132edf4 Mon Sep 17 00:00:00 2001 From: Tim Alby Date: Fri, 5 Jul 2019 15:50:58 +0200 Subject: [PATCH] update README with OError naming --- libraries/o-error/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/libraries/o-error/README.md b/libraries/o-error/README.md index 0024deed40..fe179b2749 100644 --- a/libraries/o-error/README.md +++ b/libraries/o-error/README.md @@ -8,17 +8,17 @@ Make custom error types that: ## For ES6 -ES6 classes make it easy to define custom errors by subclassing `Error`. Subclassing `errorType.Error` adds a few extra helpers. +ES6 classes make it easy to define custom errors by subclassing `Error`. Subclassing `OErrors.OError` adds a few extra helpers. ### Usage #### Throw an error directly ```js -const errorType = require('overleaf-error-type') +const OErrors = require('overleaf-error-type') function doSomethingBad () { - throw new errorType.Error({ + throw new OErrors.OError({ message: 'did something bad', info: { thing: 'foo' } }) @@ -34,7 +34,7 @@ doSomethingBad() #### Custom error class ```js -class FooError extends errorType.Error { +class FooError extends OErrors.OError { constructor (options) { super({ message: 'failed to foo', ...options }) } @@ -77,7 +77,7 @@ doFoo2() try { doFoo2() } catch (err) { - console.log(errorType.getFullStack(err)) + console.log(OErrors.getFullStack(err)) } // => // FooError: failed to foo: bad