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

@tableland/node-helpers

v1.0.0

Published

Helpers for the @tableland/sdk in a Node.js environment

Downloads

19

Readme

@tableland/node-helpers

Review Test License: MIT AND Apache-2.0 Version standard-readme compliant

Helpers for the @tableland/sdk in a Node.js environment

Table of Contents

Background

This package provides helpers for the @tableland/sdk in a Node.js environment. It exports a single jsonFileAliases method takes a path and optional async flag for asynchronous behavior, and it returns a function that can be used as the aliases option for the Database class. It creates an AliasesNameMap, which exposes read() and write() methods that will store table aliases mapped to their unique table uuid (prefix_chainId_tableId). The path passed to jsonFileAliases can be one of:

  • A path to an existing JSON file (e.g., ./tableland.aliases.json).
  • A path to a directory but with a user-defined filename that doesn't exist yet but should be created (e.g., /path/to/custom-filename.json).
  • A path to a directory with no filename specified, which will default to creating a file named tableland.aliases.json in that directory (e.g., ./).

Once the Database class is instantiated with the aliases option, all database queries will let you use the table's alias instead of the full table uuid, which makes it easier to write SQL statements.

Install

You can install via npm.

npm install @tableland/node-helpers

Or yarn:

yarn add @tableland/node-helpers

Usage

Full library documentation is available on our docs site. You can import the jsonFileAliases function from the package and pass it to the SDK's Database class.

import { jsonFileAliases } from "@tableland/node-helpers";
import { Database } from "@tableland/sdk";

const aliases = jsonFileAliases("/path/to/tableland.aliases.json");

const db = new Database({
  aliases,
});

To use asynchronous file operations, you can set the async flag to true. By default, no flag is required and will use synchronous file operations (i.e., set to false).

const aliases = await jsonFileAliases("./tableland.aliases.json", true);

Development

Get started with installing and building the project:

npm install
npm run build

Contributing

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT AND Apache-2.0, © 2021-2023 Tableland Network Contributors