https://github.com/octet-stream/promisify

Tiny, dependency free promisify library.
https://github.com/octet-stream/promisify

javascript library promisify wrapper

Last synced: about 1 year ago
JSON representation

Tiny, dependency free promisify library.

• Host: GitHub
• URL: https://github.com/octet-stream/promisify
• Owner: octet-stream
• License: mit
• Created: 2017-07-13T23:10:12.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2023-10-17T10:07:57.000Z (over 2 years ago)
• Last Synced: 2025-03-25T03:01:37.113Z (over 1 year ago)
• Topics: javascript, library, promisify, wrapper
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/@octetstream/promisify
• Size: 1.1 MB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# @octetstream/promisify

Tiny, dependency free promisify library.

[![devDependencies Status](https://david-dm.org/octet-stream/promisify/dev-status.svg)](https://david-dm.org/octet-stream/promisify?type=dev)

[![Build Status](https://travis-ci.org/octet-stream/promisify.svg?branch=master)](https://travis-ci.org/octet-stream/promisify)

[![Code Coverage](https://codecov.io/github/octet-stream/promisify/coverage.svg?branch=master)](https://codecov.io/github/octet-stream/promisify?branch=master)

## API

### `promisify(target[, ctx]) -> {Function}`

Promisify Node.js callback-style function with native Promise

  - **{Function}** target - function, that will be wrap with a Promise

  - **{any}** [ctx = null] - "this" context for a target function

### `promisify.all(targets[, ctx]) -> {object}`

Promisify all functions from given object

  - **{object}** targets – object of target functinos

  - **{any}** [ctx = null] - "this" context for all wrapped functions

### `promisify.some(targets, list[, ctx]) -> {object}`

Promisify some functions from given object, that was specified in list

  - **{object}** targets – object of target functinos

  - **{string[]}** list – an array of target functions names

  - **{any}** [ctx = null] - "this" context for all wrapped functions

### `promisify.except(targets, list[, ctx]) -> {object}`

Promisify all functions from given object, except the ones from list

  - **{object}** targets – object of target functinos

  - **{string[]}** list – an array of target functions names

  - **{any}** [ctx = null] - "this" context for all wrapped functions