https://github.com/rousan/gpromise

A helper library to create a promise to be resolved/rejected from your other parts of codebase
https://github.com/rousan/gpromise

async await global promise promisify

Last synced: about 1 month ago
JSON representation

A helper library to create a promise to be resolved/rejected from your other parts of codebase

• Host: GitHub
• URL: https://github.com/rousan/gpromise
• Owner: rousan
• License: mit
• Created: 2020-02-12T10:56:43.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T17:57:40.000Z (almost 2 years ago)
• Last Synced: 2024-11-06T17:53:27.965Z (about 2 months ago)
• Topics: async, await, global, promise, promisify
• Language: TypeScript
• Size: 480 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/rousan/gpromise.svg?branch=develop)](https://travis-ci.org/rousan/gpromise)

[![NPM version](https://img.shields.io/npm/v/global-promise.svg)](https://www.npmjs.com/package/global-promise)

[![NPM total downloads](https://img.shields.io/npm/dt/global-promise.svg)](https://www.npmjs.com/package/global-promise)

[![Contributors](https://img.shields.io/github/contributors/rousan/gpromise.svg)](https://github.com/rousan/gpromise/graphs/contributors)

[![License](https://img.shields.io/github/license/rousan/gpromise.svg)](https://github.com/rousan/gpromise/blob/master/LICENSE)

# Global Promise

A helper library to create a promise to be resolved/rejected from your other parts of codebase globally.

## Installation

Install it from `npm`:

```bash

$ npm install global-promise

```

or

```bash

$ yarn add global-promise

```

## Motivation

Sometimes, we create a promise and we needed to resolve/reject it from other part of codebase globally.

We can achieve the same by implementing event driven code using `EventTarget` or `EventEmitter` , 

but it will require a lot of code.

Solve it with `GPromise` with a few of lines of code:

``` js

import * as GPromise from 'global-promise';

// Creates a promise to be settled from other parts of code.

GPromise.create('my_id')

  .then((val) => {

    console.log( `Promise with 'my_id' id is resolved with: ${val}` );

  });

// In your other part of code:

setTimeout(() => {

  // Resolve the promise we have just created with id 'my_id' above from other part of your codebase.

  GPromise.resolve('my_id', 'my_value');

}, 2000);

```

## Test

Run:

```sh

yarn test

```

## Contributing

Your PRs and stars are always welcome.