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

mdata-client

v0.0.3

Published

Joyent Metadata Client

Downloads

6

Readme

mdata-client

A Node.js wrapper around the mdata-client tools shipped inside Joyent instances. Can be used to get, list, put and delete keys from the per-instance metadata store.

Generally, the metadata client tools must be run as the root user to function correctly. The library makes a basic attempt to ensure this by using pfexec on SmartOS/illumos systems, or sudo on other systems. Configuration of these escalation mechanisms is beyond the scope of this document.

Usage

list(callback)

This function wraps mdata-list. It accepts a callback function with arguments (err, keys). If the list of available metadata keys could not be obtained, the callback is called with err set to an Error object. Otherwise, the (possibly empty) list of available metadata keys is passed as keys: an array of strings.

var mod_mdata = require('mdata-client');

mod_mdata.list(function (err, keys) {
  if (err) {
    console.error('ERROR: %s', err);
    process.exit(1);
  }

  console.log('keys: %s', keys.join(', '));
});

get(key, callback)

This function wraps mdata-get. It accepts a string, key, identifying the metadata key to fetch from the store. It also accepts a callback function with arguments (err, value). If the requested metadata key could not be fetched, the callback is called with err set to an Error object. In the special case that the request was successful, but the key was not found, the Error will have its not_found property set to true.

If the metadata value was returned successfully, it will be passed as a string in the value callback argument.

var mod_mdata = require('mdata-client');

mod_mdata.get('user-script', function (err, value) {
  if (err) {
    if (err.not_found) {
      console.error('key was not found');
    } else {
      console.error('ERROR: %s', err);
    }
    process.exit(1);
  }

  console.log('The user-script is:\n\n%s\n', value);
});

put(key, value, callback)

This function wraps mdata-put. It accepts a string, key, identifying the metadata key to set in the store. It accepts a second string, value, with the value for key. Finally, it accepts a callback function with the argument (err). If the metadata store was updated successfully, the callback will be called without arguments. Otherwise, an Error will be passed in the err argument.

var mod_mdata = require('mdata-client');

mod_mdata.put('platform', process.platform, function (err, value) {
  if (err) {
    console.error('ERROR: %s', err);
    process.exit(1);
  }

  console.log('Platform value set OK');
});

del(key, callback)

This function wraps mdata-put. It accepts a string, key, identifying the metadata key to remove from the store. It also accepts a callback function with the argument (err). If the metadata store was updated successfully, the callback will be called without arguments. Otherwise, an Error will be passed in the err argument.

var mod_mdata = require('mdata-client');

mod_mdata.del('secret_password', function (err) {
  if (err) {
    console.error('ERROR: %s', err);
    process.exit(1);
  }

  console.log('Secret password cleared');
});