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

ink-probe

v0.1.0-5

Published

*ink-probe* allows you to interrogate your objects and arrays

Downloads

4

Readme

ink-strings

ink strings logo Part of the ink tool suite

This is a nifty little tool that allows you to query objects and arrays using a reach-in syntax and query language based on Mongo's. Some intended actions the tool was meant to support:

  var probe = require("ink-probe");
  /*
  for an object or array that contains records with a field that looks like {name: {first: "string", last: "string"}}
  you can query it like os
  */
  var arr = probe.find(objectOrArray, {"name.first": "Terry", "name.last": "Flinstone"});

Now arr contains all of the records in objectOrArray that match the query.

  /* to update records */
  probe.update(objectOrArray, {"name.first": "Terry", "name.last": "Flinstone"}, {$set: {"name.first": "Fred"}});

Now all records that match "Terry Flinstone" will have been updated to "Fred Flinstone".

But wait! Put your checkbook away! You can also findOne, findKeys and check for all and some conditions. Finally, you can also reach in directly using reachin and force an update directly on a field for a single record using pushin. How? Good question. See the...

Documentation

ink-probe comes with a comprehensive set of methods.

Contributing

Yes! Contribute. Make sure your code looks essentially like the code you see. Document using JSDoc tags.

Installation

npm install ink-probe

Usage

From node: var probe = require("ink-probe");

On the web: Copy dist/ink.probe.js or dist/ink.probe.min.js to your assets directory and then load it directly

<script src="js/ink.probe.js"></script>
<script>
	// all of the methods hang right off of window.ink.probe
    var goHome = ink.probe.find(obj, {field: "value");
</script>

Contributing

Yes! Contribute. Make sure your code looks essentially like the code you see. Document using JSDoc tags.

Make sure you have grunt-cli installed globally. To test, you will also need nodeunit installed globally. To test:

nodeunit tests/

Roadmap

  • Translate from coffee to JS.
  • Support the .$. positional operator for array updates
  • Support indexing
  • Improve performance for non-indexed operations

ink tools

Also see

  • ink-probe
  • ink-strings
  • ink-collector (coming soon)
  • ink-scene (coming soon)
  • ink-dox (coming, but a long way off yet)

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.