npmpackage.info

Gathering detailed insights and metrics for @gar/promisify

Other packages similar to @gar/promisify

@google-cloud/promisify

4.0.0

A simple utility for promisifying functions and classes.

es6-promisify

7.0.0

Converts callback-based functions to ES6 Promises

pify

6.1.0

Promisify a callback-style function

util-promisify

3.0.0

Node 8's util.promisify, as a node module

Gathering detailed insights and metrics for @gar/promisify

@gar/promisify

Promisify an entire class or object

1.1.3

MIT

JavaScript

1,305,736,002 3.7

Installations

npm install @gar/promisify

Pull Requests

Open

0

Total

63

Closed

13

Merged

50

Issues

Open

0

Total

0

Closed

0

Releases

Unable to fetch releases

Contributors

View all 1 contributors

Developer

wraithgar

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

16.14.0

NPM Version

8.4.1 Statistics

12 Stars

65 Commits

3 Watching

1 Branches

1 Contributors

Updated on 24 Oct 2024

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

1,305,736,002

Last day

-1.6%

1,378,508

Compared to previous day

Last week

1.9%

7,261,685

Compared to previous week

Last month

9.6%

30,350,187

Compared to previous month

Last year

-22.4%

384,818,316

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@hapi/code @hapi/lab standard

Versions

@gar/promisify

Promisify an entire object or class instance

This module leverages es6 Proxy and Reflect to promisify every function in an object or class instance.

It assumes the callback that the function is expecting is the last parameter, and that it is an error-first callback with only one value, i.e. (err, value) => .... This mirrors node's util.promisify method.

In order that you can use it as a one-stop-shop for all your promisify needs, you can also pass it a function. That function will be promisified as normal using node's built-in util.promisify method.

node's custom promisified functions will also be mirrored, further allowing this to be a drop-in replacement for the built-in util.promisify.

Examples

Promisify an entire object

1
2const promisify = require('@gar/promisify')
3
4class Foo {
5  constructor (attr) {
6    this.attr = attr
7  }
8
9  double (input, cb) {
10    cb(null, input * 2)
11  }
12
13const foo = new Foo('baz')
14const promisified = promisify(foo)
15
16console.log(promisified.attr)
17console.log(await promisified.double(1024))

Promisify a function

1
2const promisify = require('@gar/promisify')
3
4function foo (a, cb) {
5  if (a !== 'bad') {
6    return cb(null, 'ok')
7  }
8  return cb('not ok')
9}
10
11const promisified = promisify(foo)
12
13// This will resolve to 'ok'
14promisified('good')
15
16// this will reject
17promisified('bad')

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

3

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More