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

failables

v1.0.3

Published

to protect against null and throwing errors

Downloads

5

Readme

failables

Failables are a clean, consistent, async-friendly, network-friendly result type.

Successful results are represented as failables of type SUCCESS, with the result stored in the payload.

Empty results are neither success nor failure; they are represented as failables of type EMPTY, and of course have no payload. Calling success without a payload will result in an empty failable (not a success).

Instead of representing errors sometimes by a result code, sometimes by a magic number, and sometimes by throwing an exception, consistently represent errors as failables of type FAILURE, with the error message stored in the payload.

That's all there is to it.

usage

  const result1 = success('foo') // first parameter is payload
  const result2 = success('foo', { timesCalled: 7 })  // second (optional) parameter is metadata
  const result3 = failure('trouble!') // payload is error message
  const result4 = failure('trouble!', { userId: 'fred' })  // all failables can include metadata
  const result5 = empty() // empty failables have no payload
  const result6 = empty({ userId: 'fred' })  // for empty, the first (optional) parameter is metadata
  
  const answer = payload(result1) // extract the payload
  const metadata = meta(result2) // extract the metadata
  if (isFailure(result4)) return result4 // a common pattern: if a failure is encountered in a
                                         // failable-returning function, just return the failure directly

documentation

creation

  success(payload, meta) // returns a success failable
  failure(payload, meta) // returns a failure failable
  empty(meta)            // returns an empty failable

tests

  isFailable(object)  // whether the object represents a failable
  isSuccess(failable) // whether the failable is success
  isFailure(failable) // whether the failable is failure
  isEmpty(failable)   // whether the failable is empty

elements

  payload(failable) // extracts the failable's payload
  meta(failable)    // extracts the failable's metadata

list operations

  anyFailed(list)    // whether any in the list failed
  firstFailure(list) // the first failure in the list

assertions

  assertSuccess(failable, payload) // assert that the failable is success
  assertFailure(failable, payload) // assert that the failable is failure
  assertEmpty(failable)            // assert that the failable is empty

utility

  hydrate(failable) // returns an object with kind, payload, and meta fields