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

qm-state-simple

v0.2.5

Published

Simple state contener

Downloads

0

Readme

logo-qm

qm-state-simple npm version Build Status code style: prettier

Simple and flexible state contener for simple apps.

Installation

Using npm:

$ npm i -S qm-state-simple

Usage

import { createState, addOptions, returnAPI, getVersion } from 'qm-state-simple'

const state = createState();

Creates default state object:

{
  cwd: ...              // absolute current working directory path
  dryRun: false,        // flag for switching I/O operations
  logger: fales,        // placeholder for external logger 
  exposeState: false, 
  mwd: ...              // absolute module working directory (__dirname) path
  silence: false        // silence all logging
};

Additional state properties

You can add custom properties to state by passing args object:

const args = { feed: true };

const state = createState(args);

Add options

Additional options can be also added by using addOptions() method:

const newState = addOptions(state, { someOption: true});

Return API

At the end of app execution there is possibility of return different forms of state by using returnAPI() method:

const stateToReturn = returnAPI(state, result) // => {result}

When exposeState flag is set on true then:

const stateToReturn = returnAPI(state, result) // => {result, state}

Get version

Use getVersion() method to pull from app version from package.json file. Version number is written to the state in version property.

const updatedState = getVersion(state);

Above method returns Pormise object.

Tests

Run npm script for performing tests:

npm run start:test

License

MIT © qaraluch