Npm-donate NPM

npm-donate

Support maintainers with a donation and help them continue with activities

Install

$ npm install --save npm-donate

Usage

const npmDonate = require('npm-donate')

npmDonate('https://npm-donate.now.sh', 100)

Demo

API

npmDonate(apiUrl, amount, options)

Returns a promise

apiUrl

Type: string Required

Your API Url where it handles donations. Check here: npm-donate-server

amount

Type: number Default: 0.50 (cents — minimum) Optional

Donation amount

options

Type: object

Google Maps Key

Type: string

If Google Maps API Key is set, it will lookup for user state and city using zip code.

currency

Type: string Default: usd

3-letter ISO code for currency. Check supported currencies here.

description

Type: string Default: Donation

An arbitrary string which you can attach to a Charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing.