JSPM

@smilo-platform/web3-core-promievent

1.0.0-beta.38
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q34428F
  • License LGPL-3.0

This package extends eventEmitters with promises to allow chaining as well as multiple final states of a function.

Package Exports

  • @smilo-platform/web3-core-promievent

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@smilo-platform/web3-core-promievent) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

web3-core-promievent

This is a sub package of web3.js

This is the PromiEvent package is used to return a EventEmitter mixed with a Promise to allow multiple final states as well as chaining. Please read the documentation for more.

Installation

Node.js

npm install web3-core-promievent

In the Browser

Build running the following in the web3.js repository:

npm run-script build-all

Then include dist/web3-core-promievent.js in your html file. This will expose the Web3PromiEvent object on the window object.

Usage

// in node.js
var Web3PromiEvent = require('@smilo-platform/web3-core-promievent');

var myFunc = function(){
    var promiEvent = Web3PromiEvent();
    
    setTimeout(function() {
        promiEvent.eventEmitter.emit('done', 'Hello!');
        promiEvent.resolve('Hello!');
    }, 10);
    
    return promiEvent.eventEmitter;
};


// and run it
myFunc()
.then(console.log);
.on('done', console.log);