Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noblesamurai/heroku-formation
Effect and wait for a heroku dyno formation.
https://github.com/noblesamurai/heroku-formation
Last synced: about 1 month ago
JSON representation
Effect and wait for a heroku dyno formation.
- Host: GitHub
- URL: https://github.com/noblesamurai/heroku-formation
- Owner: noblesamurai
- License: other
- Created: 2018-06-20T22:48:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-07-09T05:18:58.000Z (over 6 years ago)
- Last Synced: 2024-12-05T20:07:51.915Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 486 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Heroku-formation [](http://travis-ci.org/noblesamurai/heroku-formation)
[](https://nodei.co/npm/heroku-formation/)
> Enacts a requested dyno formation on heroku across multiple apps.
## Purpose
Allows you to request a dyno formation across multiple micro-services and wait
until it is effective.
## Installation
```bash
$ npm install heroku-formation
```
## Usage
```js
const Heroku = require('heroku-client');
const heroku = new Heroku({ token: 'mytoken' });
const { applyFormation, checkFormation } = require('heroku-formation');
async function main () {
await applyFormation(heroku, 'appName', [{ type: 'web', quantity: 1 }, { type: 'worker', quantity: 2}]);
// We get here after formation is enacted.
await checkFormation(heroku, 'appName', [{ type: 'web', quantity: 2 }]); // false
// false
await checkFormation(heroku, 'appName', [{ type: 'web', quantity: 1 }, { type: 'worker', quantity: 2 }]); // true
}
```
See [this
doco](https://devcenter.heroku.com/articles/platform-api-reference#formation)
for the format of the formation.
## API
## applyFormation
Given an app and dyno formation, scale it and wait until formation in place.(app, formation) ⇒ Promise
**Kind**: global function
**Returns**: Promise - fulfilled when scale complete.
| Param | Type | Description |
| --- | --- | --- |
| app | string | app name |
| formation | Array.<object> | [{ type: 'web', quantity: 1}, { type: 'worker', quantity: 2}] |
## checkFormation(heroku, app, formation) ⇒ Promise.<Boolean>
**Kind**: global function
**See**: https://devcenter.heroku.com/articles/platform-api-reference#formation
Check whether app is in requested formation.
| Param | Type |
| --- | --- |
| heroku | Heroku |
| app | string |
| formation | Array.<object> |
## License
The BSD License
Copyright (c) 2018, Tim Allen
All rights reserved.
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this
list of conditions and the following disclaimer in the documentation and/or
other materials provided with the distribution.
* Neither the name of the Tim Allen nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.