diff options
Diffstat (limited to 'node_modules/libnpmsearch/README.md')
| -rw-r--r-- | node_modules/libnpmsearch/README.md | 26 |
1 files changed, 15 insertions, 11 deletions
diff --git a/node_modules/libnpmsearch/README.md b/node_modules/libnpmsearch/README.md index a83988cc2..31f44fe24 100644 --- a/node_modules/libnpmsearch/README.md +++ b/node_modules/libnpmsearch/README.md @@ -1,9 +1,23 @@ -# libnpmsearch [](https://npm.im/libnpmsearch) [](https://npm.im/libnpmsearch) [](https://travis-ci.org/npm/libnpmsearch) [](https://ci.appveyor.com/project/zkat/libnpmsearch) [](https://coveralls.io/github/npm/libnpmsearch?branch=latest) +# libnpmsearch + +[](https://npm.im/libnpmsearch) +[](https://npm.im/libnpmsearch) +[](https://coveralls.io/github/npm/libnpmsearch?branch=latest) [`libnpmsearch`](https://github.com/npm/libnpmsearch) is a Node.js library for programmatically accessing the npm search endpoint. It does **not** support legacy search through `/-/all`. +## Table of Contents + +* [Example](#example) +* [Install](#install) +* [Contributing](#contributing) +* [API](#api) + * [search opts](#opts) + * [`search()`](#search) + * [`search.stream()`](#search-stream) + ## Example ```js @@ -30,15 +44,6 @@ console.log(await search('libnpm')) `$ npm install libnpmsearch` -## Table of Contents - -* [Example](#example) -* [Install](#install) -* [API](#api) - * [search opts](#opts) - * [`search()`](#search) - * [`search.stream()`](#search-stream) - ### API #### <a name="opts"></a> `opts` for `libnpmsearch` commands @@ -62,7 +67,6 @@ for options that can be passed in. A couple of options of note for those in a hurry: * `opts.token` - can be passed in and will be used as the authentication token for the registry. For other ways to pass in auth details, see the n-r-f docs. -* `opts.Promise` - If you pass this in, the Promises returned by `libnpmsearch` commands will use this Promise class instead. For example: `{Promise: require('bluebird')}` #### <a name="search"></a> `> search(query, [opts]) -> Promise` |