Skip to content

Latest commit

 

History

History
96 lines (70 loc) · 2.73 KB

README.md

File metadata and controls

96 lines (70 loc) · 2.73 KB


Goodies

Helper and utility functions for Node.js.


Installation · Docs · API



Latest Version Monthly downloads

Follow @marcuspoehls and @superchargejs for updates!


Introduction

The @supercharge/goodies package provides a handful of useful helper functions for Node.js and JavaScript, like an async tap function.

Installation

npm i @supercharge/goodies

Docs

Find all the details for @supercharge/goodies in the extensive Supercharge docs.

API

Using @supercharge/goodies is pretty straightforward. The package exports a handful of methods that you can reach for when requiring the package:

tap(value, callback)

Returns the value after running the callback. The callback receives the value as an argument.

const { tap } = require('@supercharge/goodies')

return tap(await User.find(1), async (user) => {
  await user.subscribeToNewsletter()
})

// returns the user with ID 1

upon(value, callback)

Returns the result of the callback. The callback receives the value as an argument.

const { upon } = require('@supercharge/goodies')

return upon(await User.find(1), async (user) => {
  return user.email
})

// user@email.com

Contributing

Do you miss a goodie function? We very much appreciate your contribution! Please send in a pull request 😊

  1. Create a fork
  2. Create your feature branch: git checkout -b my-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request 🚀

License

MIT © Supercharge


superchargejs.com  ·  GitHub @supercharge  ·  Twitter @superchargejs