my-observable

Observable Library

Description

The Observable library makes it easy to create observable objects in JavaScript. With simple annotations, you can define which attributes of a class should be observed. Whenever these attributes are modified, an _update function is automatically invoked.

Installation

To install the Observable library, run the following command:

npm install my-observable

Usage

Importing

First, import the library into your JavaScript file:

import observable from 'my-observable';

Creating an Observable Class

To make a class observable, use the @observable annotation:

@observable
class Person {
  constructor(name, age) {
    this.name = name;
    this.age = age;
  }

  public _update() {
    console.log("The Person class has been updated.");
  }
}

Observing Specific Attributes

To observe specific attributes, pass an options object with the attributes key:

@observable({ attributes: ['name'] })
class Person {
  // ...
}

Excluding Specific Attributes from Observation

To exclude specific attributes from observation, pass an options object with the except key:

@observable({ except: ['age'] })
class Person {
  // ...
}

Contribution

If you would like to contribute to this project, please follow the contribution guidelines.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

---

This is a basic example, and you may expand it according to the specific needs of your project. Make sure to also add any specific instructions that are relevant to your library.