|
2 | 2 |
|
3 | 3 | ##install |
4 | 4 |
|
5 | | -####If you have npm |
6 | | -1. npm install overload |
| 5 | +####If you have [npm](http://github.com/isaacs/npm) |
| 6 | +> npm install overload |
7 | 7 |
|
8 | 8 | ####Raw |
9 | | -1. run __make__ |
10 | | -2. files are in lib directory |
| 9 | +> make |
| 10 | +
|
| 11 | +Files are in __lib__ directory |
11 | 12 |
|
12 | 13 | ##exports |
13 | 14 |
|
14 | 15 | ####overload.node |
15 | 16 |
|
16 | | -* Watchable(onGet,onSet,onForeach,onQuery,onDelete) |
17 | | - |
18 | | - Callback's can use the __this__ object in order to act normally without reinvoking themselves. |
19 | | - |
20 | | -* * Value onGet(ArgInfo) - property |
21 | | - |
22 | | - Returns the value at a specific index |
23 | | -* * Value onSet(ArgInfo) - property, value |
24 | | - |
25 | | - Returns the value to save at a specific index |
26 | | -* * Array onForeach(ArgInfo) |
| 17 | +> ##Watchable(onGet,onSet,onForeach,onQuery,onDelete) |
| 18 | +> Callback's can use the __this__ object in order to act normally without reinvoking themselves. |
| 19 | +> |
| 20 | +> * Value onGet(ArgInfo) - property |
27 | 21 |
|
28 | | - Returns an array containing all the index keys for this object |
29 | | -* * Boolean onQuery(ArgInfo) - property |
| 22 | +> Returns the value at a specific index |
| 23 | +> * Value onSet(ArgInfo) - property, value |
30 | 24 |
|
31 | | - Returns whether the object has a specific index |
32 | | -* * Boolean onDelete(ArgInfo) - property |
| 25 | +> Returns the value to save at a specific index |
| 26 | +> * Array onForeach(ArgInfo) |
33 | 27 |
|
34 | | - Returns whether the object was successful in deleting a specific index |
| 28 | +> Returns an array containing all the index keys for this object |
| 29 | +> * Boolean onQuery(ArgInfo) - property |
35 | 30 |
|
36 | | -* * ArgInfo Values - holder thisObject property? value? |
| 31 | +> Returns whether the object has a specific index |
| 32 | +> * Boolean onDelete(ArgInfo) - property |
37 | 33 |
|
38 | | -* RePrototype(obj,proto) |
39 | | - |
40 | | - Set obj's prototype to proto |
| 34 | +> Returns whether the object was successful in deleting a specific index |
| 35 | +> * ArgInfo Values - holder thisObject property? value? |
| 36 | +> |
| 37 | +> ## RePrototype(obj,proto) |
| 38 | +> |
| 39 | +> Set obj's prototype to proto |
41 | 40 |
|
42 | 41 | ####proxy.js |
43 | 42 |
|
44 | 43 | Partial implementation of ES Harmony Proxy API. |
45 | 44 |
|
46 | 45 | ####utils.js |
47 | 46 |
|
48 | | -* ReadOnly(obj,mask) |
49 | | - |
50 | | - Prevent an object from being modified w/ a setter. Methods on this object may still modify the object. |
51 | | - |
52 | | -* * mask - list of properties to intercept properties (useful to replace methods you dont want to modify the object) |
53 | | - |
54 | | -* * ReadOnly.ArrayMask |
55 | | - |
56 | | -* * ReadOnly.DateMask |
| 47 | +> ##ReadOnly(obj,mask) |
| 48 | +> |
| 49 | +> Prevent an object from being modified w/ a setter. Methods on this object may still modify the object. |
| 50 | +> |
| 51 | +> * mask - list of properties to intercept properties (useful to replace methods you dont want to modify the object) |
| 52 | +> * ReadOnly.ArrayMask - prevents Array Object from being modified by methods |
| 53 | +> * ReadOnly.DateMask - prevent Date Object from being modified by methods |
57 | 54 |
|
58 | 55 | ##example |
59 | 56 |
|
@@ -90,15 +87,15 @@ Partial implementation of ES Harmony Proxy API. |
90 | 87 |
|
91 | 88 | ##uses |
92 | 89 |
|
93 | | -* Watchable |
94 | | -1. Debugging - Show what is being accessed / set |
95 | | -2. False natives - refuse to allow properties to be set / got beyond a specified few |
96 | | -3. Dynamic programming - Fib[3] could compute Fib[1] and Fib[2] |
97 | | -4. Index based getters / setters - Fib[0] cannot have a getter set normally because it is a number not string based index (all non-number non-undefined values become string based). |
| 90 | +#### Watchable |
| 91 | +> 1. Debugging - Show what is being accessed / set |
| 92 | +> 2. False natives - refuse to allow properties to be set / got beyond a specified few |
| 93 | +> 3. Dynamic programming - Fib[3] could compute Fib[1] and Fib[2] |
| 94 | +> 4. Index based getters / setters - Fib[0] cannot have a getter set normally because it is a number not string based index (all non-number non-undefined values become string based). |
98 | 95 |
|
99 | | -* RePrototype |
100 | | -1. Making Watchables follow the instanceof operator |
101 | | -2. Making extensions of Objects follow the instanceof operator |
| 96 | +#### RePrototype |
| 97 | +> 1. Making Watchables follow the instanceof operator |
| 98 | +> 2. Making extensions of Objects follow the instanceof operator |
102 | 99 |
|
103 | | -* ReadOnly |
104 | | -1. Making arrays that cant be messed with |
| 100 | +#### ReadOnly |
| 101 | +> 1. Making arrays that cant be messed with |
0 commit comments