mirror of
https://github.com/chylex/objtree.git
synced 2025-06-02 06:34:11 +02:00
Add an example to readme
This commit is contained in:
parent
0bbcf33ccb
commit
f1a6f08983
61
README.md
61
README.md
@ -4,6 +4,7 @@
|
|||||||
|
|
||||||
```js
|
```js
|
||||||
var target = {};
|
var target = {};
|
||||||
|
|
||||||
var result = objtree(target, {
|
var result = objtree(target, {
|
||||||
// Maximum level of recursion
|
// Maximum level of recursion
|
||||||
maxlevel: 10,
|
maxlevel: 10,
|
||||||
@ -22,6 +23,62 @@ result.asText(); // returns a formatted text representation
|
|||||||
result.downloadText(filename); // triggers a browser file download with the formatted text
|
result.downloadText(filename); // triggers a browser file download with the formatted text
|
||||||
```
|
```
|
||||||
|
|
||||||
# Examples
|
# Example
|
||||||
|
|
||||||
TODO
|
```js
|
||||||
|
var target = {
|
||||||
|
testBool: true,
|
||||||
|
testInt: 15,
|
||||||
|
testFloat: -3.6,
|
||||||
|
testString: "text",
|
||||||
|
testFunction: function(a, b, c){},
|
||||||
|
testArray1: [ 1, 2, true, "abc" ],
|
||||||
|
testArray2: [
|
||||||
|
{ hi: "there" },
|
||||||
|
[ 0, 1, [false] ]
|
||||||
|
],
|
||||||
|
testObject: {
|
||||||
|
abc: [ 1, 2 ]
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
target.testObject["testSpecial-Name!"] = null;
|
||||||
|
|
||||||
|
function MyClass(){}
|
||||||
|
|
||||||
|
MyClass.CONSTANT = true;
|
||||||
|
MyClass.data = 10;
|
||||||
|
MyClass.prototype.a = function(){};
|
||||||
|
MyClass.prototype.b = function(){};
|
||||||
|
|
||||||
|
target["testClass"] = MyClass;
|
||||||
|
```
|
||||||
|
|
||||||
|
Calling `objtree(target).asText()` with no additional settings yields (ordered by type and then name):
|
||||||
|
|
||||||
|
```
|
||||||
|
OBJECT TREE
|
||||||
|
===========
|
||||||
|
|-- testArray2
|
||||||
|
|-- testArray2['0']
|
||||||
|
|-- [var] testArray2['0'].hi > there
|
||||||
|
|-- testArray2['1']
|
||||||
|
|-- [arr] testArray2['1']['2'] > [ false ]
|
||||||
|
|-- [var] testArray2['1']['0'] > 0
|
||||||
|
|-- [var] testArray2['1']['1'] > 1
|
||||||
|
|-- testObject
|
||||||
|
|-- [arr] testObject.abc > [ 1, 2 ]
|
||||||
|
|-- [var] testObject['testSpecial-Name!'] > (null)
|
||||||
|
|-- [fun] testClass()
|
||||||
|
|-- testClass.prototype
|
||||||
|
|-- [fun] testClass.prototype['a']()
|
||||||
|
|-- [fun] testClass.prototype['b']()
|
||||||
|
|-- [var] testClass.CONSTANT > true
|
||||||
|
|-- [var] testClass.data > 10
|
||||||
|
|-- [fun] testFunction(a, b, c)
|
||||||
|
|-- [arr] testArray1 > [ 1, 2, true, abc ]
|
||||||
|
|-- [var] testBool > true
|
||||||
|
|-- [var] testFloat > -3.6
|
||||||
|
|-- [var] testInt > 15
|
||||||
|
|-- [var] testString > text
|
||||||
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user