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

knock-knock

v2.0.0

Published

basic information about the current project and environment

Downloads

10

Readme

knock-knock

basic information about the current project and environment

npm travis coverage standard

Table of Contents

Install

npm install knock-knock

Usage

KnockKnock([commands], callback)

  • commands Object (Optional)
    values are a command to execute, a trimmed stdout or stderr will be yielded
  • callback Function
    (err, result) => {}

default result

| key | value | --- | --- | name | derived from package.json | version | derived from package.json | env | process.env.NODE_ENV | node | node -v | npm | npm -v

Examples

using defaults

const KnockKnock = require('knock-knock')

KnockKnock((err, results) => {
  if (err) throw err
  console.log(results)
  /** {
    name: 'some-name',
    version: '1.2.3',
    env: 'production',
    node: 'v6.10.1',
    npm: '4.5.0'
  } **/
})

passing custom command

const KnockKnock = require('knock-knock')

KnockKnock({ docker: 'docker -v' }, (err, results) => {
  if (err) throw err
  console.log(results)
  // { docker: 'Docker version 17.03.1-ce, build c6d412e', ... }
})

hapi endpoint

const Hapi = require('hapi')
const KnockKnock = require('knock-knock')

const server = new Hapi.Server()

const ping = (request, reply) => KnockKnock(reply)

server.route([
  { method: 'GET', path: '/ping', handler: ping }
])

Express endpoint

const Express = require('express')
const KnockKnock = require('knock-knock')

const app = Express()

const ping = (req, res) => KnockKnock((err, output) => res.send(err || output))

app.get('/ping', ping)

Contribute

PRs welcome! Please read the contributing guidelines and the code of conduct.

License

MIT © Jack Boberg.