Skip to content

Commit

Permalink
fix API.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Maksims committed Jan 25, 2021
1 parent 01dedd7 commit 7c2244e
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 17 deletions.
28 changes: 14 additions & 14 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,20 @@ Observer that provides sync events when data is changed. For data-centric applic
| data | <code>object</code> | Data that obsserver is modifying. This data should not be modified by application logic. |


[new Observer([data])](#new_Observer_new) (constructor)
[.set([path], data)](#Observer+set)
[.patch([path], data)](#Observer+patch)
[.unset([path])](#Observer+unset)
[.get([path])](#Observer+get) ⇒ <code>\*</code>
[.clear()](#Observer+clear)
[.on(name, callback, [scope], [once])](#EventEmitter+on)[<code>EventHandler</code>](#EventHandler)
[.once(name, callback, [scope])](#EventEmitter+once)[<code>EventHandler</code>](#EventHandler)
[.emit(name, [...args])](#EventEmitter+emit)
[.off([name], [callback], [scope])](#EventEmitter+off)
[[path]:set (value, old)](#Observer+event_[path]_set) (event)
[*:set (path, value, old)](#Observer+event_*_set) (event)
[[path]:unset (old)](#Observer+event_[path]_unset) (event)
[*:unset (path, old)](#Observer+event_*_unset) (event)
[new Observer([data])](#new_Observer_new) (constructor)<br />
[.set([path], data)](#Observer+set)<br />
[.patch([path], data)](#Observer+patch)<br />
[.unset([path])](#Observer+unset)<br />
[.get([path])](#Observer+get) ⇒ <code>\*</code><br />
[.clear()](#Observer+clear)<br />
[.on(name, callback, [scope], [once])](#EventEmitter+on)[<code>EventHandler</code>](#EventHandler)<br />
[.once(name, callback, [scope])](#EventEmitter+once)[<code>EventHandler</code>](#EventHandler)<br />
[.emit(name, [...args])](#EventEmitter+emit)<br />
[.off([name], [callback], [scope])](#EventEmitter+off)<br />
[[path]:set (value, old)](#Observer+event_[path]_set) (event)<br />
[*:set (path, value, old)](#Observer+event_*_set) (event)<br />
[[path]:unset (old)](#Observer+event_[path]_unset) (event)<br />
[*:unset (path, old)](#Observer+event_*_unset) (event)<br />

<a name="new_Observer_new"></a>

Expand Down
3 changes: 1 addition & 2 deletions other/tmpl/sig-link.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,5 @@
{{#if @suffix}} {{@suffix}}{{/if~}}
{{{@depClose}~}}
{{~/sig}}{{/if~}}
{{#if virtual}}*{{/if}}{{#with (parentObject)}}{{#if virtual}}*{{/if~}}{{/with~}}
{{{' '}}}
{{#if virtual}}*{{/if}}{{#with (parentObject)}}{{#if virtual}}*{{/if~}}{{/with~}}<br />
{{/unless}}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mr-observer",
"version": "0.1.2",
"version": "0.1.3",
"description": "An observer is a wrapper over JSON data, that provides an interface to know when data is changed, with a focus on performance and memory efficiency. For data-centric design, this provides a modular and robust architecture for applications with various data-dependent parts: ui, real-time render, history undo/redo, real-time collaboration, and more. This pattern has been used for years in PlayCanvas Editor providing fast iteration and ease of development in a complex environment.",
"type": "module",
"main": "src/index.js",
Expand Down

0 comments on commit 7c2244e

Please sign in to comment.