]> granicus.if.org Git - jq/commitdiff
I should probably document select and empty :) (#29, #5)
authorStephen Dolan <mu@netsoc.tcd.ie>
Mon, 22 Oct 2012 22:14:34 +0000 (23:14 +0100)
committerStephen Dolan <mu@netsoc.tcd.ie>
Mon, 22 Oct 2012 22:14:34 +0000 (23:14 +0100)
docs/content/3.manual/manual.yml

index 9039caf52319e1c26417abbbeef7d8e5e128d49a..5981ce42b4ac251f486d72cec6be372952608473 100644 (file)
@@ -390,6 +390,36 @@ sections:
             input: '{"abc": 1, "abcd": 2, "Foo": 3}'
             output: ['["Foo", "abc", "abcd"]']
 
+      - title: `select`
+        body: |
+          
+          The function `select(foo)` produces its input unchanged if
+          `foo` returns true for that input, and produces no output
+          otherwise.
+
+          It's useful for filtering lists: `[1,2,3] | select(. >= 2)`
+          will give you `[3]`.
+
+        examples:
+          - program: 'select(. >= 2)'
+            input: '[1,5,3,0,7]'
+            output: ['[5,3,7]']
+
+      - title: `empty`
+        body: |
+          
+          `empty` returns no results. None at all. Not even `null`.
+
+          It's useful on occasion. You'll know if you need it :)
+
+        examples:
+          - program: '1, empty, 2'
+            input: 'null'
+            output: [1,2]
+          - program: '[1,2,empty,3]'
+            input: 'null'
+            output: ['[1,2,3]']
+
       - title: `map(x)`
         body: |