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

wtf

v1.5.0

Published

Find out what the function you need

Downloads

138

Readme

wtf

Install

npm install wtf

Usage

Sync search

Synchronous search is simple, fast and the only one supporting preloaded modules. Downside is that if it hangs - your thread will too.

const lodash = require('lodash')
const wtf = require('wtf')

const print = ({ result, display }) => console.log(`${result} ≈ ${display}`)

wtf.sync({ lodash },
  ['apple', 'p'], true,
  ['apple', 'x'], false
).map(print)

Web worker

Not implemented yet

const wtf = require('wtf')

const print = ({ result, display }) => display && console.log(`${result} ≈ ${display}`)

wtf.webWorker('lodash',
  ['apple', 'p'], true,
  ['apple', 'x'], false
).map(print)

Shortcut

Prints results to the console.

const lodash = require('lodash')
const wtf = require('wtf')

wtf({ lodash },
  ['apple', 'p'], true,
  ['apple', 'x'], false
)

Snippets

You can pass snippets as an array of elements of form { func, display }. func is a functions to check. display is a function that generates display string.

Snippet for addition can be defined this way:

const snippets = [ { func: (a, b) => a + b, display: (a, b) => `${a} + ${b}` } ]
wtf({ snippets }, [ 2, 3 ], 5)
// 5 ≈ 2 + 3

Search in built-in global objects

Object, Array, Date, String and RegExp are handled little differently when passed as module to look in. Their prototypes are inspected and found functions are added to the search. It means that besides obvious

wtf({ Array }, [1, 2, 3], [1, 2, 3])
// [1, 2, 3] ≈ Array.of(1, 2, 3)

...you will be able to do:

wtf({ Array }, [ [ 'a', 'b', 'c' ] ], 3)
// 3 ≈ [ 'a', 'b', 'c' ].length
// 3 ≈ [ 'a', 'b', 'c' ].push()
// 3 ≈ [ 'a', 'b', 'c' ].unshift()

Function testers

You can optionally send functions as the expected results to test the results.

const lodash = require('lodash')
const wtf = require('wtf')

wtf({ lodash },
  [10, 20], x => x > 25
)

Curried functions or closures

Results can be functions that will receive the result and return whether it equals. This is helpful for libraries like ramda that returns a function that satisfies something you'd like to test.

const ramda = require('ramda')
const wtf = require('wtf')

wtf({ ramda },
  [a => a * 2, a => a + 1], fn => typeof fn === 'function' && fn(2) === 6
) // will print `ramda.compose`

License

MIT © Vladimir Danchenkov