/proc/self/root/proc/1/task/1/root/node24/lib/node_modules/npm/node_modules/libnpmfund
This explorer reads the filesystem of the server it runs on, so /workspace/user isn't present here. Browsing and the terminal still work against this server's own disk from /.
# libnpmfund [](https://npm.im/libnpmfund)[](https://npm.im/libnpmfund)[](https://github.com/npm/cli/actions/workflows/ci-libnpmfund.yml) [`libnpmfund`](https://github.com/npm/libnpmfund) is a Node.js library forretrieving **funding** information for packages installed using[`arborist`](https://github.com/npm/arborist). ## Table of Contents * [Example](#example)* [Install](#install)* [Contributing](#contributing)* [API](#api)* [LICENSE](#license) ## Example ```jsconst { read } = require('libnpmfund') const fundingInfo = await read()console.log( JSON.stringify(fundingInfo, null, 2))// => { length: 2, name: 'foo', version: '1.0.0', funding: { url: 'https://example.com' }, dependencies: { bar: { version: '1.0.0', funding: { url: 'http://collective.example.com' } } }}``` ## Install `$ npm install libnpmfund` ### Contributing The npm team enthusiastically welcomes contributions and project participation!There's a bunch of things you can do if you want to contribute! The[Contributor Guide](https://github.com/npm/cli/blob/latest/CONTRIBUTING.md)outlines the process for community interaction and contribution. Please don'thesitate to jump in if you'd like to, or even ask us questions if somethingisn't clear. All participants and maintainers in this project are expected to follow the[npm Code of Conduct](https://www.npmjs.com/policies/conduct), and justgenerally be excellent to each other. Please refer to the [Changelog](CHANGELOG.md) for project history details, too. Happy hacking! ### API ##### <a name="fund.read"></a> `> fund.read([opts]) -> Promise<Object>` Reads **funding** info from a npm install and returns a promise for atree object that only contains packages in which funding info is defined. Options: - `countOnly`: Uses the tree-traversal logic from **npm fund** but skips overany obj definition and just returns an obj containing `{ length }` - useful forthings such as printing a `6 packages are looking for funding` msg.- `workspaces`: `Array<String>` List of workspaces names to filter for,the result will only include a subset of the resulting tree that includesonly the nodes that are children of the listed workspaces names.- `path`, `registry` and more [Arborist options](https://github.com/npm/cli/blob/latest/workspaces/arborist/README.md#usage). ##### <a name="fund.readTree"></a> `> fund.readTree(tree, [opts]) -> Promise<Object>` Reads **funding** info from a given install tree and returns a tree objectthat only contains packages in which funding info is defined. - `tree`: An [`arborist`](https://github.com/npm/cli/blob/latest/workspaces/arborist/README.md) tree to be used, e.g: ```jsconst Arborist = require('@npmcli/arborist')const { readTree } = require('libnpmfund') const arb = new Arborist({ path: process.cwd() })const tree = await arb.loadActual() return readTree(tree, { countOnly: false })``` Options: - `countOnly`: Uses the tree-traversal logic from **npm fund** but skips overany obj definition and just returns an obj containing `{ length }` - useful forthings such as printing a `6 packages are looking for funding` msg. ##### <a name="fund.normalizeFunding"></a> `> fund.normalizeFunding(funding) -> Object` From a `funding` `<object|string|array>`, retrieves normalized funding objectscontaining a `url` property. e.g: ```jsnormalizeFunding('http://example.com')// => { url: 'http://example.com'}``` ##### <a name="fund.isValidFunding"></a> `> fund.isValidFunding(funding) -> Boolean` Returns `<true>` if `funding` is a valid funding object, e.g: ```jsisValidFunding({ foo: 'not a valid funding obj' })// => false isValidFunding('http://example.com')// => true``` ## LICENSE [ISC](./LICENSE)