doors
Use doors to represent asynchronous operations depending on multiple conditions. Imagine a door with multiple locks, you can not open the door until all locks are unlocked and one lock is enough for the door to be closed.
Usage
A door is either opened or closed. The transition from one state to an other depends on conditions called "locks".
const Doors = // create a promise that will resolve only once hello and world are unlockedconst promise = { door } 'hello world'
At the opposite of a promise, the transition from open to close is not immutable (see below) and a door can oscillate between those 2 states. For example, this module has been used in production to represent database connection hang up with automatic retry.
Api
const doors = // initialize door with one lockconst door = // listen when door opensdoor// listen when door closesdoor doordoor // is lock1 unlocked?door// => falsedoor // lock lock1 againidoor
A transition may depend on multiple locks.
const door = doordoor// => falsedoor// => true // unlock lock2 after 1 seconddoor // door is openeddoor// => true
Immutable computations can be created from door locks.
// create a promise that is fulfilled when door opensdoor // create a promise that is fulfilled when lock1 is unlockeddoor // create a promise that is fulfilled when lock1 and lock3 are unlockeddoor
Installation
npm install doors --save
Question
For questions and feedback please use our twitter account. For support, bug reports and or feature requests please make sure to read our community guideline and use the issue list of this repo and make sure it's not present yet in our reporting checklist.
Contribution
doors is an open source project and would not exist without its community. If you want to participate please make sure to read our guideline before making a pull request. If you have any doors related project, component or other let everyone know in our wiki.
License
The MIT License (MIT)
Copyright (c) 2016 Olivier Wietrich
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.