From fca9e483a9608d8d1af1ad3a69a3a8ee901e5180 Mon Sep 17 00:00:00 2001 From: Nikola Hristov Date: Mon, 6 Jan 2025 00:06:23 +0200 Subject: [PATCH] Document/v0.1.4 --- .github/workflows/GitHub.yml | 2 +- docs/assets/search.js | 2 +- docs/functions/Function_Document.Exec.html | 4 ++-- docs/functions/Function_Document.document.html | 4 ++-- docs/functions/Function_Document.resolve.html | 4 ++-- docs/functions/Function_Exec.exec.html | 4 ++-- docs/functions/Function_JSON.JSON.html | 4 ++-- docs/index.html | 4 ++-- docs/interfaces/Exec.Interface.html | 4 ++-- docs/interfaces/Interface_Document.Interface.html | 4 ++-- docs/interfaces/JSON.Interface.html | 4 ++-- docs/modules.html | 4 ++-- docs/modules/Document.html | 4 ++-- docs/modules/Exec.html | 4 ++-- docs/modules/Function_Document.html | 4 ++-- docs/modules/Function_Exec.html | 4 ++-- docs/modules/Function_JSON.html | 4 ++-- docs/modules/Interface_Document.html | 4 ++-- docs/modules/JSON.html | 4 ++-- docs/variables/Document.document.html | 2 +- docs/variables/Function_Document.Current.html | 2 +- docs/variables/Function_Document.Pipe.html | 2 +- 22 files changed, 39 insertions(+), 39 deletions(-) diff --git a/.github/workflows/GitHub.yml b/.github/workflows/GitHub.yml index 155a6ad..ab334a3 100644 --- a/.github/workflows/GitHub.yml +++ b/.github/workflows/GitHub.yml @@ -52,7 +52,7 @@ jobs: VCPKG_DISABLE_METRICS: 1 steps: - - uses: pozil/auto-assign-issue@v2.1.2 + - uses: pozil/auto-assign-issue@v2.0.1 with: repo-token: ${{ secrets.GITHUB_TOKEN }} assignees: NikolaRHristov diff --git a/docs/assets/search.js b/docs/assets/search.js index ccd7a1f..2c5a4d1 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACtVaS4+rNhT+L950Y3HxG7LtQ2oXbaVK3USjips4E1oCkSHT3o7mv1eGQ8gheAZP75XaFY7x+fydp4+ZeSau+bMlm+0z+aOs92TDKamLkyUb8t2l3nVlU3/44ZeffiSUXFxFNuTU7C+VbT+Mb3/zb5Njd6oIJbuqaFvbkg0hL3RE1PIKiZAOgDDHCgBSci6crbs7ZtNOC9y//cvuwtz927Xc7S3SAvceyy4DLnHvmb3K/Ztmdzl5qSD/ccVaHb59Q4crXsAwS3pcWS7u6GzbVE921aaw9v37ismIP5fnadOnwpXFx2XL+YWfZcevL87dOuu1TWHtZ7Hwfh4lr5l4Hw6YlTvz5WQeQ/PNasCVviJ8X3fWHYrd5KlynAGk64rXCQfrwGL6v5n1qzn2SCs5BvP9Kh9O+OuSdRm/mv8C7kptFkgv6RbUaJUeN9l1F+VTekUG98T3gZKy3tu/yOaZPFnXlk1NNoQnIskJJYfSVnt/Mg4UKNk1J2BwJfMAy361u65xfvGw+kNK6DalXCUif3ig21G2n+8nRohpppdjhG4ZZTKRqUSC8CIxIqecpkmWCyooSxgXVMJvRdMkN4xqyhKdZdTQNDFG0gx+5359nlOWggBj8IbxcSDGgRwGmCxDZLnnpBa05HdaciQovKCmLE0M10jSv/FcJDe9eqkY1DO56dVT+aCWzplXw+vDKdOwghkvYhhlXmWuMspyGPB0HLBxwMeBGAcSxLkaZ/QwwMoIpIz0lM2CFeSdFSQSVEErqP+DFRRSRnvK2YIVNOiSCkYlPL0OPBVDIPKecZpkmfZ7p4lWjPI+VmVGhV+iJRVsnODjQFCeSMmokLBEwdPTVZpTYWAiozxhuaQiHyYkgEoGT4+Zp4pKASulBAwJoFLD08D2MoMJwFSAqQBTcXgKEFBAUwGiAkQFLBUAKgDUHlAxRjUg6lFzLWACEDUgakDUgKgBUQOiAYoGAA1QNIBnAM8AngE8M+Bh92vkfkPo1iy539wlgUGCGaFbnVKeJjxjSDK7k8yQZO63zCnTSc4MkvRvequncqiJSlEDv31cGUaz1AdPmtGMjQM+DPCWOa7OabA83xd2NqvsvnZmYokv+48Ud1zdGQ/WJ3Zf4Bmu8EyEtf1f1HiGizzzpTuTCwHO7ss8w3WeqbAt1OcLVYYLMtPB/GD6njJOZ2bCwvcZDVN9O/VkXWf33w9t1XZLCkKfyW/QZqmxnXt+mdqpzTNhw4wYHmp46OGRDw8GaxgsYv2ql5tezP/0tIqPbVNdOnu7seSBnXUQ5dBZh7jLaIiqQgA6HsDZYv8JKRIPUt/KMxOQX7T9YOxl1D2CTd/hWezS5V2Q8iYUP2HlHQoDEW8999hPtMgJISO+AuMKpIqIh0AUdHw0tp/q3dE1dXNBSCxbFRFhJ+2OZYWCgYfctBqxOZ1mAcZDAbYes27LvXUWwYrourBr6q6/BN5YMOSLMb5ZEGz8ZHTj2ElRkoHcGl770vV3UBRlOlq96Zp9k3b5RGmsxmMKmzuKS6jDp9Mbi015OHcgv9d5rYv9LpfO4ujO/2XcHMoKlZAQHls+rYKn1KG54AhXItZXB9ecUDCHMjmMAN/5EEpMJY8+nMcdPywFGp+KIpGrAusKdxdhUw0i9yH1KtTvLTbITUKmq5AeLT4uTHQWlgd03ETX+hIpIEMx+4r89ZvhBJNNkRF2+OuWueIuuj+TNxus83+Jz+Uv0oSUbf0V4imj25ASBwQLBcSbB8Y8NtmNxUD2Pkbfhq3sAWmoQqdtUEOPcGpabKd4lOYRGYqzf1m955RENKW6QYaJTqW6caeiKv/GfYeObv/qBp/J0Z1sg2oKD+VK5D2gcfvZNSnksjCx7oghRHS9OxeuONnZhU1EM7nCoCAU0el+LlyL/c3eOFXDqXkuuiNKqug2wSMghVR08J2LrrOuRihZqIiNPUGwBzj3f5q9ieWpbyHr+smzs2db77GNZXT7c3bNzra44oTyam3FAUzchWahUHzTVv4DAIZ6byA5e2qesMVMdDV09uxsO78PZyGcFerBfwfceOAmGvSqaAAQrFp0mgAKbiiiS4iz7aXqyvoRVfvoYu1sd5nlGwtxedvz5eMR99nRp5hrZsdPdIluq6I9YuvqaBptV7i5ccU7UPbWoaOCh6Jlbda33b65YBuHyuN6yHL2/TC6vrWdmxnLRJf+7lhgz3/R62F3xLXgizT0HWrpRHSl6FxRVvMUj3ZO9+ls250rz/jzz3uT/FJXs6PMRBevS92VOOSib66XWeOjo617aWemVdH9158WZ46OR2jcH3MPx5nzgfZ9TlXWlmy2Dy8v/wAVdIUaaSkAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACtVZTY/bNhD9L7z0QmjFD5GSr2kKpIe2QIFeFotAsem1GlkyKGmTdLH/vaBEyRqZXIvOFkhPoinyzZvh43AoPyNdf2nQ5v4ZfS6qHdpQjKr8qNAG/frn778hjDpdog061ruuVM2d6YwO7bFEGG3LvGlUgzYIveBpfiImhA9Vq/Q+36oJphh7LNI0woGJ0SnXqmpHKjMbk4X3X9X2gqPpfBuOPdJKjj0VF8dp/t3P9bY7mtFLxtOQj+OQt+HvwF3pjYO0y7dfumrbFnV15xTL+PbjVdUI7pbd3iIssTyAMwcgs1e5O0U02buqphl3NUdycO+xlBvQxd2rqWmEV1KTzVWKmvnw/ooPE54nMC4/HBqaWdSqqcsntcqoHXu7XXYO4h/F6Wz0KddF/skdOTPwTSy+67SeL9ZrRu3YN4nwbqmS10K88wtmpeWzw155rlLlLHIXHpxDF0j8zPcBo6Laqa9o84yelG6KukIbRCMWZQijfaHKnTkZBwoYbeujZTCRebDD/lLbttZm8DD6Lkb4PsaERzzmDw/4fpzcv+g7RoxzTz+RIHxPMBFRRiSYSAbESLIMUxxHacYwwyQilGFufyc4jjJJsMAkEmmKJY4jKTlO7e/MjM8yTGI7gRD7htCxwcYGHxqQLAFkqSGbYBJHkgrAll64ScFM5nPTvDBcOJW9ezEb3JOZ7N1LssEtkRHjhvGHYpLYEcR4HkuCicQkokmKSTo2Mtug8dggY4OODWanUz72JEMD+sKAL9xQFpgmEcuAL/wiCBxMTHxBMC/6tY35sKZJgqX9bdwwDCWmEY9TTNOxkQ0NaDEBFoUBjh1UxQVVASZKn57lDyFLCcimxkvi8DK98DIFEzOvnrP/gywzmElMYmHUEQZymYTIIgsRbyT6Vz98KAhMVMRkH8ZcsaDWnZgRzO3TkKUxGwRJe9JxlKbCmI8jkRDMzFDCU8zMWMExE2OHHBv9xuQEs2wYwmP7NF4lgmJObQfDNCIZx5zbDgvKhX0azCxOME/HkZnFSCxoQuyTWvMJsx0WM7GYicVMpH2m4wRLU1hEYRGFZSksoLCAol9sQrCwiGL0XKS2wyJKiygtorSI0iJKiygtRWkBpaUoLZ60eKnFSy1eOuAtFAAPHGJydupUALvcDTDBE5O2RYJpHNGUwMmXOZ7AJE9MBk6580h/wzxPYKInwm/1MtcTmOyJ9E+Wl5OHrr6YelK6VbsPQ1F1f49yhJ/RR1tkJWMx9/xyLqY2z4gMPWx4JMNDDo9seBA7hlD77Ee9zCox89PQyj81ddm1am6YS59l6oXZt0oD8lk4RlnOEQS5AUGrfPcN8LgBpZoDEOEBYK9E3A27A7jxquV9bV3dVoD7qdeKH0FDMdwQQP3YdzRgIegNODoH3vAbMAAJcYMqm2/V9qDrqu4AFPFtEpcuXMDbQ1ECRVD+vYj18bhUmc/h9ZhVU+yUVgCWhWeIbV21/W1wRs7nMJlp34k1fhaYrew5WyLC7cRVxHaF7m+jQGki3MHzjXu2/fiMlc3URNinvGDpgh0+kc2CNnOUuhfxhmU2VrpWQYWn36mdfVGCVOLdfK6TzH9k7esOijzxEfUv1l7XR5BZWDiE/aAD9sUbHNl+v8cvSC6lnT/9PCMSr1LWhLeUGDunfJSGQf3dLAJyPn+QWAX1qOC5IcN3YrEHSxue8wvgQ+JNU68ATH8yzPbTbIUu9XA1MBOmc/3puUxBl+nPiQfCfCUV31iNFE31E6CZhNcjBdQD8dYAVw6NpTRnyozh1ADQUu2hf96i3eufgTjWDYDhN8DUjyBO1Bfptdl7yYmFc6pqcKaG76Oq1se8LP6B1YcMLwOrGp7L4UVtDZIK9WX60FtBrXeLi5PvvvEKRnuAGCw85Z1ynR/V4hLHwrlMODC7hG/7U64buOzkyunq3aSnvD0ANuH1goGAN4lwDZ7ytlW6grvUt1JjseitBk79n3EzSbPZ8cJWnQAnrU6q2sEoJ+GV0EnXW9VAv3zJYm32sZiwIqW+hbsaLfNdAEB5JXBFS1od66dFOgpPjFqdtGqWV2TqK3VWuGf/EZ7t3bke6Co9WBToXPhesTAwAYRnEq2armyL6hHQCU/cWrXdYtcRL8q11S8eD/BQDD/TdA3PIhmerJsybw4wwDKcSNPmehlffgvMTmlwbFBfbly7+Zt2V3ewvPWt2HrIYvF5MTzPNa1ehCsNPwXaQw6X/7+8MrYHkBOulM43FvktqPJYeMJodV6Uy40evjztt5Nqtro4wQ9DN271rioXZ5oMz2Fd1RZAdUn4bbZblEEiPMBds4iuCK/Hvii4f+QNELX+vCQSGNMH3Bc+ZVEptLl/eHn5F0ZxdQiQKQAA"; \ No newline at end of file diff --git a/docs/functions/Function_Document.Exec.html b/docs/functions/Function_Document.Exec.html index c89c472..aca2fd4 100644 --- a/docs/functions/Function_Document.Exec.html +++ b/docs/functions/Function_Document.Exec.html @@ -1,4 +1,4 @@ -Exec | @playform/document - v0.1.3
  • The 'Exec' function is an asynchronous function that executes a command and logs the +Exec | @playform/document - v0.1.4

    • The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr 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 @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.

        -

      Returns Promise<void>

    +

Returns Promise<void>

diff --git a/docs/functions/Function_Document.document.html b/docs/functions/Function_Document.document.html index 0277bd4..7441564 100644 --- a/docs/functions/Function_Document.document.html +++ b/docs/functions/Function_Document.document.html @@ -1,4 +1,4 @@ -document | @playform/document - v0.1.3
  • Represents a function that processes file patterns.

    +document | @playform/document - v0.1.4
    • Represents a function that processes file patterns.

      Parameters

      • File: string[]

        An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.

      • OptionalOption: {
            Folder?: string;
        }
        • OptionalFolder?: string

          A string representing the Folder option.

          -

      Returns Promise<void>

    +

Returns Promise<void>

diff --git a/docs/functions/Function_Document.resolve.html b/docs/functions/Function_Document.resolve.html index bfb5b2b..f524758 100644 --- a/docs/functions/Function_Document.resolve.html +++ b/docs/functions/Function_Document.resolve.html @@ -1,4 +1,4 @@ -resolve | @playform/document - v0.1.3
  • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

    +resolve | @playform/document - v0.1.4
    • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

      Starting from leftmost {from} parameter, resolves {to} to an absolute path.

      If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, @@ -6,4 +6,4 @@ and trailing slashes are removed unless the path gets resolved to the root directory.

      Parameters

      • Rest...paths: string[]

        A sequence of paths or path segments.

      Returns string

      if any of the arguments is not a string.

      -
    +
diff --git a/docs/functions/Function_Exec.exec.html b/docs/functions/Function_Exec.exec.html index 01a0e90..5394db6 100644 --- a/docs/functions/Function_Exec.exec.html +++ b/docs/functions/Function_Exec.exec.html @@ -1,4 +1,4 @@ -exec | @playform/document - v0.1.3
  • The 'Exec' function is an asynchronous function that executes a command and logs the +exec | @playform/document - v0.1.4

    • The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr 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 @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.

        -

      Returns Promise<void>

    +

Returns Promise<void>

diff --git a/docs/functions/Function_JSON.JSON.html b/docs/functions/Function_JSON.JSON.html index 8659209..df8b414 100644 --- a/docs/functions/Function_JSON.JSON.html +++ b/docs/functions/Function_JSON.JSON.html @@ -1,4 +1,4 @@ -JSON | @playform/document - v0.1.3
  • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +JSON | @playform/document - v0.1.4

    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its parsed content.

      Parameters

      • File: string

        The File parameter is a string that represents the name or path of the JSON file that you want to parse.

        @@ -6,4 +6,4 @@ the directory path from which the JSON file should be loaded. If From is provided, it will be used as the base directory path. If From is not provided, the current directory will be used as the base directory path.

        -

      Returns Promise<any>

    +

Returns Promise<any>

diff --git a/docs/index.html b/docs/index.html index edb80b9..5399b20 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -@playform/document - v0.1.3

@playform/document - v0.1.3

📃 Document —

Document all your TypeScript files using TypeDoc.

+@playform/document - v0.1.4

@playform/document - v0.1.4

📃 Document —

Document all your TypeScript files using TypeDoc.

Add configuration and setup scripts:

npm install -D -E @playform/document
 
@@ -10,4 +10,4 @@
Document 'Source/**/*.ts'
 
-
+
diff --git a/docs/interfaces/Exec.Interface.html b/docs/interfaces/Exec.Interface.html index 8f9ebd5..4a9d35f 100644 --- a/docs/interfaces/Exec.Interface.html +++ b/docs/interfaces/Exec.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/document - v0.1.3
  • The 'Exec' function is an asynchronous function that executes a command and logs the +Interface | @playform/document - v0.1.4

    • The 'Exec' function is an asynchronous function that executes a command and logs the stdout and stderr 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 @@ -7,4 +7,4 @@ of the child process should be logged. If set to 'false', no logging will occur. If set to a function, the function will be called with the stdout and stderr data as a parameter for custom logging. If not provided, stdout and stderr will be logged to the console by default.

        -

      Returns Promise<void>

    +

Returns Promise<void>

diff --git a/docs/interfaces/Interface_Document.Interface.html b/docs/interfaces/Interface_Document.Interface.html index 71160ac..b994904 100644 --- a/docs/interfaces/Interface_Document.Interface.html +++ b/docs/interfaces/Interface_Document.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/document - v0.1.3
  • Represents a function that processes file patterns.

    +Interface | @playform/document - v0.1.4
    • Represents a function that processes file patterns.

      Parameters

      • File: string[]

        An array of file patterns to be processed. Each pattern can include wildcards (*) to match multiple files.

      • OptionalOption: {
            Folder?: string;
        }
        • OptionalFolder?: string

          A string representing the Folder option.

          -

      Returns Promise<void>

    +

Returns Promise<void>

diff --git a/docs/interfaces/JSON.Interface.html b/docs/interfaces/JSON.Interface.html index 39f4511..5b238b5 100644 --- a/docs/interfaces/JSON.Interface.html +++ b/docs/interfaces/JSON.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/document - v0.1.3
  • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +Interface | @playform/document - v0.1.4

    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its parsed content.

      Parameters

      • File: string

        The File parameter is a string that represents the name or path of the JSON file that you want to parse.

        @@ -6,4 +6,4 @@ the directory path from which the JSON file should be loaded. If From is provided, it will be used as the base directory path. If From is not provided, the current directory will be used as the base directory path.

        -

      Returns Promise<any>

    +

Returns Promise<any>

diff --git a/docs/modules.html b/docs/modules.html index 59cf6f0..b7962ba 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,8 +1,8 @@ -@playform/document - v0.1.3

@playform/document - v0.1.3

Index

Modules

Document +@playform/document - v0.1.4
+
diff --git a/docs/modules/Document.html b/docs/modules/Document.html index e69e876..39ee8c6 100644 --- a/docs/modules/Document.html +++ b/docs/modules/Document.html @@ -1,2 +1,2 @@ -Document | @playform/document - v0.1.3
+Document | @playform/document - v0.1.4
diff --git a/docs/modules/Exec.html b/docs/modules/Exec.html index 951f0b9..ddc81a6 100644 --- a/docs/modules/Exec.html +++ b/docs/modules/Exec.html @@ -1,2 +1,2 @@ -Exec | @playform/document - v0.1.3
+Exec | @playform/document - v0.1.4
diff --git a/docs/modules/Function_Document.html b/docs/modules/Function_Document.html index e120701..4e5eafa 100644 --- a/docs/modules/Function_Document.html +++ b/docs/modules/Function_Document.html @@ -1,6 +1,6 @@ -Function/Document | @playform/document - v0.1.3

Module Function/Document

Index

Variables

Current +Function/Document | @playform/document - v0.1.4
+
diff --git a/docs/modules/Function_Exec.html b/docs/modules/Function_Exec.html index c10a964..36f3022 100644 --- a/docs/modules/Function_Exec.html +++ b/docs/modules/Function_Exec.html @@ -1,2 +1,2 @@ -Function/Exec | @playform/document - v0.1.3
+Function/Exec | @playform/document - v0.1.4
diff --git a/docs/modules/Function_JSON.html b/docs/modules/Function_JSON.html index 13adbc6..66b34f6 100644 --- a/docs/modules/Function_JSON.html +++ b/docs/modules/Function_JSON.html @@ -1,2 +1,2 @@ -Function/JSON | @playform/document - v0.1.3
+Function/JSON | @playform/document - v0.1.4
diff --git a/docs/modules/Interface_Document.html b/docs/modules/Interface_Document.html index 3847d25..e0c37d7 100644 --- a/docs/modules/Interface_Document.html +++ b/docs/modules/Interface_Document.html @@ -1,2 +1,2 @@ -Interface/Document | @playform/document - v0.1.3
+Interface/Document | @playform/document - v0.1.4
diff --git a/docs/modules/JSON.html b/docs/modules/JSON.html index 08bd1ca..ce3cabe 100644 --- a/docs/modules/JSON.html +++ b/docs/modules/JSON.html @@ -1,2 +1,2 @@ -JSON | @playform/document - v0.1.3
+JSON | @playform/document - v0.1.4
diff --git a/docs/variables/Document.document.html b/docs/variables/Document.document.html index 5410f83..b917623 100644 --- a/docs/variables/Document.document.html +++ b/docs/variables/Document.document.html @@ -1 +1 @@ -document | @playform/document - v0.1.3
+document | @playform/document - v0.1.4
diff --git a/docs/variables/Function_Document.Current.html b/docs/variables/Function_Document.Current.html index 8959b16..e600333 100644 --- a/docs/variables/Function_Document.Current.html +++ b/docs/variables/Function_Document.Current.html @@ -1 +1 @@ -Current | @playform/document - v0.1.3
+Current | @playform/document - v0.1.4
diff --git a/docs/variables/Function_Document.Pipe.html b/docs/variables/Function_Document.Pipe.html index 45b6b32..50d358d 100644 --- a/docs/variables/Function_Document.Pipe.html +++ b/docs/variables/Function_Document.Pipe.html @@ -1 +1 @@ -Pipe | @playform/document - v0.1.3
+Pipe | @playform/document - v0.1.4