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

stubber-stubbucks-functions-pkg

v2.0.2

Published

Client to create stubbucks transactions and read account balances

Downloads

32

Readme

stubber-stubbucks-functions-pkg

Client to create stubbucks transactions and read account balances

Client

To use the client you need to have valid redis and mongoDB connection params

import stubbucksClient from "stubber-stubbucks-functions-pkg";

const client = await stubbucksClient({
  redis_host: "localhost",
  redis_port: 6379,
  redis_password: "secret_password",
  redis_db: "1",
  mongo_url: "mongodb://user:password@localhost:27017",
  mongo_db: "database",
});

Functions

The client has multiple functions to standardize affecting the accounts

reserveFunds

Use this to ensure there are enough available funds to do transaction

let transactionuuid = await client.reserveFunds({
    orguuid,
    code,
    quantity,
    ttl
})

Params

  • orguuid
  • code (service cost code)
  • quantity (optional - defaults to 1)
  • ttl (optional - seconds to reserve funds for - defaults to 30)

Result

  • Returns a transactionuuid to be used if postFunds or voidFunds

postFunds

Use this to submit a transaction for previously reserved funds

await client.postFunds({
    orguuid,
    transactionuuid,
    code,
    quantity,
    details
})

Params

  • orguuid
  • transactionuuid (see reserveFunds)
  • code (optional - if not passed then will post full reserved amount)
  • quantity (optional - defaults to 1)
  • details (any object that you want to store in the mongoDB document)

Result

  • Returns true if successful

voidFunds

Use this to remove any pending reserved funds

await client.voidFunds({
    orguuid,
    transactionuuid
})

Params

  • orguuid
  • transactionuuid (see reserveFunds)

Result

  • Returns true if successful

topupAccount

Use this to topup a org account

await client.topupAccount({
    orguuid,
    details,
    amount
})

Params

  • orguuid
  • details (any object that you want to store in the mongoDB document)
  • amount (has to be a float)

Result

  • Returns true if successful

getAccountBalances

Use this to get account balances

await client.getAccountBalances({
    orguuid
})

Params

  • orguuid

Result

{
    current_balance,
    available_balance
}