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

on-property-change

v2.1.5

Published

A Typescript decorator to watch class properties changes

Downloads

20,037

Readme

@OnChange

A Typescript decorator to watch class properties changes

Installation

npm install on-property-change --save

Examples

Listening to a property changes

class Person {
  name: string;

  @OnChange('name')
  doStuff() {
      console.log(`Name has been changed:`, this.name);
  }
}
Usage
const p = new Person();
p.name = 'John';
p.name = 'Kyle';
Console output
Name has been changed: John
Name has been changed: Kyle

Listening to multiple properties changes

The doStuff method is called after both properties are initialised

class Person {
  public name: string;
  public age: number;

  @OnChange(['name', 'age'])
  public doStuff() {
      console.log(`${this.name} is ${this.age} years old`);
  }
}
Usage
const p = new Person();
p.name = 'John';
p.age = 18;
p.age = 22;
Console output
John is 18 years old
John is 22 years old

Bulk change

The bulk flag means to call the method only when all the properties have changed

class Point {
  public x: number;
  public y: number;

  @OnChange(['x', 'y'], { bulk: true })
  public move(): void {
    console.log(`Move to ${this.x}:${this.y}`);
  }
}
Usage
const p = new Point();
p.x = '5';
p.x = '3';  
p.y = 8;   // Move to 3:8
p.y = 16;
p.x = 10;  // Move to 10:16
Console output
Move to 3:8
Move to 10:16

Listening to multiple properties separately

You can have multiple decorated methods with any combinations of properties

class Person {
  name: string;
  age: number;

  @OnChange('name')
  doStuff() {
      console.log('change name')
  }

  @OnChange('age')
  doStuff2() {
      console.log('change age 1')
  }

  @OnChange('age')
  doStuff3() {
      console.log('change age 2')
  }
}
Usage
const p = new Person();
p.name = 'John';
p.age = 18;
Console output
change name
change age 1
change age 2

Optional method arguments

The doStuff method can have arguments. They are the same values as the class fields.

class Person {
  public name: string;
  public age: number;

  @OnChange(['name', 'age'])
  public doStuff(name: string, age: number) {
      console.log(`${name} is ${age} years old`);
  }
}

Compare with the previous value

The history flag allows you to get the previous value of the property.

class Person {
  name: string;

  @OnChange('name', { history: true })
  doStuff(name: PropertyChange<string>) {
      console.log(`User has changed name from ${name.previousValue} to ${name.currentValue}`);
  }
}
Usage
const p = new Person();
p.name = 'John';
p.name = 'Kyle';
Console output
User has changed name from undefined to John
User has changed name from John to Kyle

The full metadata looks like this:

export interface PropertyChange<T> {
    firstChange: boolean;
    previousValue: T;
    currentValue: T;
}

As a replacement for ngOnChanges in Angular projects

@Component({
    selector: 'app-person-card',
    templateUrl: './person-card.component.html',
    styleUrls: ['./person-card.component.css']
})
export class PersonCardComponent {
    @Input() name: string;

    @OnChange('name')
    doStuff() {
        // do stuff
    }
}