Skip to content

Commit

Permalink
docs - remaining instances of var and imports (#7)
Browse files Browse the repository at this point in the history
* docs - remaining instances of var and imports

* docs - revert extraneous apostrophes
  • Loading branch information
twhitbeck authored and niftylettuce committed Jul 2, 2019
1 parent 6bba79f commit 87f56cb
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 30 deletions.
28 changes: 14 additions & 14 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,11 @@ Create a new router.
Basic usage:

```javascript
var Koa = require('koa');
var Router = require('koa-router');
const Koa = require('koa');
const Router = require('@koa/router');

var app = new Koa();
var router = new Router();
const app = new Koa();
const router = new Router();

router.get('/', (ctx, next) => {
// ctx.router available
Expand Down Expand Up @@ -244,11 +244,11 @@ with `405 Method Not Allowed` and `501 Not Implemented` as appropriate.

**Example**
```javascript
var Koa = require('koa');
var Router = require('koa-router');
const Koa = require('koa');
const Router = require('@koa/router');

var app = new Koa();
var router = new Router();
const app = new Koa();
const router = new Router();

app.use(router.routes());
app.use(router.allowedMethods());
Expand All @@ -257,12 +257,12 @@ app.use(router.allowedMethods());
**Example with [Boom](https://github.com/hapijs/boom)**

```javascript
var Koa = require('koa');
var Router = require('koa-router');
var Boom = require('boom');
const Koa = require('koa');
const Router = require('@koa/router');
const Boom = require('boom');

var app = new Koa();
var router = new Router();
const app = new Koa();
const router = new Router();

app.use(router.routes());
app.use(router.allowedMethods({
Expand Down Expand Up @@ -393,6 +393,6 @@ Generate URL from url pattern and given `params`.

**Example**
```javascript
var url = Router.url('/users/:id', {id: 1});
const url = Router.url('/users/:id', {id: 1});
// => "/users/1"
```
2 changes: 1 addition & 1 deletion lib/layer.js
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Layer.prototype.captures = function (path) {
* @example
*
* ```javascript
* var route = new Layer(['GET'], '/users/:id', fn);
* const route = new Layer(['GET'], '/users/:id', fn);
*
* route.url({ id: 123 }); // => "/users/123"
* ```
Expand Down
30 changes: 15 additions & 15 deletions lib/router.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ module.exports = Router;
* .use(router.allowedMethods());
* ```
*
* @alias module:@koa/router
* @alias module:koa-router
* @param {Object=} opts
* @param {String=} opts.prefix prefix router paths
* @constructor
Expand Down Expand Up @@ -141,8 +141,8 @@ function Router(opts) {
* Nesting routers is supported:
*
* ```javascript
* var forums = new Router();
* var posts = new Router();
* const forums = new Router();
* const posts = new Router();
*
* posts.get('/', (ctx, next) => {...});
* posts.get('/:pid', (ctx, next) => {...});
Expand All @@ -157,7 +157,7 @@ function Router(opts) {
* Route paths can be prefixed at the router level:
*
* ```javascript
* var router = new Router({
* const router = new Router({
* prefix: '/users'
* });
*
Expand All @@ -180,7 +180,7 @@ function Router(opts) {
* used to convert paths to regular expressions.
*
* @name get|put|post|patch|delete|del
* @memberof module:koa-router.prototype
* @memberof module:@koa-router.prototype
* @param {String} path
* @param {Function=} middleware route middleware(s)
* @param {Function} callback route callback
Expand Down Expand Up @@ -364,11 +364,11 @@ Router.prototype.routes = Router.prototype.middleware = function () {
* @example
*
* ```javascript
* var Koa = require('koa');
* var Router = require('koa-router');
* const Koa = require('koa');
* const Router = require('@koa/router');
*
* var app = new Koa();
* var router = new Router();
* const app = new Koa();
* const router = new Router();
*
* app.use(router.routes());
* app.use(router.allowedMethods());
Expand All @@ -377,12 +377,12 @@ Router.prototype.routes = Router.prototype.middleware = function () {
* **Example with [Boom](https://github.com/hapijs/boom)**
*
* ```javascript
* var Koa = require('koa');
* var Router = require('koa-router');
* var Boom = require('boom');
* const Koa = require('koa');
* const Router = require('@koa/router');
* const Boom = require('boom');
*
* var app = new Koa();
* var router = new Router();
* const app = new Koa();
* const router = new Router();
*
* app.use(router.routes());
* app.use(router.allowedMethods({
Expand Down Expand Up @@ -719,7 +719,7 @@ Router.prototype.param = function (param, middleware) {
* @example
*
* ```javascript
* var url = Router.url('/users/:id', {id: 1});
* const url = Router.url('/users/:id', {id: 1});
* // => "/users/1"
* ```
*
Expand Down

0 comments on commit 87f56cb

Please sign in to comment.