Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/googleapis/nodejs-promisify

A simple utility for promisifying functions and classes.
https://github.com/googleapis/nodejs-promisify

Last synced: about 2 months ago
JSON representation

A simple utility for promisifying functions and classes.

Awesome Lists containing this project

README 

        
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."

[//]: # "To regenerate it, use `python -m synthtool`."

Google Cloud Platform logo



# [Google Cloud Common Promisify: Node.js Client](https://github.com/googleapis/nodejs-promisify)



[![release level](https://img.shields.io/badge/release%20level-stable-brightgreen.svg?style=flat)](https://cloud.google.com/terms/launch-stages)

[![npm version](https://img.shields.io/npm/v/@google-cloud/promisify.svg)](https://www.npmjs.org/package/@google-cloud/promisify)



A simple utility for promisifying functions and classes.



A comprehensive list of changes in each version may be found in

[the CHANGELOG](https://github.com/googleapis/nodejs-promisify/blob/main/CHANGELOG.md).



* [Google Cloud Common Promisify Node.js Client API Reference][client-docs]



* [github.com/googleapis/nodejs-promisify](https://github.com/googleapis/nodejs-promisify)



Read more about the client libraries for Cloud APIs, including the older

Google APIs Client Libraries, in [Client Libraries Explained][explained].



[explained]: https://cloud.google.com/apis/docs/client-libraries-explained



**Table of contents:**



* [Quickstart](#quickstart)



  * [Installing the client library](#installing-the-client-library)

  * [Using the client library](#using-the-client-library)

* [Samples](#samples)

* [Versioning](#versioning)

* [Contributing](#contributing)

* [License](#license)



## Quickstart



### Installing the client library



```bash

npm install @google-cloud/promisify

```



### Using the client library



```javascript

const {promisify} = require('@google-cloud/promisify');



/**

 * This is a very basic example function that accepts a callback.

 */

function someCallbackFunction(name, callback) {

  if (!name) {

    callback(new Error('Name is required!'));

  } else {

    callback(null, `Well hello there, ${name}!`);

  }

}



// let's promisify it!

const somePromiseFunction = promisify(someCallbackFunction);



async function quickstart() {

  // now we can just `await` the function to use it like a promisified method

  const [result] = await somePromiseFunction('nodestronaut');

  console.log(result);

}

quickstart();



```

It's unlikely you will need to install this package directly, as it will be

installed as a dependency when you install other `@google-cloud` packages.



## Samples



Samples are in the [`samples/`](https://github.com/googleapis/nodejs-promisify/tree/main/samples) directory. Each sample's `README.md` has instructions for running its sample.



| Sample                      | Source Code                       | Try it |

| --------------------------- | --------------------------------- | ------ |

| Quickstart | [source code](https://github.com/googleapis/nodejs-promisify/blob/main/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-promisify&page=editor&open_in_editor=samples/quickstart.js,samples/README.md) |



The [Google Cloud Common Promisify Node.js Client API Reference][client-docs] documentation

also contains samples.



## Supported Node.js Versions



Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).

Libraries are compatible with all current _active_ and _maintenance_ versions of

Node.js.

If you are using an end-of-life version of Node.js, we recommend that you update

as soon as possible to an actively supported LTS version.



Google's client libraries support legacy versions of Node.js runtimes on a

best-efforts basis with the following warnings:



* Legacy versions are not tested in continuous integration.

* Some security patches and features cannot be backported.

* Dependencies cannot be kept up-to-date.



Client libraries targeting some end-of-life versions of Node.js are available, and

can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).

The dist-tags follow the naming convention `legacy-(version)`.

For example, `npm install @google-cloud/promisify@legacy-8` installs client libraries

for versions compatible with Node.js 8.



## Versioning



This library follows [Semantic Versioning](http://semver.org/).



This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways

unless absolutely necessary (e.g. because of critical security issues) or with

an extensive deprecation period. Issues and requests against **stable** libraries

are addressed with the highest priority.



More Information: [Google Cloud Platform Launch Stages][launch_stages]



[launch_stages]: https://cloud.google.com/terms/launch-stages



## Contributing



Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/nodejs-promisify/blob/main/CONTRIBUTING.md).



Please note that this `README.md`, the `samples/README.md`,

and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)

are generated from a central template. To edit one of these files, make an edit

to its templates in

[directory](https://github.com/googleapis/synthtool).



## License



Apache Version 2.0



See [LICENSE](https://github.com/googleapis/nodejs-promisify/blob/main/LICENSE)



[client-docs]: https://googleapis.dev/nodejs/promisify/latest



[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png

[projects]: https://console.cloud.google.com/project

[billing]: https://support.google.com/cloud/answer/6293499#enable-billing



[auth]: https://cloud.google.com/docs/authentication/getting-started