npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

clean-decorators

v1.1.0

Published

Decorators to clean up observable subscriptions

Downloads

4

Readme

clean-decorators

clean-decorators is a small utility library to cleanup subscriptions from observables on a method call.

It takes any property that has a unsubscribe method. If the property is undefined/null or has no unsubscribe method at the time of the cleanup. Nothing will happen.

Install

npm install clean-decorators 

About reflect-metadata

The library has a dependency on reflect-metadata but does not import it. You need to import it yourself.

@Cleanable()

@Cleanable defines a cleanable property.

@Clean()

@Clean unsubscribes every property defined by the @Cleanable decorators.

Example

class MyClass {

  @Cleanable() myProperty: any;
  @Cleanable() myProperty2: any;

  constructor () {
    this.myProperty = /* observable.subscribe(() => {}) */
    this.myProperty2 = /* observable2.subscribe(() => {}) */
  }

  @Clean()
  clean () {
    // Now myProperty and myProperty2 are unsubscribed
  }
}

Advanced use

@Cleanable() takes CleanableMetadata which is an object containing an id. By default, this id is an empty string. The @Clean() decorator also takes an id in his CleanMetadata options.

It can be useful if you need two categories of subscriptions that you want to unsubscribe in different methods.

Example

class MyClass {

  @Cleanable({ id: 'a' }) myProperty: any;
  @Cleanable({ id: 'b' }) myProperty2: any;

  constructor () {
    this.myProperty = /* observable.subscribe(() => {}) */
    this.myProperty2 = /* observable2.subscribe(() => {}) */
  }

  @Clean({ id: 'a' })
  cleanA () {
    // Now myProperty is unsubscribed
  }

  @Clean({ id: 'b' })
  cleanB () {
    // Now myProperty2 is unsubscribed
  }
}

The CleanMetadata decorator also takes a before parameter which defines if the decorator runs before the original method or otherwise.