| Overview |  |
jsxarray() = [value()] | [{}]
key() = integer() | map_key()
map_key() = binary() | atom()
object() = [{map_key(), value()}] | #{}
value() = binary() | number() | object() | jsxarray() | null | true | false
| append/3 | Appends a value to a jsxd structure. |
| delete/2 | Deletes a value from a jsxd structure, the key behaves the same way os it does for get/2. |
| fold/3 | Folds over an jsxd structure. |
| from_list/1 | Converts a tuple list (or 'array' list) to a object jsxd understands. |
| get/2 | Gets a possibly nested key in a jsxd structure, if the key is a binary it is assumed to be 'unparsed' and will be translated. |
| get/3 | Gets a possibly nested key in a jsxd structure, if the key is a binary it is assumed to be 'unparsed' and will be translated. |
| map/2 | Maps each value of a jsxd structure using a function. |
| merge/2 | Merges two objects, where the 2nd objects overwrites values in the first object. |
| merge/3 | Merges two objects, using a given function to resolve conflicts. |
| new/0 | Creates an empty jsxd structure. |
| prepend/3 | Prepends a value to a jsxd structure. |
| select/2 | Selects a set of key from a jsxd structure, discarding all others. |
| set/3 | Sets a value of a jsxd structure, the key behaves the same way os it does for get/2. |
| thread/2 | Threads mutliple changes to jsxd structure, the result from the nth opperation is passed in as new object in the nth+1 opperation. |
| update/3 | Updates a value from a jsxd structure using a function, the key behaves the same way os it does for get/2. |
| update/4 | Updates a value from a jsxd structure using a function, the key behaves the same way os it does for get/2. |
append(Keys, Value, Obj) -> any()
Appends a value to a jsxd structure. The value appended to must be either undefined or a 'array'.
delete(Key, Obj) -> any()
Deletes a value from a jsxd structure, the key behaves the same way os it does for get/2.
fold(FoldFn, Acc0, Obj) -> any()
Folds over an jsxd structure.
The key is either the map key or the array index.Converts a tuple list (or 'array' list) to a object jsxd understands.
Maps can be passed in directly without needing conversion.get(Key::keys(), Obj::object() | jsxarray()) -> {ok, value()} | undefined
Gets a possibly nested key in a jsxd structure, if the key is a binary it is assumed to be 'unparsed' and will be translated.
To set a single binary key direcntly pass in [Key].
If the key is not found undefined is returned.get(Key::keys(), Default::value(), Obj::object() | jsxarray()) -> value()
Gets a possibly nested key in a jsxd structure, if the key is a binary it is assumed to be 'unparsed' and will be translated.
To set a single binary key direcntly pass in [Key].
If the key is not found the default value is returned.map(MapFn, Obj) -> any()
Maps each value of a jsxd structure using a function.
The key is either the map key or the array index. However while passed into the function the key can not be changed.Merges two objects, where the 2nd objects overwrites values in the first object.
The object can not be an array.merge(ConflictFn, Obj1, Obj2) -> any()
Merges two objects, using a given function to resolve conflicts.
The object can not be an array.new() -> jsxarray() | object()
Creates an empty jsxd structure.
prepend(Keys, Value, Obj) -> any()
Prepends a value to a jsxd structure. The value appended to must be either undefined or a 'array'.
Selects a set of key from a jsxd structure, discarding all others. This does not work in nested fasion!
set(Key, Val, Obj) -> any()
Sets a value of a jsxd structure, the key behaves the same way os it does for get/2.
thread(As, Obj) -> any()
Threads mutliple changes to jsxd structure, the result from the nth opperation is passed in as new object in the nth+1 opperation.
update(Keys, UpdateFn, Obj) -> any()
Updates a value from a jsxd structure using a function, the key behaves the same way os it does for get/2.
If the key does not exist no change is applied.update(Keys, UpdateFn, Default, Obj) -> any()
Updates a value from a jsxd structure using a function, the key behaves the same way os it does for get/2.
If the key does not exist the default value is set as new value.Generated by EDoc, Sep 20 2016, 06:40:55.