npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

checkeeper-client

v0.3.0

Published

API client and signature generator for Checkeeper

Downloads

551

Readme

Checkeeper Client

A zero-dependency node client for the Checkeeper API.

Requirements

  • Node 20+
  • ESM-only: The client must be imported using import or dynamic import()

Usage

Create Check API

import { Configuration, CheckeeperClient } from "checkeeper-client"

const configuration: Configuration = {
  token: "your-checkeeper-token",
  secret: "your-checkeeper-secret",
  testMode: true, // Sends all requests as "test" requests
}

const client = new CheckeeperClient(configuration)

// Create a PDF of a check, but do not mail it
await client.createCheckPDF({
  /* See CreateCheckOptions */
})

// Mail a check (does not return a PDF -- use getCheckImage() to retrieve an image)
await client.mailCheck({
  /* See MailCheckOptions */
})

// See CheckeeperClient docs for available API calls.

Base64 utilities

When specifying fields that require base64 binary data, such as logo, signerImage, and attachment, use binaryDataToBase64 to convert a Buffer or ReadableStream to base64.

const logo = Buffer.from(/*...*/)
const signerImage = fs.createReadStream("signature.png")
const attachment = fs.createReadStream("attachment.pdf")

client.createCheckPDF({
  logo: binaryDataToBase64(logo),
  attach: binaryDataToBase64(attachment),
  signerImage: binaryDataToBase64(signerImage),
  // ...
})

When receiving a base64-encoded image in a Checkeeper response, use base64ToBuffer or base64ToStream to convert the image to a Buffer or ReadableStream.

const resp = await client.createCheckPDF({
  /* ... */
})

if (resp.success) {
  fs.writeFileSync("check.pdf", base64ToBuffer(resp.pdf))
  // Or
  const fileStream = fs.createWriteStream("check-image.jpg")
  base64ToStream(resp.pdf).pipe(fileStream)
}

Checkeeper Signature

The Checkeeper signature generator can be used independently, in place of the checkeeper-signature package.

import { getCheckeeperRequestSignature } from "checkeeper-client"

const signature = getCheckeeperRequestSignature(
  {
    /* Checkeeper request parameters */
  },
  "your-checkeeper-secret"
)