Skip to content

Commit 11d2a39

Browse files
committed
jquery.observable docs started
1 parent fb54f52 commit 11d2a39

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

src/jquery.observable/readme.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
jQuery observable plugin
2+
========================
3+
Plugin provides very fast (doubly linked list based) implementation of observable pattern.
4+
5+
Usage
6+
-----
7+
```javascript
8+
var observable = new $.observable();
9+
10+
// Subscribing on event
11+
observable.on(event, [data], callback, [context]);
12+
13+
// Subscribing on some events
14+
observable.on(
15+
{
16+
event1 : callback1,
17+
event2 : callback2,
18+
...
19+
eventN : callbackN
20+
},
21+
[context]);
22+
23+
// Subscribing only on first time the event occurs. Callback is unsubscribed after that.
24+
observable.once(event, [data], callback, [context]);

0 commit comments

Comments
 (0)