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

morar-client

v0.6.0

Published

A module for interacting with morar.ft.com

Downloads

11

Readme

morar-client

A Node.js module for interfacing with Morar

Installation

npm i -S morar-client

Configuration

To store information in the Morar service, first include and configure it in your Node.js project like so:

const morar = require('morar-client').config({
	token : "VALID_MORAR_TOKEN",
	name : "NAME_WITH_WHICH_TO_INDEX_YOUR_DATA"
});

The token and name paramters are mandatory. If not set, an error will be thrown when data is passed to be stored.

Environment variables

You can set the name and token values the morar-client requires by setting the environment variables MORAR_NAME and MORAR_TOKEN. Once done, you choose to store data in one of the following ways

// Option 1
const morar = require('morar').config();
morar('TEST_DATA_TO_STORE');

// Option 2
// const morar = require('morar');
morar.store('MORE_TEST_DATA_TO_STORE');

Note, you only have to call the store object if you don't call the config function. If you do call the config function on initialisation, you'll be unable to call the .store function.

Usage

Storing data with the morar-client is simple. To send data to the Morar service, call the object you assigned the required the client to and pass the data you wish to store in one of the following ways

// Saving a string
morar("SIMPLE_DEMO_STRING");

// Saving a string with additional filter fields
morar("SIMPLE_DEMO_STRING", {madeBy : "Joe Bloggs", arana : "discoteca"})

The first argument on the Morar object is the data you wish to store, and is required. The data can be a string, object or readable stream. The second argument are parameters that can be added to the record that is created when an object is stored. These fields can be used to filter items you have stored using Morar.

// Saving an object
morar({
	name : 'The Beatles',
	members : ['John', 'Paul', 'George', 'Ringo'],
	haveTicketToRide : true
});

// Saving a readable stream
morar(fs.createReadStream('./humorous_cat_animation.gif'), {catType : 'grumpy'});

Responses

If you wish to log a response confirming that morar-client successfuly stored your data, the interface is promise-based.

morar("SIMPLE_DEMO_STRING")
	.then(response => {
		console.log(response); // {"status":"ok","id":"[ITEM_UUID]"}
	})
	.catch(err => {
		// If morar-client can't save the data passed,
		// it will reject the promise, which you can handle here.
		console.log(err);
	})
;