ts-deferable v1.0.1

deferable

wrapper for promises to allow to defer the execution rewritten in typescript and built as es module

Table of contents

• Project Name
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • Usage
    • Factory flavor
    • Class Flavor
    • Running the tests
    • Building a distribution version
  • Contributing
  • Credits
  • Built With
  • Versioning
  • Authors
  • License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

clone the repository and from inside run the usual

$ npm run test
$ npm run build

link your project to the local copy

$ npm run build
$ cd /.../your_project
$ npm link -S /.../ts-deferable-folder

Installation with npm

Start with cloning this repo on your local machine:

$ cd npm-project
$ npm install deferable

Usage

Factory Flavor: defer

This is a simple factory method returning a holder object for promise and the

Inside your project:

import {
    defer
} from 'deferable'

const { result, ...lever } = defer(function() {
    // returning the actual operation which returns promise e.g.
    return http.call(url)
    }, "result")


// passing a promise to where is it expected
consumerService(result)
...
// at some point in the code this triggers the promise fulfillment
lever.trigger()

It returns an object with three keys: promise, trigger, called;

- first contains the actual promise which can be consumed.
- trigger is a function which triggers the promise fulfillment.
- called is a flag

Class flavor: DeferredPromise, DeferredTrigger

In essence the class implementation of the above. Objects DeferredPromise and DeferredTrigger is typeof Promise should your project require this feature.

import {
    DefferedTrigger
} from 'deferable';

const deferred = new DefferedTrigger(() => http.call(url))

// passing a promise to where is it expected
consumerService(deferred.promise)

// at some point in the code this triggers the promise fulfillment
deferred.trigger()

Deferred class is just a plain implementation of the deferred pattern exposing resolve and reject resolvers.

import {
    DeferredPromise
} from 'deferable';

const deferred = new DeferredPromise()

// passing a promise to where is it expected
consumerService(deferred)

// at some point in the code this triggers the promise fulfillment
thanableService().then((data) => {
    deferred.resolve(data)
});

Running the tests

$ npm test

Building a distribution version

$ npm run build

This task will create a distribution version of the project inside your local dist/ folder

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request :sunglasses:

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Andrej Bartko - Initial work - AndrejBartko

Contributors

• sinkapoy - typescript version and refactoring - sinkapoy

License

MIT License © 2012-2022 Scott Chacon and others