Skip to content

Commit

Permalink
run verb to generate README documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
doowb committed Jan 20, 2021
1 parent 45e7325 commit eb3a173
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ os:
language: node_js
node_js:
- node
- '14'
- '12'
- '10'
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ repo.prop('author')

## Registry queries

### [View](lib/view.js#L20)
### [View](lib/view.js#L21)

View constructor. Create an instance of a view associated with a couchdb view in the npm registry.

Expand All @@ -261,7 +261,7 @@ View constructor. Create an instance of a view associated with a couchdb view in
const view = new View('dependedUpon');
```

### [.query](lib/view.js#L43)
### [.query](lib/view.js#L44)

Query the couchdb view with the provided parameters.

Expand All @@ -280,7 +280,7 @@ let results = await view.query({
});
```

### [.stream](lib/view.js#L85)
### [.stream](lib/view.js#L89)

Query the couchdb view with the provided parameters and return a stream of results.

Expand All @@ -302,7 +302,7 @@ view.stream({
});
```

### [.url](lib/view.js#L99)
### [.url](lib/view.js#L109)

Build a formatted url with the provided parameters.

Expand All @@ -311,7 +311,7 @@ Build a formatted url with the provided parameters.
* `query` **{Object}**: URL query parameters.
* `returns` **{String}**: formatted url string

### [List](lib/list.js#L21)
### [List](lib/list.js#L22)

List constructor. Create an instance of a list associated with a couchdb list in the npm registry.

Expand All @@ -327,7 +327,7 @@ List constructor. Create an instance of a list associated with a couchdb list in
let list = new List('dependedUpon', view);
```

### [.query](lib/list.js#L41)
### [.query](lib/list.js#L42)

Query the couchdb list with the provided parameters.

Expand All @@ -342,7 +342,7 @@ Query the couchdb list with the provided parameters.
let results = await list.query({ key: JSON.stringify(['micromatch']) })
```

### [.url](lib/list.js#L65)
### [.url](lib/list.js#L59)

Build a formatted url with the provided parameters.

Expand Down Expand Up @@ -397,8 +397,9 @@ You might also be interested in these projects:

| **Commits** | **Contributor** |
| --- | --- |
| 113 | [doowb](https://github.com/doowb) |
| 115 | [doowb](https://github.com/doowb) |
| 1 | [0xflotus](https://github.com/0xflotus) |
| 1 | [Hypnosphi](https://github.com/Hypnosphi) |
| 1 | [NachmanBerkowitz](https://github.com/NachmanBerkowitz) |

### Author
Expand All @@ -411,9 +412,9 @@ You might also be interested in these projects:

### License

Copyright © 2019, [Brian Woodward](https://github.com/doowb).
Copyright © 2021, [Brian Woodward](https://github.com/doowb).
Released under the [MIT License](LICENSE).

***

_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on June 19, 2019._
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on January 20, 2021._
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@
"mocha": "^6.1.4"
},
"dependencies": {
"JSONStream": "^1.3.5",
"clone-deep": "^4.0.1",
"download-stats": "^0.3.4",
"JSONStream": "^1.3.5",
"moment": "^2.24.0",
"node-fetch": "^2.6.0",
"paged-request": "^2.0.1"
Expand Down

0 comments on commit eb3a173

Please sign in to comment.