diff options
author | Stephen Dolan <mu@netsoc.tcd.ie> | 2013-05-13 16:15:49 +0100 |
---|---|---|
committer | Stephen Dolan <mu@netsoc.tcd.ie> | 2013-05-13 16:15:49 +0100 |
commit | a625d2821ecb27b87266762545f88d7d4aa59d31 (patch) | |
tree | 82fb4a6e7920673fa7a2570178f22cc47dc07d37 /docs | |
parent | d8706fd4607ee1b5b56debd4da39e3314739f126 (diff) |
Add to_entries, from_entries and with_entries functions.
Closes #97.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/3.manual/manual.yml | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/content/3.manual/manual.yml b/docs/content/3.manual/manual.yml index 2f36392c..766fef7b 100644 --- a/docs/content/3.manual/manual.yml +++ b/docs/content/3.manual/manual.yml @@ -478,6 +478,31 @@ sections: input: '[[0,1], ["a","b","c"]]' output: ['[false, true]'] + - title: `to_entries`, `from_entries`, `with_entries` + body: | + + These functions convert between an object and an array of + key-value pairs. If `to_entries` is passed an object, then + for each `k: v` entry in the input, the output array + includes `{"key": k, "value": v}`. + + `from_entries` does the opposite conversion, and + `with_entries(foo)` is a shorthand for `to_entries | + map(foo) | from_entries`, useful for doing some operation to + all keys and values of an object. + + examples: + - program: 'to_entries' + input: '[{"a": 1}, {"b": 2}]' + output: ['[{"key":"a", "value":1}, {"key":"b", "value":2}]'] + - program: 'from_entries' + input: '[{"key":"a", "value":1}, {"key":"b", "value":2}]' + output: ['[{"a": 1}, {"b": 2}]'] + - program: 'with_entries(.key |= "KEY_" + .)' + input: '[{"a": 1}, {"b": 2}]' + output: ['[{"KEY_a": 1}, {"KEY_b": 2}]'] + + - title: `select` body: | |