Git Product home page Git Product logo

autodestroy's Introduction

Auto Destroy

Build Status Coverage Status Open Source Love

Problem

When we use RxJS, we have to cancel all subscription objects we create. In angular, we have the possibility to use async pipe. However, in some use cases, we don't have this opportunity and we need manually to unsubscribe each subscription or complete the Observable by using takeUntil.

Although, we have to duplicate the same code over and over, the implementation of this pattern becomes repetitive for each component that uses subscriptions.

Solution

Auto destroy library offers a single autoDestroy operator method. It overrides any existent destroy method to handle automatically subscription cancellation on any observable.

How it works

We can use the autoDestroy operator along with angular component as follow:

export class PostComponent implements OnDestroy {
  constructor(postService: PostService) {
    postService.getPosts()
      .pipe(
        switchMap(...)
        ... other observables
        // to prevent leaks with intermediate observables, this **MUST** be the last operator !!
        autoDestroy(this)
      )
      .subscribe();
  }

  // must be implemented even empty
  ngOnDestroy(): void {}
}

The autoDestroy operator is RxJS specific and not related to Angular. Thus, it can be used with any Observable as follow:

export class AuthorComponent {
  constructor() {
    timer(0, 300)
      .pipe(
        map(next => next * 3),
        filter(next => next % 2 !== 0),
        autoDestroy(this, 'destroy') // default method name is ngOnDestroy
      )
      .subscribe();
  }

  private log(message: string): void {
    console.log(message);
  }

  // original destroy method would be called automatically
  destroy(message: string): void {
    this.log(message);
  }
}

Peer Dependency

The auto destroy pipe depends on:

  1. RxJS ^6.3

    • Observable
    • Subject
    • takeUntil
  2. Typescript 3.6.5

Publish to npm repo

  1. Fix date release in CHANGELOG.md
  2. Increment version number in package.json and package-lock.json
  3. Run npm run pub then enter the 2FA code
  4. Commit, push and create a new github release

autodestroy's People

Contributors

dependabot[bot] avatar elie29 avatar

Watchers

 avatar  avatar

autodestroy's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.