npmpackage.info

Gathering detailed insights and metrics for wdeasync

wdeasync - 0.1.120 | npmpackage.info

wdeasync

Turns async function into sync via JavaScript wrapper of Node event loop

0.1.120

MIT

JavaScript

1.75 kB

2,901,985 3.2

Installations

npm install wdeasync

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Min. Node Version

>=10.0.0

Node Version

20.11.0

NPM Version

10.2.4 Score

21.9

Supply Chain

74.7

Quality

70.4

Maintenance

100

Vulnerability

License

Pull Requests

Open

0

Total

31

Closed

1

Merged

30

Issues

Open

0

Total

0

Closed

0

Releases

v0.1.118

0.1.118

Updated on Jul 25, 2022

v0.1.117

0.1.117

Updated on Jul 24, 2022

v0.1.116

0.1.116

Updated on Jun 24, 2022

v0.1.115

0.1.115

Updated on Jun 18, 2022

v0.1.114

0.1.114

Updated on Jun 18, 2022

v0.1.113

0.1.113

Updated on Jun 18, 2022

View All 84 releases

Languages

JavaScript

Scheme

Python

C++

JavaScript (41.3%)

Scheme (34.57%)

Python (15.23%)

C++ (8.91%)

Developer

Wandalen

Download Statistics

Total Downloads

2,901,985

Last Day

194

Last Week

1,170

Last Month

2,919

Last Year

34,299

GitHub Statistics

MIT License

2 Stars

357 Commits

2 Forks

1 Watchers

2 Branches

2 Contributors

Updated on May 17, 2025

Bundle Size

4.14 kB

Minified

1.75 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

0.1.120

Package Id

wdeasync@0.1.120

Unpacked Size

11.40 kB

Size

5.08 kB

File Count

NPM Version

10.2.4

Node Version

20.11.0

Published on

Apr 25, 2024

Total Downloads

Cumulative downloads

Total Downloads

2,901,985

Last Day

9,600%

194

Compared to previous day

Last Week

160%

1,170

Compared to previous week

Last Month

-50.9%

2,919

Compared to previous month

Last Year

-90.7%

34,299

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

node-gyp node-addon-api bindings @mapbox/node-pre-gyp

Dev Dependencies

require-directory @mathquis/node-pre-gyp-github

module::wDeasync

Deasync turns async function into sync, implemented with a blocking mechanism by calling Node.js event loop at JavaScript layer. The core of deasync is writen in C++.

About this fork

This fork is created to provide prebuild versions of the library. Original repository

Motivation

Suppose you maintain a library that exposes a function getData. Your users call it to get actual data: var myData = getData(); Under the hood data is saved in a file so you implemented getData using Node.js built-in fs.readFileSync. It's obvious both getData and fs.readFileSync are sync functions. One day you were told to switch the underlying data source to a repo such as MongoDB which can only be accessed asynchronously. You were also told to avoid pissing off your users, getData API cannot be changed to return merely a promise or demand a callback parameter. How do you meet both requirements?

You may tempted to use node-fibers or a module derived from it, but node fibers can only wrap async function call into a sync function inside a fiber. In the case above you cannot assume all callers are inside fibers. On the other hand, if you start a fiber in getData then getData itself will still return immediately without waiting for the async call result. For similar reason ES6 generators introduced in Node v0.11 won't work either.

What really needed is a way to block subsequent JavaScript from running without blocking entire thread by yielding to allow other events in the event loop to be handled. Ideally the blockage is removed as soon as the result of async function is available. A less ideal but often acceptable alternative is a sleep function which you can use to implement the blockage like while( !done ) sleep( 100 );. It is less ideal because sleep duration has to be guessed. It is important the sleep function not only shouldn't block entire thread, but also shouldn't incur busy wait that pegs the CPU to 100%.

DeAsync supports both alternatives.

Usages

Generic wrapper of async function with conventional API signature function( p1, ...pn, function cb( error, result ){ } ). Returns result and throws error as exception if not null:

1var wdeasync = require( 'wdeasync' );
2var cp = require( 'child_process' );
3var exec = wdeasync( cp.exec );
4// output result of ls -la
5try
6{
7  console.log(exec('ls -la'));
8}
9catch( err )
10{
11  console.log( err );
12}
13// done is printed last, as supposed, with cp.exec wrapped in wdeasync; first without.
14console.log( 'done' );

For async function with unconventional API, for instance function asyncFunction(p1,function cb(res){}), use loopWhile(predicateFunc) where predicateFunc is a function that returns boolean loop condition

1var done = false;
2var data;
3asyncFunction(p1,function cb(res)
4{
5  data = res;
6  done = true;
7});
8require( 'wdeasync' ).loopWhile( function(){ return !done; } );
9// data is now populated

Sleep (a wrapper of setTimeout)

1function SyncFunction()
2{
3  var ret;
4  setTimeout(function()
5  {
6      ret = "hello";
7  },3000);
8  while(ret === undefined)
9  {
10    require( 'wdeasync' ).sleep(100);
11  }
12  // returns hello with sleep; undefined without
13  return ret;
14}

Installation

Unlike original implementation, this has binary distributed, so C++ compiler is not mandatory requirement. Altought, rare OS + CPU combinations might require to recompile wdeasync.

To install, run

npm install wdeasync

Recommendation

Unlike other (a)sync js packages that mostly have only syntactic impact, DeAsync also changes code execution sequence. As such, it is intended to solve niche cases like the above one. If all you are facing is syntatic problem such as callback hell, using a less drastic package implemented in pure js is recommended.

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.

1

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

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

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/GypPrebuild.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPrebuild.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/GypPrebuild.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPrebuild.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPrebuild.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPrebuild.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/GypPublish.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPublish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPublish.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPublish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPublish.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPublish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPublish.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPublish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPublish.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPublish.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPullRequest.yml:12: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPullRequest.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/GypPullRequest.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPullRequest.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPullRequest.yml:39: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPullRequest.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPullRequest.yml:56: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPullRequest.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/GypPush.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPush.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPush.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPush.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/GypPush.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/Wandalen/wDeasync/GypPush.yml/master?enable=pin
Warn: npmCommand not pinned by hash: .github/workflows/GypPrebuild.yml:41
Warn: npmCommand not pinned by hash: .github/workflows/GypPullRequest.yml:53
Warn: npmCommand not pinned by hash: .github/workflows/GypPush.yml:46
Info: 0 out of 5 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 10 third-party GitHubAction dependencies pinned
Info: 0 out of 3 npmCommand dependencies pinned

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

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

SAST

Determines if the project uses static code analysis.

Score

3.2

/10

Last Scanned on 2025-06-30

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