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

@baethon/promise-duck

v1.0.1

Published

Converts object to be promise-like

Downloads

3

Readme

promise-duck

Converts given callback to Thenable object.
Such object is compatible with Promise spec so it can be used as it was a real Promise.

The difference is that computation is deferred until then() method is called or await keyword is used.
It's quite fair to say that in the way how it works such Promise is quite similar to Task

why?

The idea came from little support library which was responsible for building a query (using sort-of fluent API) which was responsible for checking if given value is unique in the database.

I was wondering if object with then() method can be used as a regular Promise. Turned out that its possible.

This little discovery opened me a way to define friendly syntax:

const emailUnique = await isUnique.in('users').where({ email: '[email protected]' })

The defined object can be stored in a variable and none query will be executed until calling then() or using await keyword.

// define details of query (no query is executed!)
const query = isUnique.in('users').where({ email: '[email protected]' })

// query the database and return the results
const emailUnique = await query

installation

npm i @baethon/promise-duck

# or with yarn
yarn add @baethon/promise-duck

usage

Package exposes two functions:

  1. thenable() converts given function to Thenable object.
  2. bind() converts given function and binds it to the selected object

thenable()

const { thenable } = require('@baethon/promise-duck')

const heavyStuff = Math.random
const p = thenable(heavyStuff)

const result = await p

bind()

const { bind } = require('@baethon/promise-duck')

const heavyStuff = function () {
  return `Hello ${this.name}`
}

const object = { name: 'Jon' }

bind(heavyStuff).to(object)

const result = await object

results cache

By default results generated by given function will be cached.

Both, thenable() and bind() allow to disable cache by passing memoize: false option:

const { thenable } = require('@baethon/promise-duck')

const fn = Math.random
const p = thenable(fn, { memoize: false })

development

If you're planning to contribute to the package please make sure to adhere to following conventions.

tests & linting

  • lint your code using standard; run npm run lint to check if there are any linting errors
  • make sure to write tests for all the changes/bug fixes

issues & PR

  • try to provide regression test when you find a bug
  • share some context on what you are trying to do, with enough code to reproduce the issue