sync-to-async

sync-to-async is a lightweight JavaScript package that converts synchronous functions into asynchronous functions. This is particularly useful for testing, simulating delays, or modernizing legacy code that uses synchronous operations.

Installation

You can install the package via npm:

npm install sync-to-async

Or via yarn:

yarn add sync-to-async

Usage

Basic Example

Here's a simple example of how to convert a synchronous function to an asynchronous function using sync-to-async:

import { toAsyncFunction } from 'sync-to-async';

const asyncMultiply = toAsyncFunction(syncMultiply)
function syncMultiply(x: number) {
  return x * 2;
}

asyncMultiply(10).then(result => {
  console.log(result); // Output: 20
});

API

toAsyncFunction(fn) fn (Function): The synchronous function to be converted to asynchronous. Returns a new function that returns a Promise.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any bugs, feature requests, or improvements.

How can I thank you?

Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!

Don't forget to follow me on X (Formerly Twitter)! and also follow me on LinkedIn!

Thanks! Jacob Eke.