README.md

pkgzap

Fetch funding details of all the dependencies used in your project and send satoshis. Uses the metadata provided by package registries to fetch information about each dependency's funding sources.

🤙 Usage

npm install pkgzap

getFundingDetails

import { getFundingDetails } from "pkgzap";

const fundingInfo = getFundingDetails();

console.log(JSON.stringify(fundingInfo, null, 2))

This defaults to fetching details in package.json of your current directory with a depth of 1. However you can customize this as follows:

const path = "path-to-your/package.json"
const levels = 2 // depth i.e. dependencies of dependencies
const fundingInfo = getFundingDetails(path, levels);

console.log(JSON.stringify(fundingInfo, null, 2))

fetchFundingInfo

If you want to fetch the funding data from some arbitrary JSON retrieved from an API or some other source instead of a file, you can use this function

import { fetchFundingInfo } from "pkgzap";

const fundingInfo = fetchFundingInfo(packageJsonData); // depth is defaulted to 1

console.log(JSON.stringify(fundingInfo, null, 2))

You can also use this method to fetch the funding info from a file:

import { fetchFundingInfo } from "pkgzap";

const packageJsonData = await fs.promises.readFile('package.json', 'utf8');
const fundingInfo = fetchFundingInfo(JSON.parse(packageJsonData), 2);

console.log(JSON.stringify(fundingInfo, null, 2))

How to add funding info to your dependencies?

In your package.json file, add the following:

"funding": {
  "type": "lightning",
  "url": "lightning:satoshi@getalby.com"
}

This would help pkgzap methods to pick your lightning address when your dependency users boost you!