From fbb9bea3c08f8e0f55b8ce88444075d161b6d033 Mon Sep 17 00:00:00 2001 From: DarkWiiPlayer Date: Tue, 19 Oct 2021 18:08:48 +0200 Subject: [PATCH] Add example to listener documentation --- listener.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/listener.md b/listener.md index 1bd9004..af18832 100644 --- a/listener.md +++ b/listener.md @@ -14,3 +14,26 @@ listener.listen([prop, ...], callback) listener.listen(prop) // Removes all callbacks from a given property ``` + +## Example + +```js +import Listener from 'listener.js' +const listener = Listener({}) + +// Listen for any changed property +listener.listen("*", (value, prop) => console.log(`${prop} changed to ${value}`)) + +// Listen only for changes to the foo property +listener.listen("foo", prop => console.log("it was foo, by the way")) + +// Several listeners for one property are possible +// They will be executed in order of definition +listener.listen("foo", prop => do_something()) + +listener.foo = "New Value" +// Triggers 3 handlers + +listener.bar = "New Value" +// Triggers only the * handler +```