https://github.com/shahradelahi/deasync
⚡ A Node.js Addon for synchronous execution of async functions
https://github.com/shahradelahi/deasync
blocking deasync nodejs sync
Last synced: 9 months ago
JSON representation
⚡ A Node.js Addon for synchronous execution of async functions
- Host: GitHub
- URL: https://github.com/shahradelahi/deasync
- Owner: shahradelahi
- License: mit
- Created: 2025-03-01T22:57:02.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-14T15:58:55.000Z (10 months ago)
- Last Synced: 2025-06-20T21:14:55.426Z (10 months ago)
- Topics: blocking, deasync, nodejs, sync
- Language: TypeScript
- Homepage: https://npmjs.com/@se-oss/deasync
- Size: 81.1 KB
- Stars: 12
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @se-oss/deasync
[](https://github.com/shahradelahi/deasync/actions/workflows/CI.yml)
[](https://www.npmjs.com/package/@se-oss/deasync)
[](/LICENSE)
[](https://packagephobia.com/result?p=@se-oss/deasync)
_@se-oss/deasync_ is a Node.js addon that enables synchronous execution of asynchronous functions by blocking the event loop. The core of project is written in Rust for performance and reliability.
---
- [Installation](#-installation)
- [Usage](#-usage)
- [Documentation](#-documentation)
- [Contributing](#-contributing)
- [Credits](#-credits)
- [License](#license)
## 📦 Installation
```bash
npm install @se-oss/deasync
```
## 📖 Usage
#### Wrapping an Asynchronous Function
`deasync` converts an asynchronous function with the conventional callback pattern `function(p1, ...pn, callback(error, result))` into a synchronous function. It returns the result and throws an error if one occurs.
```typescript
import { deasync } from '@se-oss/deasync';
function asyncFunction(input: string, callback: (err: any, result: string) => void) {
setTimeout(() => {
callback(null, `Hello, ${input}!`);
}, 1000);
}
const syncFunction = deasync(asyncFunction);
console.log(syncFunction("World")); // Blocks for 1 second, then prints "Hello, World!"
```
#### Blocking Execution with `loopWhile`
Use `loopWhile(predicateFunc)` to block execution while the given predicate function returns `true`.
```typescript
import { sleep } from '@se-oss/deasync';
let done = false;
setTimeout(() => {
done = true;
}, 1000);
loopWhile(() => !done);
// The task is now complete
```
#### Sleeping for a Fixed Duration
The sleep function blocks the current thread for the specified number of milliseconds. It behaves similarly to the [`Atomic.wait()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Atomics/wait) API.
```typescript
import { sleep } from '@se-oss/deasync';
console.log(Date.now(), 'Hello');
sleep(1000);
console.log(Date.now(), 'World!');
```
## 📚 Documentation
For all configuration options, please see [the API docs](https://www.jsdocs.io/package/@se-oss/deasync).
## 🤝 Contributing
Want to contribute? Awesome! To show your support is to star the project, or to raise issues on [GitHub](https://github.com/shahradelahi/deasync)
Thanks again for your support, it is much appreciated! 🙏
## 🙌 Credits
This project is inspired by [deasync](https://github.com/abbr/deasync), originally created by [Vladimir Kurchatkin](https://github.com/vkurchatkin) and later maintained by [@abbr](https://github.com/abbr).
## License
[MIT](/LICENSE) © [Shahrad Elahi](https://github.com/shahradelahi) and [contributors](https://github.com/shahradelahi/deasync/graphs/contributors).