https://github.com/peternaydenov/promise-finite

Promise with ttl
https://github.com/peternaydenov/promise-finite

Last synced: 4 days ago
JSON representation

Promise with ttl

• Host: GitHub
• URL: https://github.com/peternaydenov/promise-finite
• Owner: PeterNaydenov
• License: mit
• Created: 2017-07-15T10:06:33.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-24T13:34:14.000Z (about 2 months ago)
• Last Synced: 2024-11-05T18:55:39.200Z (10 days ago)
• Language: JavaScript
• Size: 103 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Promise-finite

![version](https://img.shields.io/github/package-json/v/peterNaydenov/promise-finite)

![license](https://img.shields.io/github/license/peterNaydenov/promise-finite)

Promise with ttl. Works well with standard and Bluebird promises.

Standard promise will live forever. Not resolving/rejecting them will create a memory leaks. Promise-finite is a promise with ttl (time-to-live). When ttl expires promise will be resolved with a provided message that will help you to alocate the forgotten promise.

```js

  promiseFinite ( ttl, "expireMsg", promiseFn )

```

Where **ttl** {number} is a time to live in milliseconds, **expireMsg**{string} is a string that will be received as a result if timeout was triggered and **promiseFn** is a standard promise function that receives (resolve,reject) as arguments.

## Installation

Install by writing in your terminal:

```

npm install promise-finite

```

Load standard promise library:

```js

import { standard as promiseFinite } from 'promise-finite'

// or with require:

const promiseFinite = require('promise-finite').standard;

```

Load with bluebird or other promise library that implements standard interface:

```js

// with import:

import bluebird from 'bluebird'

import { customize as promiseCustomized } from 'promise-finite'

const promiseFinite = promiseCustomized( bluebird );

// or with require:

const bluebird = require ('bluebird')

const promiseFinite = require('promise-finite').customize( bluebird )

```

## Examples

### Simple promise with ttl

```js

promiseFinite ( 3000, "exp", (resolve,reject) => {

        console.log("Starting a promise");

        // ...without 'resolve' promiseFinite will trigger the timeout after 3s 

 })

 .then ( result => {

          // on timeout result will have string value 'exp'

          if ( result === 'exp' )  // do something if timeout

          else                     // execute normal program flow...

})

```

## Known bugs

_(Nothing yet)_

## Release History

### 2.0.0 ( 2024-02-08 )

- [x] Convert module to es6

- [x] Folder 'dist' was added to the project. Includes commonjs, umd and esm versions of the library;

- [x] Package.json: "exports" section was added. Allows you to use package as commonjs or es6 module without additional configuration;

- [x] Rollup was added to the project. Used to build the library versions;

### 1.0.1 (2021-04-01)

- [x] Just a dev. dependencies update

### 1.0.0 (2017-07-15)

- [x] Node.js module;

- [x] Test package;

## Credits

'promise-finite' was created by Peter Naydenov.

## License

'promise-finite' is released under the [MIT License](http://opensource.org/licenses/MIT).