https://github.com/myty/promise-chain

Utility class to wrap classes that are meant for method chaining, specifically useful for functions that return Promises. Promise functions and non-promise functions can be mixed.
https://github.com/myty/promise-chain

deno hacktoberfest typescript

Last synced: about 1 month ago
JSON representation

Utility class to wrap classes that are meant for method chaining, specifically useful for functions that return Promises. Promise functions and non-promise functions can be mixed.

• Host: GitHub
• URL: https://github.com/myty/promise-chain
• Owner: myty
• License: mit
• Created: 2022-09-03T19:01:18.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-14T03:16:51.000Z (6 months ago)
• Last Synced: 2024-10-01T15:20:10.611Z (about 2 months ago)
• Topics: deno, hacktoberfest, typescript
• Language: TypeScript
• Homepage:
• Size: 67.4 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PromiseChain

[![JSR](https://jsr.io/badges/@myty/promise-chain)](https://jsr.io/@myty/promise-chain)

[![JSR Score](https://jsr.io/badges/@myty/promise-chain/score)](https://jsr.io/@myty/promise-chain)

[![GitHub version](https://badgen.net/github/release/myty/promise-chain?color=green)](https://github.com/myty/promise-chain)

[![deno land](https://badgen.net/github/release/myty/promise-chain?color=green&label=deno.land)](https://deno.land/x/promise_chain)

[![npm version](https://badgen.net/npm/v/@myty/promise-chain?color=green)](https://www.npmjs.com/package/@myty/promise-chain)

[![Coverage Status](https://badgen.net/coveralls/c/github/myty/promise-chain?color=green)](https://coveralls.io/github/myty/promise-chain?branch=main)

Wrapper utility class that enables composition via asynchronous (Promises) and

synchronous method chaining.

## Installation

### Node.js

```bash

# npm

npm install --save promise-chain

# yarn

yarn add promise-chain

# pnpm

pnpm install --save promise-chain

```

### Deno

```bash

import Composable from "https://deno.land/x/promise_chain/mod.ts";

```

## Example Usage

Provided the following class:

```typescript

class TestClass {

  public readonly propertyOne: number;

  public readonly propertyTwo: number;

  constructor({

    propertyOne = 0,

    propertyTwo = 0,

  }: Partial = {}) {

    this.propertyOne = propertyOne;

    this.propertyTwo = propertyTwo;

  }

  async asyncIncrement(

    property: string,

    increment: number,

  ): Promise {

    return new TestClass({

      ...this,

      [property]: await Promise.resolve(this[property] + increment),

    });

  }

  increment(

    property: string,

    increment: number,

  ): Promise {

    return new TestClass({

      ...this,

      [property]: this[property] + increment,

    });

  }

}

```

Traditionally to chain these methods you would need to do the follwing:

```typescript

const { propertyOne, propertyTwo } = await testClass

  .asyncIncrement("propertyOne", 3)

  .then((t) => t.asyncIncrement("propertyTwo", 5))

  .then((t) => Promise.resolve(t.increment("propertyTwo", 5)));

console.log(`Result: propertyOne=${propertyOne}, propertyTwo=${propertyTwo}`);

// OUTPUT: "Result: propertyOne=3, propertyTwo=10"

```

With PromiseChain, it is simplified and easier to read.

```typescript

const { propertyOne, propertyTwo } = await PromiseChain(testClass)

  .asyncIncrement("propertyOne", 3)

  .asyncIncrement("propertyTwo", 5)

  .increment("propertyTwo", 5);

console.log(`Result: propertyOne=${propertyOne}, propertyTwo=${propertyTwo}`);

// OUTPUT: "Result: propertyOne=3, propertyTwo=10"

```