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

@gristlabs/basket-api

v1.0.0

Published

Client-side library for Basket, a standalone data storage and integration solution

Downloads

5

Readme

basket

Standalone data solution useful for displaying and interacting with data on your website

API

All methods implement node-style callback functions or, if omitted, return ES6 Promises. The listed return values show what is passed to the callback or the Promise.

/**
 * Creates a Basket instance for interacting with a single basket.
 * @param {String} basketId - Basket identifier string.
 * @param {String} apiKey - API Key giving certain interaction permission. May be null if
 *  not required.
 */
let basket = new Basket(basketId, apiKey)

/**
 * Adds a table to the basket
 * @param {String} optTableId - Optional name for the new table. If omitted, a default 'Table1'
 *  style name is used.
 * @returns {String} - The name of the new table, which may be a sanitized version of the input.
 */
basket.addTable(optTableId, optCallback)

/**
 * Retrieves a table from the basket
 * @param {String} tableId - The name of the table to retreive.
 * @returns {Object} - The table data.
 */
basket.getTable(tableId, optCallback)

/**
 * Renames a table in the basket
 * @param {String} oldTableId - The current name of the table to rename.
 * @param {String} newTableId - The new name for the table.
 * @returns {String} - The name of the new table, which may be a sanitized version of the input.
 */
basket.renameTable(oldTableId, newTableId, optCallback)

/**
 * Overwrites the current data in a table with new data
 * @param {String} tableId - The name of the table whose data should be replaced.
 * @param {Object} tableData - The new data for the table.
 * @returns null
 */
basket.replaceTableData(tableId, tableData, optCallback)

/**
 * Deletes the table in the basket
 * @param {String} tableId - The name of the table to be deleted.
 * @returns null
 */
basket.deleteTable(tableId, optCallback)

/**
 * Lists tables in the basket
 * @returns {Array} - An array of tableIds of tables in the basket
 */
 basket.getTables(optCallback)

index.js is produced by babel from basket.js via:

babel basket.js --out-file index.js