mirror/pnpm
1
0
Fork 0
mirror of https://github.com/pnpm/pnpm.git synced 2026-05-02 21:16:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs(readme): add API section

Browse Source
This commit is contained in:
zkochan
2017-07-15 19:41:11 +03:00
parent 2088bcdce3
commit bd2d008c1b
1 changed files with 27 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -37,6 +37,33 @@ pnpmList(__dirname, {depth: 2})
```
<!--/@-->
## API
### default: `list(path, [opts]): Promise<string>`
Returns a string output similar to the `npm ls` but for [pnpm](github.com/pnpm/pnpm).
### Arguments
* `path` - *String* - path to the project
* `[opts.depth]` - *number* - `0` by default. Max display depth of the dependency tree.
* `[opts.only]` - *dev | prod* - `null` by default. Display only the dependency tree for packages in `devDependencies` or `dependencies`.
* `[opts.long]` - *Boolean* - `false` by default. If true, show extended information.
* `[opts.parseable]` - *Boolean* - `false` by default. Show parseable output instead of tree view.
### `forPackages(packages, path, [opts]): Promise<string>`
Returns a string output similar to the `npm ls [<@scope>/]<pkg> ...` but for [pnpm](github.com/pnpm/pnpm).
### Arguments
* `packages` - *String[]* - an array of `name@version-range` identifiers, which will limit the results to only the paths to the packages named.
* `path` - *String* - path to the project
* `[opts.depth]` - *number* - `0` by default. Max display depth of the dependency tree.
* `[opts.only]` - *dev | prod* - `null` by default. Display only the dependency tree for packages in `devDependencies` or `dependencies`.
* `[opts.long]` - *Boolean* - `false` by default. If true, show extended information.
* `[opts.parseable]` - *Boolean* - `false` by default. Show parseable output instead of tree view.
## License
[MIT](./LICENSE) © [Zoltan Kochan](https://www.kochan.io/)