🐛 ⚡ isFIFO, css, tldr (#43)

Author: jaandrle

bin/info.mjs

@@ -87,7 +87,7 @@ export async function printCliUsage(){
 	echo(`%c${n} --eval`, css.T);
 	echo(`%c${n} --completion`, css.T);
 	echo(`%c${n} --inspect`, css.T);
-	echo(`%c${n} --man`, css.T);
+	echo(`%c${n} --tldr`, css.T);
 	echo("%cExamples%c:", css.H);
 	echo(`%c${n} ./script.js`, css.T);
 	echo(`%c${n} --help`, css.T);

docs/interfaces/EchoFunction.md

@@ -101,7 +101,7 @@ const css= style("@import './file.css'");
 
 #### Parameters
 
-• ...**styles**: (\`.$\{string\}\{ @import "$\{string\}" \}\` \| \`.$\{string\}\{ display: none; \}\` \| \`.$\{string\}\{ display: list-item; \}\` \| \`.$\{string\}\{ color: black; \}\` \| \`.$\{string\}\{ color: blue; \}\` \| \`.$\{string\}\{ color: cyan; \}\` \| \`.$\{string\}\{ color: gray; \}\` \| \`.$\{string\}\{ color: green; \}\` \| \`.$\{string\}\{ color: magenta; \}\` \| \`.$\{string\}\{ color: red; \}\` \| \`.$\{string\}\{ color: white; \}\` \| \`.$\{string\}\{ color: yellow; \}\` \| \`.$\{string\}\{ color: lightred; \}\` \| \`.$\{string\}\{ color: lightgreen; \}\` \| \`.$\{string\}\{ color: lightyellow; \}\` \| \`.$\{string\}\{ color: lightblue; \}\` \| \`.$\{string\}\{ color: lightmagenta; \}\` \| \`.$\{string\}\{ color: lightcyan; \}\` \| \`.$\{string\}\{ color: whitesmoke; \}\` \| \`.$\{string\}\{ background: black; \}\` \| \`.$\{string\}\{ background: blue; \}\` \| \`.$\{string\}\{ background: cyan; \}\` \| \`.$\{string\}\{ background: gray; \}\` \| \`.$\{string\}\{ background: green; \}\` \| \`.$\{string\}\{ background: magenta; \}\` \| \`.$\{string\}\{ background: red; \}\` \| \`.$\{string\}\{ background: white; \}\` \| \`.$\{string\}\{ background: yellow; \}\` \| \`.$\{string\}\{ background: lightred; \}\` \| \`.$\{string\}\{ background: lightgreen; \}\` \| \`.$\{string\}\{ background: lightyellow; \}\` \| \`.$\{string\}\{ background: lightblue; \}\` \| \`.$\{string\}\{ background: lightmagenta; \}\` \| \`.$\{string\}\{ background: lightcyan; \}\` \| \`.$\{string\}\{ background: whitesmoke; \}\` \| \`.$\{string\}\{ margin-left: $\{number\}; \}\` \| \`.$\{string\}\{ margin-right: $\{number\}; \}\` \| \`.$\{string\}\{ text-decoration: underline \}\` \| \`.$\{string\}\{ text-decoration: line-through \}\` \| \`.$\{string\}\{ list-style-type: $\{string\} \}\` \| \`.$\{string\}\{ unset: all; \}\` \| \`.$\{string\}\{ font-style: italic; \}\` \| \`.$\{string\}\{ font-weight: bold; \}\` \| \`.$\{string\}\{ animation: blink; \}\`)[]
+• ...**styles**: (\`.$\{string\}\{ @import "$\{string\}" \}\` \| \`.$\{string\}\{ display: none; \}\` \| \`.$\{string\}\{ display: list-item; \}\` \| \`.$\{string\}\{ color: black; \}\` \| \`.$\{string\}\{ color: blue; \}\` \| \`.$\{string\}\{ color: cyan; \}\` \| \`.$\{string\}\{ color: gray; \}\` \| \`.$\{string\}\{ color: green; \}\` \| \`.$\{string\}\{ color: magenta; \}\` \| \`.$\{string\}\{ color: red; \}\` \| \`.$\{string\}\{ color: white; \}\` \| \`.$\{string\}\{ color: yellow; \}\` \| \`.$\{string\}\{ color: rgb($\{number\} $\{number\} $\{number\}); \}\` \| \`.$\{string\}\{ color: rgb($\{number\}, $\{number\}, $\{number\}); \}\` \| \`.$\{string\}\{ color: lightred; \}\` \| \`.$\{string\}\{ color: lightgreen; \}\` \| \`.$\{string\}\{ color: lightyellow; \}\` \| \`.$\{string\}\{ color: lightblue; \}\` \| \`.$\{string\}\{ color: lightmagenta; \}\` \| \`.$\{string\}\{ color: lightcyan; \}\` \| \`.$\{string\}\{ color: whitesmoke; \}\` \| \`.$\{string\}\{ background: black; \}\` \| \`.$\{string\}\{ background: blue; \}\` \| \`.$\{string\}\{ background: cyan; \}\` \| \`.$\{string\}\{ background: gray; \}\` \| \`.$\{string\}\{ background: green; \}\` \| \`.$\{string\}\{ background: magenta; \}\` \| \`.$\{string\}\{ background: red; \}\` \| \`.$\{string\}\{ background: white; \}\` \| \`.$\{string\}\{ background: yellow; \}\` \| \`.$\{string\}\{ background: rgb($\{number\} $\{number\} $\{number\}); \}\` \| \`.$\{string\}\{ background: rgb($\{number\}, $\{number\}, $\{number\}); \}\` \| \`.$\{string\}\{ background: lightred; \}\` \| \`.$\{string\}\{ background: lightgreen; \}\` \| \`.$\{string\}\{ background: lightyellow; \}\` \| \`.$\{string\}\{ background: lightblue; \}\` \| \`.$\{string\}\{ background: lightmagenta; \}\` \| \`.$\{string\}\{ background: lightcyan; \}\` \| \`.$\{string\}\{ background: whitesmoke; \}\` \| \`.$\{string\}\{ margin-left: $\{number\}; \}\` \| \`.$\{string\}\{ margin-right: $\{number\}; \}\` \| \`.$\{string\}\{ text-decoration: underline \}\` \| \`.$\{string\}\{ text-decoration: line-through \}\` \| \`.$\{string\}\{ list-style-type: $\{string\} \}\` \| \`.$\{string\}\{ unset: all; \}\` \| \`.$\{string\}\{ font-style: italic; \}\` \| \`.$\{string\}\{ font-weight: bold; \}\` \| \`.$\{string\}\{ animation: blink; \}\`)[]
 
 #### Returns
 

docs/namespaces/$/functions/isFIFO.md

@@ -13,6 +13,12 @@ Method to check whether script stdin/stdout (0/1) is a first-in-first-out (FIFO)
 node pipes.js | … # — test by $.isFIFO(1)
 … | node pipes.js # — test by $.isFIFO(0)
 ```
+…more precisely:
+```javascript
+import { stdin, stdout } from "node:process";
+echo($.isFIFO(stdin.fd), $.isFIFO(stdout.fd));
+```
+⚠️ On Windows it can throw an error (see https://github.com/jaandrle/nodejsscript/issues/42)!
 
 ## Parameters
 

docs/namespaces/$/variables/stdin.md

@@ -8,10 +8,11 @@
 
 > `const` **stdin**: [`STDIN`](../interfaces/STDIN.md)
 
-Holding `stdin` when script was executed.
+Holding `stdin` when script was executed with pipe.
 ```bash
 echo TEST | nodejsscript script.js
 ```
 ```javascript
 echo($.stdin.text());//= "TEST"
 ```
+…but it can be empty in case of platform specific error (see [$.isFIFO](../functions/isFIFO.md)).

docs/namespaces/fetch/classes/Headers.md

@@ -120,37 +120,37 @@ In all methods of this interface, header names are matched by case-insensitive b
 
 ### entries()
 
-> **entries**(): `IterableIterator`\<[`string`, `string`]\>
+> **entries**(): `IterableIterator`\<[`string`, `string`], `any`, `any`\>
 
 Returns an iterator allowing to go through all key/value pairs contained in this object.
 
 #### Returns
 
-`IterableIterator`\<[`string`, `string`]\>
+`IterableIterator`\<[`string`, `string`], `any`, `any`\>
 
 ***
 
 ### keys()
 
-> **keys**(): `IterableIterator`\<`string`\>
+> **keys**(): `IterableIterator`\<`string`, `any`, `any`\>
 
 Returns an iterator allowing to go through all keys of the key/value pairs contained in this object.
 
 #### Returns
 
-`IterableIterator`\<`string`\>
+`IterableIterator`\<`string`, `any`, `any`\>
 
 ***
 
 ### values()
 
-> **values**(): `IterableIterator`\<`string`\>
+> **values**(): `IterableIterator`\<`string`, `any`, `any`\>
 
 Returns an iterator allowing to go through all values of the key/value pairs contained in this object.
 
 #### Returns
 
-`IterableIterator`\<`string`\>
+`IterableIterator`\<`string`, `any`, `any`\>
 
 ***
 
@@ -168,8 +168,8 @@ Node-fetch extension
 
 ### \[iterator\]()
 
-> **\[iterator\]**(): `IterableIterator`\<[`string`, `string`]\>
+> **\[iterator\]**(): `IterableIterator`\<[`string`, `string`], `any`, `any`\>
 
 #### Returns
 
-`IterableIterator`\<[`string`, `string`]\>
+`IterableIterator`\<[`string`, `string`], `any`, `any`\>

docs/namespaces/s/classes/ProcessOutput.md

@@ -108,39 +108,47 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
 
 ### stdout
 
-> `get` **stdout**(): `string`
+#### Get Signature
 
-#### Returns
+> **get** **stdout**(): `string`
+
+##### Returns
 
 `string`
 
 ***
 
 ### stderr
 
-> `get` **stderr**(): `string`
+#### Get Signature
 
-#### Returns
+> **get** **stderr**(): `string`
+
+##### Returns
 
 `string`
 
 ***
 
 ### exitCode
 
-> `get` **exitCode**(): `number`
+#### Get Signature
 
-#### Returns
+> **get** **exitCode**(): `number`
+
+##### Returns
 
 `number`
 
 ***
 
 ### signal
 
-> `get` **signal**(): `Signals`
+#### Get Signature
 
-#### Returns
+> **get** **signal**(): `Signals`
+
+##### Returns
 
 `Signals`
 

docs/namespaces/s/classes/ProcessPromise.md

@@ -64,29 +64,35 @@ and a reject callback used to reject the promise with a provided reason or error
 
 ### stdin
 
-> `get` **stdin**(): `Writable`
+#### Get Signature
 
-#### Returns
+> **get** **stdin**(): `Writable`
+
+##### Returns
 
 `Writable`
 
 ***
 
 ### stdout
 
-> `get` **stdout**(): `Readable`
+#### Get Signature
 
-#### Returns
+> **get** **stdout**(): `Readable`
+
+##### Returns
 
 `Readable`
 
 ***
 
 ### stderr
 
-> `get` **stderr**(): `Readable`
+#### Get Signature
 
-#### Returns
+> **get** **stderr**(): `Readable`
+
+##### Returns
 
 `Readable`
 
@@ -107,7 +113,7 @@ resolve, or rejected when any Promise is rejected.
 
 ##### Parameters
 
-• **values**: `Iterable`\<`T` \| `PromiseLike`\<`T`\>\>
+• **values**: `Iterable`\<`T` \| `PromiseLike`\<`T`\>, `any`, `any`\>
 
 An iterable of Promises.
 
@@ -165,7 +171,7 @@ or rejected.
 
 ##### Parameters
 
-• **values**: `Iterable`\<`T` \| `PromiseLike`\<`T`\>\>
+• **values**: `Iterable`\<`T` \| `PromiseLike`\<`T`\>, `any`, `any`\>
 
 An iterable of Promises.
 
@@ -350,7 +356,7 @@ of the provided Promises resolve or reject.
 
 ##### Parameters
 
-• **values**: `Iterable`\<`T` \| `PromiseLike`\<`T`\>\>
+• **values**: `Iterable`\<`T` \| `PromiseLike`\<`T`\>, `any`, `any`\>
 
 An array of Promises.
 

docs/namespaces/s/interfaces/ShellReturnValue.md

@@ -24,6 +24,12 @@ Returns a string containing the given pipeline, or a concatenated string
 containing the pipelines if more than one input stream is given
 (a new line character is introduced between each input).
 
+#### Returns
+
+A string containing the given pipeline, or a concatenated string
+        containing the pipelines if more than one input stream is given
+        (a new line character is introduced between each input).
+
 ***
 
 ### exec
@@ -44,6 +50,11 @@ Silence and synchronous options.
 
 Receives code and output asynchronously.
 
+#### Returns
+
+Returns an object containing the return code and output as string,
+        or if `{async: true}` or a `callback` was passed, a `ChildProcess`.
+
 ***
 
 ### head
@@ -72,6 +83,10 @@ Available options:
 
 The regular expression to use.
 
+#### Returns
+
+Returns a string containing all lines of the file that match the given `regex_filter`.
+
 ***
 
 ### sed
@@ -94,6 +109,10 @@ The regular expression to use for search.
 
 The replacement.
 
+#### Returns
+
+The new string after replacement.
+
 ***
 
 ### sort

docs/namespaces/s/interfaces/ShellReturnValueNJS.md

@@ -66,6 +66,12 @@ Returns a string containing the given pipeline, or a concatenated string
 containing the pipelines if more than one input stream is given
 (a new line character is introduced between each input).
 
+#### Returns
+
+A string containing the given pipeline, or a concatenated string
+        containing the pipelines if more than one input stream is given
+        (a new line character is introduced between each input).
+
 #### Inherited from
 
 [`ShellReturnValue`](ShellReturnValue.md).[`cat`](ShellReturnValue.md#cat)
@@ -90,6 +96,11 @@ Silence and synchronous options.
 
 Receives code and output asynchronously.
 
+#### Returns
+
+Returns an object containing the return code and output as string,
+        or if `{async: true}` or a `callback` was passed, a `ChildProcess`.
+
 #### Inherited from
 
 [`ShellReturnValue`](ShellReturnValue.md).[`exec`](ShellReturnValue.md#exec)
@@ -126,6 +137,10 @@ Available options:
 
 The regular expression to use.
 
+#### Returns
+
+Returns a string containing all lines of the file that match the given `regex_filter`.
+
 #### Inherited from
 
 [`ShellReturnValue`](ShellReturnValue.md).[`grep`](ShellReturnValue.md#grep)
@@ -152,6 +167,10 @@ The regular expression to use for search.
 
 The replacement.
 
+#### Returns
+
+The new string after replacement.
+
 #### Inherited from
 
 [`ShellReturnValue`](ShellReturnValue.md).[`sed`](ShellReturnValue.md#sed)