@mschaeffler/node-red-fsatomic

Node-Red nodes for atomic file operations.

If the msg property invalid is present in the message, all nodes ignore the message.

Install

$ npm install @mschaeffler/node-red-fsatomic

fileWriteAtomic

With this node data can be written into a file in an atomic manner, so that there is either the old file ort the new file, but never no file.

There is a locking mechanism: If data is written to a file, while the last writing is still processed, the 2nd request is discarded.

Input

|msg. | type | description | |:-------|:-------|:--------------| |payload|buffer, number, string, object| value to be written to the file.| |filename|string| name of the file, if the parameter filename is empty.| |encoding|string| encoding for the file, if the parameter encoding is msg.encoding.|

Parameters

|config| type | description | |:-----|:-------|:----------------------------------| |filename|string| file name; if set to "", the file name is set by the input message (msg.filename).| |encoding|string| encoding, only the encodings integrated into nodejs are possible. If set to msg.encoding, the encoding is taken from the input message.| |append new line|boolean| append an end of line to the payload.| |create dir|boolean| create the directory, if it does not exist.| |pretty json|boolean| in case of msg.payload beeing an Object, the JSON is formated in a human readable manner.| |Status|boolean|shows the actual value as a node status.|

fileReadSimple

With this node data can be read from a file in way similar to the fileWriteAtomic node.

Input

|msg. | type | description | |:-------|:-------|:--------------| |filename|string| name of the file, if the parameter filename is empty.| |encoding|string| encoding for the file, if the parameter encoding is msg.encoding.|

Output

|msg. | type | description | |:-------|:-------|:--------------| |payload|string, object or buffer| content of the file.| |filename|string| name of the file.| |encoding|string| encoding for the file.|

Parameters

|config| type | description | |:-----|:-------|:----------------------------------| |filename|string| file name; if set to "", the file name is set by the input message (msg.filename).| |encoding|string| encoding, only the encodings integrated into nodejs are possible. If set to msg.encoding, the encoding is taken from the input message.| |Format|boolean| Data format of msg.payload: raw Buffer, String or parsed JSON. |Status|boolean|shows the actual value as a node status.|

Example Flow

example flow

Author

Mathias Schäffler

License

LGPL-2.1