Ruakij/rfmon-to-influx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Changed documentation to remarks section

Browse Source
This commit is contained in:
Ruakij 2021-11-25 03:14:24 +01:00
parent 450f162cda
commit cf1b300f6a
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/streamHandler/RegexBlockStream.js
View File

@ -10,9 +10,10 @@ class RegexBlockStream extends Transform{
matchAllOnFlush; matchAllOnFlush;
/** /**
* @param {RegExp} matcher Block-match - WARNING: It should match a clean-block (including e.g. newline)! Otherwise buffer will get dirty and use more and more ressources. * @param {RegExp} matcher Block-match
* @param {boolean} withholdLastBlock When true, the last matches block will not be submitted to prevent submitting incomplete blocks. * @param {boolean} withholdLastBlock When true, the last matches block will not be submitted to prevent submitting incomplete blocks.
* @param {boolean} matchAllOnFlush (Only in combination with withholdLastBlock) When enabled, the buffer will be matched on last time on _flush (stream deconstruction) and write any, also incomplete, blocks * @param {boolean} matchAllOnFlush (Only in combination with withholdLastBlock) When enabled, the buffer will be matched on last time on _flush (stream deconstruction) and write any, also incomplete, blocks
* @remarks WARNING: It should match a clean-block (including e.g. newline)! Otherwise buffer will get dirty and use more and more ressources.
*/ */
constructor(matcher, withholdLastBlock = true, matchAllOnFlush = false){ constructor(matcher, withholdLastBlock = true, matchAllOnFlush = false){
super({ super({