diff --git a/Documentation/assets/highlight.css b/Documentation/assets/highlight.css index 73d65e85..a99bf376 100644 --- a/Documentation/assets/highlight.css +++ b/Documentation/assets/highlight.css @@ -9,16 +9,6 @@ --dark-hl-3: #569CD6; --light-hl-4: #0451A5; --dark-hl-4: #9CDCFE; - --light-hl-5: #0070C1; - --dark-hl-5: #4FC1FF; - --light-hl-6: #008000; - --dark-hl-6: #6A9955; - --light-hl-7: #EE0000; - --dark-hl-7: #D7BA7D; - --light-hl-8: #001080; - --dark-hl-8: #9CDCFE; - --light-hl-9: #AF00DB; - --dark-hl-9: #C586C0; --light-code-background: #FFFFFF; --dark-code-background: #1E1E1E; } @@ -29,11 +19,6 @@ --hl-2: var(--light-hl-2); --hl-3: var(--light-hl-3); --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); --code-background: var(--light-code-background); } } @@ -43,11 +28,6 @@ --hl-2: var(--dark-hl-2); --hl-3: var(--dark-hl-3); --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); --code-background: var(--dark-code-background); } } @@ -57,11 +37,6 @@ --hl-2: var(--light-hl-2); --hl-3: var(--light-hl-3); --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); --code-background: var(--light-code-background); } @@ -71,11 +46,6 @@ --hl-2: var(--dark-hl-2); --hl-3: var(--dark-hl-3); --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); --code-background: var(--dark-code-background); } @@ -84,9 +54,4 @@ .hl-2 { color: var(--hl-2); } .hl-3 { color: var(--hl-3); } .hl-4 { color: var(--hl-4); } -.hl-5 { color: var(--hl-5); } -.hl-6 { color: var(--hl-6); } -.hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } pre, code { background: var(--code-background); } diff --git a/Documentation/assets/navigation.js b/Documentation/assets/navigation.js index a412b0a7..59e0509a 100644 --- a/Documentation/assets/navigation.js +++ b/Documentation/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACq2SvQ6CMBSF36UzkQSNA6MJDA4y4EYIgfYi1VIItgZjfHcLKmr46+Dac/rdc09ucEMCaoFs5NSApaAFN/fXEnxc0VI4/kZSRpCBylhkypQXRDI4m5056pkXmciZ+nGinCDbMhDO1GsFHNlBeDe6ea7kuB03MuKtR7PUDkkAyhyqA3xo6YvS43XeX/J69RWRQBpLJrRorXOCBaoxDVBj61EGa3Mpg4nWGlmztPklW9jYjoPptr63m0jXyH9L18J00nnJEbAwR6/6qUcahzye7xJXNE4GaIMBl5YKGD4ADt2nkoUDAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACq2TvQ6CMBhF36UzsQkaB0YTHRx0wM2QBsqnVMtPamswxncXquIPFoS4Nveee/IlXZ+RhFwiB7mpEhTwNAeqJEsTvDpl4FLBMjl1J4rxEFko82VUZOM0VBwO+NYhVYfUOoNIxrwo7lkSIse2EI2KVwEJctbexfpcn6mE6vHmwUeMtG5UA6Xjk7e5A0zEMv2OHY9ebEOALAaxhd+JVaURu/EVl12gulBDNl32/RCmw9YPYLhrB2fN7KM8YxzalcvUv5U1s4/y3F0u2pXL1L+VNbOD8jLYAZW47Y/fYuSHb22WPvqC+YEZ+tV6aBfW3hWdyfaLqAQAAA==" \ No newline at end of file diff --git a/Documentation/assets/search.js b/Documentation/assets/search.js index 961e5699..e6929fb9 100644 --- a/Documentation/assets/search.js +++ b/Documentation/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACq1VS2+cMBD+Lz5bvJ97rJRI7aE5bNXLCq1Y8LakvMQjTYX47x1jwOusDYmUC2g83/fNjGcGBtRUf1t0OA3oT1am6GBhVMYFQQf0dHkmSac/HL/0WZ4ijPomh+OiSvuctDpzn2e39rsrcsAkedy2BAQRGvGiaXPRlFzjPu9WtZe4yeKLRG8GSnQxquOGlN19ijwiD/jYl0mXVaX+7fj0/a6IxXum3s0aPEdZw3UWeSv3rhLE/DYreMxyoq6Aej+xgknuYxVM+W1WIJ+kNeb+JN3UQF5JslUAE6Ood6b/doaE+yJ1QZpfZD/gCv2MqLtd+sCuKCPyPj3AZfUT5se/mhyTJqs71fqv2PMdVtbBCCMIRl7RYUAvpGmBCOeWZmshIK8ZyVP6FWKZALUqCpp2NPt+wppXDUUwiG4gfDKwZWh+6EQRPi2MyTEdTDATLBOHWmAEAsoUUBZYlkzMEmC2QswWUA5YtkzMEWCuQswVUB5YjkzME2A+WK4M5guwACxPBgsEWKhILRSvlt60L1MzWQ+mlkOvO5J+Za2H5t1s0oDO80h4ywQOKIDHOPIBoBbVXneBs0zOMikOI5u9XPYKFVLsw8F1XK7jb1DYYnQw7O007KS9sMXgSv5NRoZCalli/Y7tcLa3R75OvwLOtTnX2eM+t7B7N1yLcy0Ft2L/WUnJBidLK4YhqLOa5FkJmFM0jv8B1lz4h3EIAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACq2WS4+bMBDHv4vPKIRnHsdKu1J76B5S9RJFiMCkZctLPLZboXz3jm2CcWIHdpUTMvzn5/mPZ5x0pCr+1mS778ifJI/J1jZIHmZAtmRXtFUE5svxFaLGfNp9aZM0JgZpqxS/ZkXcplCbXBVwVdCrFr+bLEVplIZ1DYgn5GxcdnDEFjGcwjZtBuhbWCXhUY/t9Qq8QcqwgrzR5i32v3H43OZRkxS5+W338l1n8CIKqOiuP9/V+jv1EA31I/bkpOe4e05SmHRHRY93x6ifcseSnuPu6R2iSXdU9Hh3jPopdyzpOe7uzt6QyPTsjfxJBdOb40xN4e5Yu546qbJQZlD9gtnbDxEPzGHu6X785tHuf3O+tKwtk/74V8IuqpKymbhoh5DgJkR18geD4NbwTrYdeYOqxkB8by+cxQaVpwTSmN7+PC8MLbKMejn0337iFVpUVMEl5pIY+6VhI8DxDwdjf4lgH9gLJrNwZRmbheM6ksqSVDaubBXMlmSOBuZIKhdXjgrmSjJPA/MklY8rVwXzJdlKA1tJqjWuPBVsLcnwQPa+SraRS0srvVLprKsz0B6CfAoWrfZaCeTnwHoIm6eB+CvvJeyG0RB3JOh7bHVp8I5gMtvufBYtRVcUPkyeCLNGYVRnEIc/PP5Y8YdlaZDArjLB8wVvowmp+QDCMIANTlPNpgnqIx9AAVyPErTvEy8XiXkD8QRkPZNxbcwVCH8m4sR+9QXCEQh3JuK1xktjhLAFYqIYBf8PpqjoUjCUjYI9VyYlpEmOmv3hfP4PDQON1qkKAAA="; \ No newline at end of file diff --git a/Documentation/functions/Function_Build.exec.html b/Documentation/functions/Function_Build.exec.html deleted file mode 100644 index b073d011..00000000 --- a/Documentation/functions/Function_Build.exec.html +++ /dev/null @@ -1,299 +0,0 @@ -exec | typescript-esbuild
-
- -
-
-
- -
-
    - -
  • -

    Spawns a shell then executes the command within that shell, buffering any -generated output. The command string passed to the exec function is processed -directly by the shell and special characters (vary based on shell) -need to be dealt with accordingly:

    -
    const { exec } = require('node:child_process');

    exec('"/path/to/test file/test.sh" arg1 arg2');
    // Double quotes are used so that the space in the path is not interpreted as
    // a delimiter of multiple arguments.

    exec('echo "The \\$HOME variable is $HOME"');
    // The $HOME variable is escaped in the first instance, but not in the second. -
    -

    Never pass unsanitized user input to this function. Any input containing shell -metacharacters may be used to trigger arbitrary command execution.

    -

    If a callback function is provided, it is called with the arguments(error, stdout, stderr). On success, error will be null. On error,error will be an instance of Error. The -error.code property will be -the exit code of the process. By convention, any exit code other than 0indicates an error. error.signal will be the signal that terminated the -process.

    -

    The stdout and stderr arguments passed to the callback will contain the -stdout and stderr output of the child process. By default, Node.js will decode -the output as UTF-8 and pass strings to the callback. The encoding option -can be used to specify the character encoding used to decode the stdout and -stderr output. If encoding is 'buffer', or an unrecognized character -encoding, Buffer objects will be passed to the callback instead.

    -
    const { exec } = require('node:child_process');
    exec('cat *.js missing_file | wc -l', (error, stdout, stderr) => {
    if (error) {
    console.error(`exec error: ${error}`);
    return;
    }
    console.log(`stdout: ${stdout}`);
    console.error(`stderr: ${stderr}`);
    }); -
    -

    If timeout is greater than 0, the parent will send the signal -identified by the killSignal property (the default is 'SIGTERM') if the -child runs longer than timeout milliseconds.

    -

    Unlike the exec(3) POSIX system call, child_process.exec() does not replace -the existing process and uses a shell to execute the command.

    -

    If this method is invoked as its util.promisify() ed version, it returns -a Promise for an Object with stdout and stderr properties. The returnedChildProcess instance is attached to the Promise as a child property. In -case of an error (including any error resulting in an exit code other than 0), a -rejected promise is returned, with the same error object given in the -callback, but with two additional properties stdout and stderr.

    -
    const util = require('node:util');
    const exec = util.promisify(require('node:child_process').exec);

    async function lsExample() {
    const { stdout, stderr } = await exec('ls');
    console.log('stdout:', stdout);
    console.error('stderr:', stderr);
    }
    lsExample(); -
    -

    If the signal option is enabled, calling .abort() on the correspondingAbortController is similar to calling .kill() on the child process except -the error passed to the callback will be an AbortError:

    -
    const { exec } = require('node:child_process');
    const controller = new AbortController();
    const { signal } = controller;
    const child = exec('grep ssh', { signal }, (error) => {
    console.error(error); // an AbortError
    });
    controller.abort(); -
    -
    -
    -

    Parameters

    -
      -
    • -
      command: string
      -

      The command to run, with space-separated arguments.

      -
      -
    • -
    • -
      Optional callback: ((error, stdout, stderr) => void)
      -

      called with the output when process terminates.

      -
      -
      -
        -
      • -
          -
        • (error, stdout, stderr): void
        • -
        • -
          -

          Parameters

          -
            -
          • -
            error: null | ExecException
          • -
          • -
            stdout: string
          • -
          • -
            stderr: string
          -

          Returns void

    -

    Returns ChildProcess

    -
    -

    Since

    v0.1.90

    -
  • - -
  • -
    -

    Parameters

    -
      -
    • -
      command: string
    • -
    • -
      options: {
          encoding: null | "buffer";
      } & ExecOptions
    • -
    • -
      Optional callback: ((error, stdout, stderr) => void)
      -
        -
      • -
          -
        • (error, stdout, stderr): void
        • -
        • -
          -

          Parameters

          -
            -
          • -
            error: null | ExecException
          • -
          • -
            stdout: Buffer
          • -
          • -
            stderr: Buffer
          -

          Returns void

    -

    Returns ChildProcess

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      command: string
    • -
    • -
      options: {
          encoding: BufferEncoding;
      } & ExecOptions
    • -
    • -
      Optional callback: ((error, stdout, stderr) => void)
      -
        -
      • -
          -
        • (error, stdout, stderr): void
        • -
        • -
          -

          Parameters

          -
            -
          • -
            error: null | ExecException
          • -
          • -
            stdout: string
          • -
          • -
            stderr: string
          -

          Returns void

    -

    Returns ChildProcess

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      command: string
    • -
    • -
      options: {
          encoding: BufferEncoding;
      } & ExecOptions
    • -
    • -
      Optional callback: ((error, stdout, stderr) => void)
      -
        -
      • -
          -
        • (error, stdout, stderr): void
        • -
        • -
          -

          Parameters

          -
            -
          • -
            error: null | ExecException
          • -
          • -
            stdout: string | Buffer
          • -
          • -
            stderr: string | Buffer
          -

          Returns void

    -

    Returns ChildProcess

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      command: string
    • -
    • -
      options: ExecOptions
    • -
    • -
      Optional callback: ((error, stdout, stderr) => void)
      -
        -
      • -
          -
        • (error, stdout, stderr): void
        • -
        • -
          -

          Parameters

          -
            -
          • -
            error: null | ExecException
          • -
          • -
            stdout: string
          • -
          • -
            stderr: string
          -

          Returns void

    -

    Returns ChildProcess

  • - -
  • -
    -

    Parameters

    -
      -
    • -
      command: string
    • -
    • -
      options: undefined | null | ObjectEncodingOptions & ExecOptions
    • -
    • -
      Optional callback: ((error, stdout, stderr) => void)
      -
        -
      • -
          -
        • (error, stdout, stderr): void
        • -
        • -
          -

          Parameters

          -
            -
          • -
            error: null | ExecException
          • -
          • -
            stdout: string | Buffer
          • -
          • -
            stderr: string | Buffer
          -

          Returns void

    -

    Returns ChildProcess

-
- -
-
-

Generated using TypeDoc

-
\ No newline at end of file diff --git a/Documentation/functions/Source_Function_Build.Exec.html b/Documentation/functions/Source_Function_Build.Exec.html new file mode 100644 index 00000000..a253947c --- /dev/null +++ b/Documentation/functions/Source_Function_Build.Exec.html @@ -0,0 +1,110 @@ +Exec | typescript-esbuild - v0.1.16
+
+ +
+
+
+ +
+
    + +
  • +

    The function 'Exec' is an asynchronous function that executes a command and logs the +stdout of the child process.

    +
    +
    +

    Parameters

    +
      +
    • +
      Command: string
      +

      The Command parameter is a string that represents the +command you want to execute. It can be any valid command that can be executed in a +terminal or command prompt.

      +
      +
    • +
    • +
      Echo: false | ((Return) => void) = ...
    +

    Returns Promise<void>

    +
+
+ +
+
+

Generated using TypeDoc

+
\ No newline at end of file diff --git a/Documentation/functions/Function_Build.deepmerge.html b/Documentation/functions/Source_Function_Build.deepmerge.html similarity index 82% rename from Documentation/functions/Function_Build.deepmerge.html rename to Documentation/functions/Source_Function_Build.deepmerge.html index 3e295fc1..06bf6833 100644 --- a/Documentation/functions/Function_Build.deepmerge.html +++ b/Documentation/functions/Source_Function_Build.deepmerge.html @@ -1,4 +1,4 @@ -deepmerge | typescript-esbuild
+deepmerge | typescript-esbuild - v0.1.16
  • Preparing search index...
  • -
  • The search index is not available
typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,8 +26,8 @@

    Theme

    @@ -6,7 +6,7 @@
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,8 +26,8 @@

    Theme

    +
    +
    +typescript-esbuild - v0.1.16 +
    +
    +

    Settings

    +
    +
    +

    Member Visibility

    +
      +
    • +
    • +
    • +
    +
    +

    Theme

    +
    +
    +
    + +
    +
      + +
    • +

      The function 'Exec' is an asynchronous function that executes a command and logs the +stdout of the child process.

      +
      +
      +

      Parameters

      +
        +
      • +
        Command: string
        +

        The Command parameter is a string that represents the +command you want to execute. It can be any valid command that can be executed in a +terminal or command prompt.

        +
        +
      • +
      • +
        Echo: false | ((Return) => void) = ...
      +

      Returns Promise<void>

      +
    +
    +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/functions/Function_File.default.html b/Documentation/functions/Source_Function_File.default.html similarity index 81% rename from Documentation/functions/Function_File.default.html rename to Documentation/functions/Source_Function_File.default.html index 03a13c80..45890dae 100644 --- a/Documentation/functions/Function_File.default.html +++ b/Documentation/functions/Source_Function_File.default.html @@ -1,4 +1,4 @@ -default | typescript-esbuild
    +default | typescript-esbuild - v0.1.16
    • Preparing search index...
    • -
    • The search index is not available
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,8 +26,8 @@

    Theme

    @@ -6,7 +6,7 @@
    • Preparing search index...
    • -
    • The search index is not available
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,8 +26,8 @@

    Theme

    @@ -6,7 +6,7 @@
    • Preparing search index...
    • -
    • The search index is not available
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -24,7 +24,7 @@

    Theme

    @@ -6,7 +6,7 @@
    • Preparing search index...
    • -
    • The search index is not available
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,54 +26,62 @@

    Theme

    +
    +
    +
      +
    • Preparing search index...
    • +
    • The search index is not available
    typescript-esbuild - v0.1.16 +
    +
    +

    Settings

    +
    +
    +

    Member Visibility

    +
      +
    • +
    • +
    • +
    +
    +

    Theme

    +
    + +
    +

    Generated using TypeDoc

    +
    \ No newline at end of file diff --git a/Documentation/modules/Function_Build.html b/Documentation/modules/Source_Function_Exec.html similarity index 79% rename from Documentation/modules/Function_Build.html rename to Documentation/modules/Source_Function_Exec.html index d527aaf4..8293b319 100644 --- a/Documentation/modules/Function_Build.html +++ b/Documentation/modules/Source_Function_Exec.html @@ -1,4 +1,4 @@ -Function/Build | typescript-esbuild
    +Source/Function/Exec | typescript-esbuild - v0.1.16
    • Preparing search index...
    • -
    • The search index is not available
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,63 +26,69 @@

    Theme

    @@ -6,7 +6,7 @@
    • Preparing search index...
    • -
    • The search index is not available
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,61 +26,69 @@

    Theme

    @@ -6,7 +6,7 @@
    • Preparing search index...
    • -
    • The search index is not available
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,61 +26,69 @@

    Theme

    @@ -6,7 +6,7 @@
    • Preparing search index...
    • -
    • The search index is not available
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,61 +26,69 @@

    Theme

    @@ -6,7 +6,7 @@
    • Preparing search index...
    • -
    • The search index is not available
    typescript-esbuild - v +
  • The search index is not available
  • typescript-esbuild - v0.1.16

    Settings

    @@ -26,56 +26,64 @@

    Theme