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

opencrypto-data-js

v0.1.5

Published

Universal Javascript client library for Opencrypto Data

Downloads

7

Readme

opencrypto-data-js

Build Status dependencies Status npm bundle size (minified + zipped) npm

Universal Javascript client library for Opencrypto Data

Installation

Node.js / Webpack

Install package using NPM:

npm install --save opencrypto-data-js

And include library in your script:

const ocd = require('opencrypto-data-js')

Browser

Insert script loader into your html:

<script src="https://opencrypto-io.github.io/data-js/dist/ocd.lib.min.js"></script>

Now you can access library thru ocd global variable.

Usage

There is two methods how to use this library:

Static usage

You dont need build a client instance, you can just use library:

// require library
const ocd = require("opencrypto-data-js")

// get data
let data = await ocd.get("project", "ethereum")

Client instance

Alternatively, you can build a custom client instance (and optionally specify your options):

// require library
const ocd = require("opencrypto-data-js")

// construct client instance
const client = new ocd.Client({ preload: true })

// get data
let data = await client.get("project", "ethereum")

Promises & async/await

This library has full support of Promises and async/await so you can use it as normal.

Async/await version:

let data = await ocd.query("metadata.commit")

Promise variant:

ocd.query("metadata.commit").then(res => {
  let data = res
})

API

Client(options = {}) constructor

Constructor for a new client.

Available options:

  • preload (default: false)
  • dataUrl (default: https://data.opencrypto.io/data.json)

async raw()

Get complete raw data.

let data = await ocd.raw()

async query(query)

Query database by JMESPath query.

await ocd.query("projects[].name")

async get(model, id, query = "@")

Get object from database and run query against it (optional).

await ocd.get("project", "ethereum")
await ocd.get("asset", "ethereum:eth")

on(event, handler = (data) => data)

Bind to specified event. Not available as static method. Available events:

  • loaded

For example:

let client = new ocd.Client({ preload: true })
await client.on("loaded")

emit(event, data)

version()

CLI

To install CLI binary ocd, you need install package with -g option:

npm install -g opencrypto-data-js

Every command have simple command-line alternative:

ocd get asset bitcoin:btc
ocd query metadata.commit
ocd version

License

MIT