added docs for storage-read

README.md

@@ -8,7 +8,7 @@ that it takes a service account credential token as configuration.
 
 This means that the nodes can run outside of the normal security rules, in admin mode, which is usefule when running on the back-end.
 
-The configuration needs two parameters, the first is the text of the service account credentials private key file. This can be found by going to the firebase console, then to the cogwheel icon at the top left then to project settings and then 'Service Accounts'. Click 'Generate new private key)'.
+The configuration needs two parameters, the first is the text of the service account credentials private key file. This can be found by going to the firebase console, then to the cogwheel icon at the top left then to project settings and then "Service Accounts". Click "Generate new private key)".
 The second parameter is the database url for the database, and th url has the format of "https://myprojectname.firebaseio.com" and can also be fpund in the above place in the firebase console.
 
 # Realtime Database (rtdb) Nodes
@@ -16,12 +16,12 @@ The second parameter is the database url for the database, and th url has the fo
 ## rtdb-get
 Get data from a path in the rtdb database
 
-input: {payload: {path: 'foo/bar'}}
+input: {"payload": {"path": "foo/bar"}}
 
-output: <whatever data was at the path 'foo/bar' in the rtdb database>
+output: <whatever data was at the path "foo/bar" in the rtdb database>
 
 ## rtdb-set
-Set data at a path in the rtdb database. Use 'on' snapshot so will fire every time the data at the path changes and so drive flow execution from that point.
+Set data at a path in the rtdb database. Use "on" snapshot so will fire every time the data at the path changes and so drive flow execution from that point.
 
 ## rtdb-push
 Pushes the new object onto an array under the path
@@ -29,18 +29,18 @@ Pushes the new object onto an array under the path
 ## rtdb-query
 Set up a reactive query for a path in the rtdb database. 
 
-input: {payload: {path: 'foo/bar', queries:[], on: 'value}}
+input: {"payload": {"path": "foo/bar", queries:[], on: "value}}
 
-on: 'value' (can also be 'child_added', 'child_removed', 'child_changed', 'child_moved'). 
-If an 'on' property is missing, on: 'value' is assumed as default
+on: "value" (can also be "child_added", "child_removed", "child_changed", "child_moved"). 
+If an "on" property is missing, on: "value" is assumed as default
 
 Where each query is an object that can look like either of the following examples;
     
-- {startAt: 'foo'}
-- {endAt: 'bar'}
-- {equalTo: 'quux'}
-- {orderBy: 'child', value: 'height'}  (can also be 'key' or 'value)
-- {limitTo: 'last', value: 3}  (can also be 'first')
+- {"startAt": "foo"}
+- {"endAt": "bar"}
+- {"equalTo": "quux"}
+- {"orderBy": "child", "value": "height"}  (can also be "key" or "value)
+- {"limitTo": "last", "value": 3}  (can also be "first")
 
 output: [an array of results for the query]
 
@@ -50,19 +50,20 @@ output: [an array of results for the query]
 ## firestore-get
 Get data from a document path in the firestore database
 
-input: {payload: {path: 'foo/bar'}}
+input: {"payload": {"path": "foo/bar"}}
 
-output: <the document at the path 'foo/bar' in the firestore database>
+output: <the document at the path "foo/bar" in the firestore database>
 
 ## firestore-set
-Set data at a path in the firestore database. Uses 'onSnapshot' so will fire every time the data at the path changes and so drive flow execution from that point.
+Set data at a path in the firestore database. Uses "onSnapshot" so will fire every time the data at the path changes and so drive flow execution from that point.
 
-input: {payload: {path: 'foo/bar'}, {some: 'object', foo: 17}}
+input: {"payload": {"path": "foo/bar"}, {"some": object, "foo": 17}}
 
 ## firestore-add
 Adds the new object under the collection the path describes and assigns it a random id
 
-input: {payload: {path: 'foo/bar'}, {some: 'object', foo: 17}}
+input: {"payload": {"path": "foo/bar"}, {"some": object, "foo": 17}}
+
 output: The id of the new document
 
 ## firestore-query
@@ -71,15 +72,15 @@ Set up a reactive query for a collection in the firestore database.
 input: 
 
     {
-        payload: {
-            path: 'foo/bar', 
-            queries:[], 
-            limit: 7, 
-            startAt: 4000,  // follows the orderBy property
-            endAt: 4050, // follows the orderBy property
-            orderBy: 'shoeSize',
-            orderDirection: 'asc', //default is 'desc'
-            queries:[
+        "payload": {
+            "path": "foo/bar", 
+            "queries":[], 
+            "limit": 7, 
+            "startAt": 4000,  // follows the orderBy property
+            "endAt": 4050, // follows the orderBy property
+            "orderBy": "shoeSize",
+            "orderDirection": "asc", //default is "desc"
+            "queries":[
                 {"company", "==", "ACME"},
                 {"createdAt", ">", 1560099394242}
             ]
@@ -90,7 +91,14 @@ output: An array of the results of the query.
 
 # Storage nodes
 
-TBD
+## storage-read
+Read file data from a file at a given path under a given cloud storage bucket. The default bucket to be used can be set in the general firebase SDK settings.
+If the payload defines an optional bucket property, it will override the default bucket settings.
+
+input: {"payload":{"bucket": "xyzzyz123.appspot.com", "path": "myFile.txt"}}
+
+output: Buffer[]  containing the binary file contents
+ 
 
 # Auth nodes
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-firebase-admin",
-  "version": "1.0.6",
+  "version": "1.0.65",
   "description": "A node-red module that wraps the server-side  admin SDK of firebase, firestore, et.c.",
   "main": "index.js",
   "scripts": {