• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..20-Sep-2020-

CHANGELOG.mdH A D26-Oct-19852.7 KiB11449

LICENSE.mdH A D26-Oct-1985755 1713

README.mdH A D26-Oct-19852 KiB5846

package.jsonH A D20-Sep-20202.5 KiB9392

README.md

1# libnpm
2
3[`libnpm`](https://github.com/npm/libnpm) is the programmatic API for npm.
4
5For bug reports and support, please head over to [npm.community](https://npm.community).
6
7
8## Install
9
10`$ npm install libnpm`
11
12## Table of Contents
13
14* [Example](#example)
15* [Features](#features)
16* [API](#api)
17  * Fetching Packages and Their Info
18    * [`manifest`](https://www.npmjs.com/package/pacote#manifest)
19    * [`packument`](https://www.npmjs.com/package/pacote#packument)
20    * [`tarball`](https://www.npmjs.com/package/pacote#tarball)
21    * [`extract`](https://www.npmjs.com/package/pacote#extract)
22    * [`search`](https://npm.im/libnpmsearch)
23  * Package-related Registry APIs
24    * [`publish`]()
25    * [`unpublish`](#unpublish)
26    * [`access`](https://npm.im/libnpmaccess)
27  * Account-related Registry APIs
28    * [`login`](https://www.npmjs.com/package/npm-profile#login)
29    * [`adduser`](https://www.npmjs.com/package/npm-profile#adduser)
30    * [`profile`](https://npm.im/npm-profile)
31    * [`hook`](https://npm.im/libnpmhook)
32    * [`team`](https://npm.im/libnpmteam)
33    * [`org`](https://npm.im/libnpmorg)
34  * Miscellaneous
35    * [`parseArg`](https://npm.im/npm-package-arg)
36    * [`config`](https://npm.im/libnpmconfig)
37    * [`readJSON`](https://npm.im/read-package-json)
38    * [`verifyLock`](https://npm.im/lock-verify)
39    * [`getPrefix`](https://npm.im/find-npm-prefix)
40    * [`logicalTree`](https://npm.im/npm-logical-tree)
41    * [`stringifyPackage`](https://npm.im/stringify-package)
42    * [`runScript`](https://www.npmjs.com/package/npm-lifecycle)
43    * [`log`](https://npm.im/npmlog)
44    * [`fetch`](https://npm.im/npm-registry-fetch) (plain ol' client for registry interaction)
45    * [`linkBin`](https://npm.im/bin-links)
46
47### Example
48
49```javascript
50await libnpm.manifest('libnpm') // => Manifest { name: 'libnpm', ... }
51```
52
53### API
54
55This package re-exports the APIs from other packages for convenience. Refer to
56the [table of contents](#table-of-contents) for detailed documentation on each
57individual exported API.
58