# @itentialopensource/itentialpromisify

> A generic class that wraps cogs, adapters, etc. so that their functions return promises.

Latest version **1.1.3** (published 2020-06-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @itentialopensource/itentialpromisify
pnpm add @itentialopensource/itentialpromisify
yarn add @itentialopensource/itentialpromisify
bun add @itentialopensource/itentialpromisify
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2020-06-29 |
| First published | 2019-05-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 19 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Itential, LLC |
| Maintainers | cma0, itential-ci, zack.strulovitch |

## Links

- npm: https://www.npmjs.com/package/@itentialopensource/itentialpromisify
- npm.io page: https://npm.io/package/@itentialopensource/itentialpromisify

## Recent versions

- 1.1.3 (latest) — 2020-06-29
- 1.1.2 — 2019-06-11
- 1.1.1 — 2019-06-10
- 1.1.0 — 2019-05-30
- 1.0.4 — 2019-05-23
- 1.0.3 — 2019-05-22

## README

# ItentialPromisify

ItentialPromisify wraps cog and adapter functions to enable using async/await with them.

You can also use ItentialPromisify to promisify a single function that expects a callback with arguments in the order results, error.

## Installation

`npm install --save @itentialopensource/itentialpromisify`

## Usage with cogs/adapters

1. Require `ItentialPromisfy`.

    ```javascript
    const itentialPromisify = require('@itentialopensource/itentialPromisify');
    ```

2. Wrap an `adapter` or `cog`.

    ```javascript
    const workFlowEngineWrapper = itentialPromisify(cogs.WorkFlowEngine);
    ```

3. Use `async`/`await` with any method from the cog you wrapped.

    ```javascript
      try {
        const workflowName = 'routerUpgrade';
        const options = {
          variables: {
            new_version: '1.8.8'
          }
        };
        // N.b. no need to pass a callback to the wrapper!
        const saveData = await workFlowEngineWrapper.startJobWithOptions(workflowName, options);
        console.log(JSON.stringify(saveData, null, 2));
      } catch (error) {
        console.log(error.stack);
      }
    ```

## Usage with single functions

1. Require `ItentialPromisfy`.

    ```javascript
    const itentialPromisify = require('@itentialopensource/itentialPromisify');
    ```

2. Call itentialPromisify on the function

    ```javascript
    const startJobWithOptionsPromisified = itentialPromisify(cogs.WorkFlowEngine.startJobWithOptions);
    ```

3. Use `async`/`await` with the promisified method.

    ```javascript
        try {
          const workflowName = 'routerUpgrade';
          const options = {
            variables: {
              new_version: '1.8.8'
            }
          };
          const saveData = await startJobWithOptionsPromisified(workflowName, options);
          console.log(JSON.stringify(saveData, null, 2));
        } catch (error) {
          console.log(error.stack);
        }
    ```

## :open_hands: Contributing to itentialPromisify

Please check out the [Contributing Guidelines](./CONTRIBUTING.md).

License & Maintainers
---

### Maintained by:

Itential Cloud & Delivery Support Teams

### License

[Apache 2.0](./LICENSE)

---
_Source: https://npm.io/package/@itentialopensource/itentialpromisify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._