Zffu / WatchedObjects

WatchedObjects is a javascript lib to add properties to objects such as last edit timestamp, value history and more

WatchedObjects

A Javascript lib to add value history and timestamps
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With Javascript
2. Getting Started
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License

About The Project

This project was created because i was bored. It can be used in various things.

(back to top)

Built With

This project is built with Vanilla Javascript

(back to top)

Getting Started

To get started with WatchedObjects, you can check the wiki page

Installation

Before using WatchedObjects you will need to install it, you can do it by adding this to your html file: (Comming very soon)

<script src="https://cdn.zffu.ml/js/watchedobjects/1.0/WatchedObjects-1.0.js"></script>

(back to top)

Usage

You can use WatchedObjects to do something like this:

// Create a WatchedObject with a constructor
let myWatchedObject = new WatchedObject("hello world");

// Easier Method to create a WatchedObject
"hello world".toWatchedObject()

// This will throw a warning because its already the given value
myWatchedObject.setValue("hello world")

// This will print the last edit time of the value in the console 
console.log(myWatchedObject.getLastEditTimestamp())

// Get the stored version of the WatchedObject
let myStoredWatchedObject = myWatchedObject.getStored();

// This will update the value of the WatchedObject object from the stored version
myWatchedObject.updateValue()

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Add the Basic WatchedObjects system
• Add more function to make it easier

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)