iterable-string-interceptor 1.0.11 → 1.0.12

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2018-2021 by arlac77
+Copyright (c) 2018-2022 by arlac77
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/README.md

@@ -18,11 +18,12 @@ Intercept Iterable string - backbone for templates
 ```javascript
 import { iterableStringInterceptor } from "iterable-string-interceptor";
 import { createReadStream } from "fs";
+import { readFile } from "fs/promises";
 
 // double values inside {{}}
 // {{7}} -> 14
 for await (const chunk of iterableStringInterceptor(createReadStream('aFile', { encoding: "utf8" }),
-async * (expression) => { yield expression * 2; }
+  expression => expression * 2
 )) {
   process.stdout.write(chunk);
 }
@@ -30,11 +31,12 @@ async * (expression) => { yield expression * 2; }
 
 ```javascript
 import { iterableStringInterceptor } from "iterable-string-interceptor";
-import fs,{ createReadStream } from "fs";
+import { createReadStream } from "fs";
+import { readFile } from "fs/promises";
 
 // handle expression as to be included content {{filename}}
 for await (const chunk of iterableStringInterceptor(createReadStream('aFile', { encoding: "utf8" }),
-async * (expression) => { yield fs.promises.readFile(expression,{encoding: "utf8"}); }
+  async * (expression) => { yield readFile(expression, { encoding: "utf8" }); }
 )) {
   process.stdout.write(chunk);
 }
@@ -70,7 +72,7 @@ Returns **Iterable<[string](https://developer.mozilla.org/docs/Web/JavaScript/Re
 
 ## EarlyConsumerCallback
 
-will be called from the ExpressionTransformer if the given remainder needs to be altered
+Will be called from the ExpressionTransformer if the given remainder needs to be altered.
 
 Type: ()
 
@@ -80,8 +82,8 @@ Type: ()
 
 ## iterableStringInterceptor
 
-intercept into a async iterable string source detecting lead in/outs like '{{' and '}}'
-and asking a transformer for a replacement iterable string
+Intercept into a async iterable string source, detecting lead in/outs like '{{' and '}}'
+and asking a transformer for a replacement iterable string.
 
 ### Parameters
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iterable-string-interceptor",
-  "version": "1.0.11",
+  "version": "1.0.12",
   "publishConfig": {
     "access": "public"
   },
@@ -29,13 +29,13 @@
     "lint:docs": "documentation lint ./src/**/*.mjs"
   },
   "devDependencies": {
-    "ava": "^3.15.0",
-    "c8": "^7.7.3",
+    "ava": "^4.0.1",
+    "c8": "^7.11.0",
     "documentation": "^13.2.5",
-    "semantic-release": "^17.4.4"
+    "semantic-release": "^19.0.2"
   },
   "engines": {
-    "node": ">=14.17.2"
+    "node": ">=14.18.3"
   },
   "repository": {
     "type": "git",

package/src/iterable-string-interceptor.mjs

@@ -10,14 +10,14 @@
  */
 
 /**
- * will be called from the ExpressionTransformer if the given remainder needs to be altered
+ * Will be called from the ExpressionTransformer if the given remainder needs to be altered.
  * @typedef {()} EarlyConsumerCallback
  * @param {string} remainder new remainder to be used by iterableStringInterceptor
  */
 
 /**
- * intercept into a async iterable string source detecting lead in/outs like '{{' and '}}'
- * and asking a transformer for a replacement iterable string
+ * Intercept into a async iterable string source, detecting lead in/outs like '{{' and '}}'
+ * and asking a transformer for a replacement iterable string.
  * @param {Iterable<string>} source
  * @param {ExpressionTransformer} transform
  * @param {string} leadIn expression entry sequence