Programmatic API for npm fund
npm install libnpmfund
libnpmfund is a Node.js library for
retrieving funding information for packages installed usingarborist.
* Example
* Install
* Contributing
* API
* LICENSE
``js
const { 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' }
}
}
}
`
$ npm install libnpmfund
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
outlines the process for community interaction and contribution. Please don't
hesitate to jump in if you'd like to, or even ask us questions if something
isn't clear.
All participants and maintainers in this project are expected to follow the
npm Code of Conduct, and just
generally be excellent to each other.
Please refer to the Changelog for project history details, too.
Happy hacking!
##### > fund.read([opts]) -> Promise
Reads funding info from a npm install and returns a promise for a
tree object that only contains packages in which funding info is defined.
Options:
- countOnly: Uses the tree-traversal logic from npm fund but skips over{ length }
any obj definition and just returns an obj containing - useful for6 packages are looking for funding
things such as printing a msg.workspaces
- : Array List of workspaces names to filter for,path
the result will only include a subset of the resulting tree that includes
only the nodes that are children of the listed workspaces names.
- , registry and more Arborist options.
##### > fund.readTree(tree, [opts]) -> Promise
Reads funding info from a given install tree and returns a tree object
that only contains packages in which funding info is defined.
- tree: An arborist tree to be used, e.g:
`js
const 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 over{ length }
any obj definition and just returns an obj containing - useful for6 packages are looking for funding
things such as printing a msg.
##### > fund.normalizeFunding(funding) -> Object
From a funding , retrieves normalized funding objectsurl
containing a property.
e.g:
`js`
normalizeFunding('http://example.com')
// => {
url: 'http://example.com'
}
##### > fund.isValidFunding(funding) -> Boolean
Returns if funding is a valid funding object, e.g:
`js
isValidFunding({ foo: 'not a valid funding obj' })
// => false
isValidFunding('http://example.com')
// => true
``