diff --git a/Documentation/assets/search.js b/Documentation/assets/search.js index 071d7db..0a782fb 100644 --- a/Documentation/assets/search.js +++ b/Documentation/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACtUayXKkOPZfqENf1BRaQJKPM92Hnj1ilovD4aAySSfTGDKAdHWNo/69Q0ICPZKXlu2amOlTPkt6+yrh56TvPg/Jze1z8nPd7pMbRpK2fKySm+RPXblPSHLum+Qmeez256YaPprF9Dg+NglJdk05DNWQ3CTJV+LxCzETaEICh3O7G+uudSTM3vd0gxJJTmVftaMXYKHMF9H+caweq5n0U9nX5adZOrv5VspA5hXhZlt3nO5C9qd2rPpDuas+QtG9Wef9e0z6gGpeLIb4clqI1Z7IJT1z7rroawkXfjRji08/netm/8++GV7F9UOIFsXf4oZhled8Ufv+fnyt4osI6YT9PXuVLOmiAmKa+z+Xp1PdPrxOrADrf2QYL0E6I7/CKrP4iFHeZJN3mmQr7dZyXCaet0Js6s2Y13XzZOeV2DR8wbB/NEtv4PzBIUayX7AxQX6o+2o3dv2XN0kTYr9HpGjP2Eoe6YxVOQdqg0Zxnf4HdxZnsqlSbGZjHF/K5xVeg/WuP/z9r3+5yBuz+G1SxVKKdIgVZUvGH3+pdhcymsVvI6OlFCmjFWVLxt+ZBnIhpF39NlJOpCLFnKTZnNuAw5e5zToK8Tvuo4BuFTppoWuNW237KsauP3S786M5szat34idV3/clm8mg8RTIOMsyib9vhq65qm6xsIdeTWXYIL9W33aGo1nFmb/PfR/f+770NobLNyR99hqv3bqhrH8mZfuERucsKuED52Xp3DK1ExjBDTccUdjfPk2sh64A2NfmGHD2ns8zDeNcEeSut1XvyQ3z8lT1Q911yY3CUt5qhOSHOqq2ZsL4SQCSXbdo8W7c3v/sv3anJiOfMwScpsRqlKp1N0dufUYdsMu2GMUO0bBMZaQW0oYT3kGjzFwjGPUODgmEnLLCKepVBQcE+BYnpBbvnUsB8eKhNyKrWNmIyc0ZYKRgmSp0pRIkqW64EQRljItiSY8FbkiNCM01UwRSt0OZX6FE5pSLggVhhiXhBqqhcoJLfyWnA4vUkljMbVlMgmkV+ac3hJfOfGLTBDDJ8sKYthkShnhWEqlJCwjLM21IIyao1oRZuXOOGHcbwm/kk8rC3eNSqlhmJioYWzroN2ypimy3JiGpVQVk2mEpMY0LM0zagSbtlhBWGokldY5mjDlFrT9DdiaKOTZlnUoDFBqApHTzUiGMUpNLPLN8LNbzASAMAc44amkknDhgdwDxQQEVE3ocrlpILNlzcEUDfxktFeSEy6de7hyDuPaAcJ7V1APMA/wtS9pjpsAZgwt0Kx3O6mQJLcpw23q6EKYFGFppuQkec4VETYhmCLCeF0oSUThAekB5QHtgDybgEAePFkozBZqk4ISlqXS6T6fVPCkxq2hXWZROWUWK5QtDErnU7ZnOZ+yJi9yo+60ZdU1W0aAlAqSm1STmpKce8Ac4bogee5XCg/ICQiKqskcU3tkSl0szWUVVmlGUWXslnFVIalVhgphlZGKT8oII4IVPZMmLbNUm1ScnMiMVtOKkcSeybVRwpDLPEA9wDzAPSA8kHugmIBAfJOBhdxKOQaTk3FcUe69ptTkNcVsPeQmpoTxSCFIYcJNyoIU2gEym4CAiUCDaNr6PwiNHA+N/DfgcFNG5PbAUECHS1xR+RtQ1BQdudlMmHLis8yGTmYDlhqZpBamUWapoHqSOzdyG1FyzScFMkZNZ8hSKV14sYwROYWgJNLQySUjMvcrhQek31Ie0LaiC6JMLtBcEEXdlmIe4B4wvBSXROX+cOHRPWXlKSvtmOrMrWhPWXvK2lPWXmbtZdaFX/GUtaestQNols0QnSFDXJixjc9LYobyGSpmSM6QmqGZBZ1Z0JkFZTM086AzDzrzoDMPOvOgjkcQKHbS2h70GJy1uB2oMkZYkRaOxjxHw77AKZpnnH6rcsnR4Z+vpn+OHoTzPxe42NMVwN6Gnqp+rPY/Tbei29v5se05uXdXJTrf9p4Tmdw8fyWJnn6o/fPrclEyfxlG94/+zTkgoxcyCsErQ4R8Pg9OJsW0opwM7k/qZGLU/XL3K9xv7n6dCszhc3vesf80dM15BNorgYgxEXCIh7HqQyxdxGA1DcBRUTh9Ve6/AAmj8FrgC0wpb8xsZcxN43nKe0Cav0B67aer/vEsgMKmGkRofDo1dTWEiBzDozzA64H/pY7h1T/YFwbATcVh9iVU7oWwn10TEgF8TWmOYDx8aXfHvmu7M8DOUak3Y2Ei9gmYTDDMzCJAmZ6EF6xCLvWBMaRAWCxo5WvmCpDO9gtsIOTCrUCY7Y5rEVHDXrGNObbKkYK+iU57qB/OfWmeAkNqDPPYFCoz9lDvq74CgsiYRNp17Wjf4YIgkRhLn92Bp3f+1TQM0SVEEp5d2B/w31e7ppzU7qtDU+3WBqBYvIWd4gqt1L49hnUCq2Fhndgvn+8CzCCIXbRvZADM3uWhM3AMDZKhCDsVSfgl3YnQ9JEh8FLQuFm2GVnR0Wdon0dYTovsDWF8qBtQLHKsFc2htGrkYcM2xGBWYyKFpefQ9TAYX6i4RYh6hqGiY2rtoe8eQc1CDRciuVd/YPH/6kgUWvahgs2Mon09lPmhfqpgamKVLrBpfQC2iSlJNWCi0XIKUIaxbHcw9tBoCcVbvjsGeR7kJ2XO3Pk1s2/k60z548a4zLOAA32RgvsOE3SFBR2rF3U7diB5sF4KzAHzDc3ed4x79dB+B6qhwtoNwIIBm2OJudWi/j3APMtD9ypw/kVaF80k8ATFQqGpDkBjjbW0UGOD9NgN0FRRiPafMhakINRcm/CtBlRANCYMvVX4CnTUBngPsKGgwl9pKBu5w0KTb0wXvk5mF1RgzcPCrtjEB7gMKy2BG9a+kzFXzenTZBBeaNIGMdl2sOHFFMy26x/Lpv4PnBjNy04MLhz3UEuGSB3oA+gdb3UPmieqiKsq7PsM62gAY7+62Me0wW48QiwZpf95PJ2B3Tg62Qe+PZV9+Vit3h9kzFgyY4LIlTEOPpX9AAMjRxN+o0aeyvEIqlacuOMRSKpjLtinchyrvoUqovMXv5yETvXqOSx8yGIaKein5vwApxSB3pmCinjqq1PV7qFpdcy4eOq7XTXAcoqOUlfKqaOzmvRRS28YzDxQwVaMXqc2QqOvHrunVc1Bp8jQAH116quhasd1M0ADM9tAhmqjqbCptvsXpyDOgj7EsDdPh7fSOKYVOEz4HBJTn/pqOJn3gE/wKibQkakAuOdmbWPz8h/DdjyvMpFhevoWvRUh9cMR9s0onbt1T4qpOf0ZmoijJgpeBoZjd4YPRwIL4LCQD005HKvVrSsm9Yex7NceUTEpM4z7qgd9o0Dj7krJGMZ9BxtXgXrkKpkaPoibj1IxSvTraKQxLWw8ljCK4u7W77hTj0d4Q0Mbwmq0ec9d6uJeGD4sORH9L3Y5sTS+g3mLTp1ZyBteFjl6WQySB15JGRbG3h0cmgqo3pd1c1GoYmaG9RewJZqTHLPRl1O178Dzm0CntwKyGnZ9fYLvq+gL+kY9PLf76lC3sIMwrFCpELFZTQwUfUplAG+s4ZermG61foDHrBMY5zysLx9RjIaV03VMc/pcrYtPzEPU567/+SLEYtrR574eR/hWJtAxyTv7jthptKnbKrm5vfv69Vc6uTA/wzgAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACs1aS3PkthH+L9yDLzCXeBAAdUzsg/OuipOLSqXizlAaxhxyiuRoraj2v7sAAiSawx5Bq03Fp4EA9PvrbgDUS9J3n4fk5vYl+aVu98kNI0lbHqvkJvmpHav+odxVH38+VMcqIcm5b5Kb5Njtz001fJzX7+16ehiPTUKSXVMOQzUkN0nyhcxccznz/fn5tDCrPZNLfmbfBlOSnMq+ascNDRd5NGNiFvjpXDf7f/XN8CapH0KyKPmWNlBC5jlfzL6/H99q+KJCOlF/z96kS7qYgLjm/q/l6VS3j29TK6D6PznGa5DOxG/wyqw+4pSv8sk7XbKVdms9LhPPeyE29WbK67Z5tvNMbBq+4tg/m6mvkPzBEUaKX6gxRX6o+2o3dv3zV2kTUr9HpSXmf+nK/UWYzeS3iazlFBlMqwritiZU8zr/D24vLmTTJbGVAZP4Wj1Y0TXQ2CUgf/rn3/92ERAz+W0CYjlFBsSqsqXjj79WuwsdzeS30dFyitTRqrKl4x9MA7pQ0s5+Gy0nVpFqTtoEaEOg/XBud2PdtQ5nZu17+qa04YsL4OHpqezr8tOc3tjJKYoz0HnFuNkuHjjfwBcA/IsvLGiRHMDxGvCtQsAufC3Qqm3cxmDsh253Ppo9a5j5hatIC/T7cVu/mQ2SW4GOsyqb/Ptq6Jqn6poIt+XNUgJU/KM+bcFtFmHW38P/j+e+D729IcJteY+v9uugbjjL73ktNzckYenpofP6jYYyPfMYAQ+33fEYX8/w9eUlcPaFGza8vcdhvumEO5LU7b76Nbl5SZ6qfqi7NrlJWMrTIiHJQ101e3MhnFQgya47Wro7t/Zve/YxO6YtH7OE3GaE01RpendHbj2FXbATdhtNyC3d2kbBNpaQW7a1zSxwQlMmGBEkS3VBSU6ytJCcSMJSViiiCE9FrokmNC2YJoWbp5mboJTQlHJBKDOsuCLU8JQ6J1T4pXzavOjEjeqSMJ7yTAOlONBdmH1qS3nhlJeZIEZOlklixGRaG+VYSpUiVBOW5oUgtDBbC02Y1TvjhFG3xJif4dPMIj1HtcyBltJ4ONvaZ1asY2SWG8ewlGo5OUYoahzD0jyjRq1piQnCUqNnbgNTECbdhLK/i1BlhOot1yignDb7CkJ1qjRUToN9hXHoJurMCjWBF9zgiPBUmZgwP+B+IKZBgFADWJ5vecYuWUcwTYP4GLu14oTnLixcukBx5Qc+qrxwA5H5AV3HkJpkEGzLfgrzhDLUU3Yp2Mlxntzi0iQTt0lVSEGMvplWk3E518TQpkIRYdOPaSJM2IVWROR+IP1A+YH2g2IaBAoJFKl2KdhpkJtnhGWpcm6ad0JQU4m7Q7rko2pKPia1rRy6yKeCkOV8Sqxc5sbsacmaa5ZyC3dBcrNXmbLD/MBs4YUkufAzuR/IaRCoaJCeK0JVSh3sZhVhElA8C+ySiZhU1BpDhbDGKM0nY4SRzGyNUSZ3s7RgzAeTGaumGaOJ3ZObaskVJXnhBjLzA+oHzA+4Hwg/yKdBoL5JQSk3a30Bi32GGmqXbNS0nqKmmS2ZXCvjd5ZSKYg0cFNKEqn9oJgGgRA8p9iq95jEUZulkcGcYnhOMdgTmEAhzMTvA5gsR4Fpl37ncGMmvxXdjJqEscAz0C793g01ua+2D0e+LLDMQiez6UIZsagzvTxLhWlbRu/cQMrolBd8MiBj1LSwLFXKwYtljKgJZ4ooS6UYUbmfkX6g/JL2g8J2C0G0RWcuiKZuSTM/4H5grNVcEZ37zdKTe87ac9aFE1pkbqbwnAvPufCcC69z4XUupJ/xnAvPuSjcgGbZPKLzyDAX5qDG5ykxj/J5JOeRmkd6Hs0i6CyCziIom0ezDDrLoLMMOsugswzqZARAsWcgWmwiBVZgbg82GSNMptLxmA+38ADPKZpndumbFGuOl2AOSzDn+E5YgrnAFZ/OG/ZK9FT1Y7X/aboa3d7Or48vyb27L9H5Ueol4cnNyxeS5NMPFeb3y3JbMn8ZQfdH/4gfsFELG4yuDAn4vB/sTNg0I5wOTiUq3a+eflnmft0+5nRmyv26fZxa6ZP4T0PXnEdgvRaYGjogfBirPqQqZAxV0wAaHUXTV+X+GWgYRdeCWLDrvl37ctN3nvEecKbXOV+E6Wp4vIhnKCLKuadTU1cDABQWyiIg60H0VREjqn+0jwxAmI6j7Eto2yuglxveAWJNZY6QOzy3u0Pftd0ZUOcYlLaRMDH7BDwmMoxFFpBMD+QLlQxqDC2Q6mCpgL4oEFaizvZ79kK3wN9tvRS2O6xVxNBzzTdm2ypDJOqgq3zah/rx3JfmMRBYohBuEhAP9b7qK6CHismiXdeO9iEuwAhG51N7SmlH759NQ4QG3ufZhfuB/H21a8rJ6r56aKrd2n6KeTPsEld4pfbxMSwSWAELisR++RQaEOYBhDfMor4hhebND51BXGgAThk2KZJwrHFOHxmCIAXNlqpNXEVjz/A+j7CU5lh1u8booW5AqcixYjcjadXDw15tmMHqjtauoPA8dKBNo50zPFt4yjMEShFTaB/67ggEonANidyjPyir/9PDUOjYxwo2Mor3pEDnx/qpAgqj7W+hqR+Aa2LqUQ1loIcNQDKMZbuDTQqFLw8J5y+wQb1dKBPnXIodbS6LwIrxx41j8vKB5SW5TNQ1A/cNZiFf8JVcEd8BZ2AtBDgDYEKgmYsBMOKYVw/td6ASakwxQAXRmqNdeqM7/WeASZYH3qM52P8qr4s+EvDCDjRN9QAMLtBjeWCwITp2A/RUFKH9cB4EMejDlMICwtzfjG9YzyHPFYAFVhch3SM8yGGZfK2fbGVP4HV5qbpDobzgASseWtm3yCEp1lECpKyDp2JumNNnyQBe6Cks6HYtyHPzthMhqOuPZVP/Fx4WzZNODC086dGYBO5AF6CvNDpfV7JVfblSV2DLZ5gTREixX13nY1pgNx4glYoy/zyezsBtHK3HQWhPZV8eq9Wrg4o5ksyUALgqJr6nsh8gLnI02TdK5KkcD6Bqxak7HoCmRczF+lSOY9W3sMaghNnlKehUrx7BaND4GVbQT835ER5RBJqnQTU89dWpavfQtUXMUfHUd7tqgGaiIblSSh0feKKWKCY2HGaepWAnxnrSFjT66tg9rUoO/pSkQ8JTXw1VO64bAVZH5AYttBrN2k2r3T83BZkUPi5oBCiObmVwTCNwlPCtKaY89dVwMg8Bn+AlTKAHJg5oz83axebBP0bseF4lIsOQ4W8xWwCpHw+wa0bZ3K07UkzJ6c/QRRwTFTwJDIfuDN+LOHrHCMr40JTDoVrdt2ISfxjLfh0QHZMww7ivetA1JHqYv1IwhnHfwbYl0Xy/yqaGj+DmU1SMEf0ajOjJK6QbDyV8y4q7Vb/jNj0e4PURk7g+17zjHnVxJ1TBoZg507j/vTzgB1y+g3mL9TIZCoc3RY6hIsgdeB2lWN440wvoKWB5X9bNRZWKOS9cfPMKrkaYg55P1b4Dr24CfYLiUNSw6+sTRCJ6Adoohud2Xz3ULWwfDEtjQNisTgsU/xSkQ7qxht+qYlrV+tUdbRcBybC+d0QJGlZBL2I60+dqXXpiXqA+d/0vFxCL6UWf+3oc4RuZQIPuW8QdsSfRpm6r5Ob27suX3wAzmz9sujgAAA=="; \ No newline at end of file diff --git a/Documentation/classes/Theme.theme.html b/Documentation/classes/Theme.theme.html index f893d89..d967402 100644 --- a/Documentation/classes/Theme.theme.html +++ b/Documentation/classes/Theme.theme.html @@ -1,4 +1,4 @@ -theme | @playform/document - v0.0.2

Hierarchy

  • DefaultTheme
    • theme

Constructors

constructor +theme | @playform/document - v0.0.3

Hierarchy

  • DefaultTheme
    • theme

Constructors

Properties

  • Optional relative: Reflection

    The parent reflection the url generation should stop on.

  • Optional separator: string

    The separator used to generate the url.

  • Returns string

    The generated url.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Document.Exec.html b/Documentation/functions/Document.Exec.html index 9e56e7a..51b83ba 100644 --- a/Documentation/functions/Document.Exec.html +++ b/Documentation/functions/Document.Exec.html @@ -1,4 +1,4 @@ -Exec | @playform/document - v0.0.2
    • The 'Exec' function is an asynchronous function that executes a command and logs the +Exec | @playform/document - v0.0.3

      • 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>

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Document.document-1.html b/Documentation/functions/Document.document-1.html index 73f42a2..102eb71 100644 --- a/Documentation/functions/Document.document-1.html +++ b/Documentation/functions/Document.document-1.html @@ -1,6 +1,6 @@ -document | @playform/document - v0.0.2
    • Represents a function that processes file patterns.

      +document | @playform/document - v0.0.3
      • 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.

        • Optional Option: {
              ESBuild?: string;
              TypeScript?: string;
          }

          An optional object that can contain two properties.

          • Optional ESBuild?: string

            A string representing the ESBuild option.

          • Optional TypeScript?: string

            A string representing the TypeScript option.

            -

        Returns Promise<void>

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Document.resolve.html b/Documentation/functions/Document.resolve.html index 0d4bb3e..8099c76 100644 --- a/Documentation/functions/Document.resolve.html +++ b/Documentation/functions/Document.resolve.html @@ -1,4 +1,4 @@ -resolve | @playform/document - v0.0.2
    • The right-most parameter is considered {to}. Other parameters are considered an array of {from}.

      +resolve | @playform/document - v0.0.3
      • 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

        Throws

        if any of the arguments is not a string.

        -

      Generated using TypeDoc

      \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Exec.exec.html b/Documentation/functions/Exec.exec.html index 709b5dc..f06f935 100644 --- a/Documentation/functions/Exec.exec.html +++ b/Documentation/functions/Exec.exec.html @@ -1,4 +1,4 @@ -exec | @playform/document - v0.0.2
    • The 'Exec' function is an asynchronous function that executes a command and logs the +exec | @playform/document - v0.0.3

      • 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>

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/JSON.JSON.html b/Documentation/functions/JSON.JSON.html index 64d94d5..6a58f2a 100644 --- a/Documentation/functions/JSON.JSON.html +++ b/Documentation/functions/JSON.JSON.html @@ -1,4 +1,4 @@ -JSON | @playform/document - v0.0.2
    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +JSON | @playform/document - v0.0.3

      • 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>

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<any>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/functions/Load.load-1.html b/Documentation/functions/Load.load-1.html index 288fc05..285dc84 100644 --- a/Documentation/functions/Load.load-1.html +++ b/Documentation/functions/Load.load-1.html @@ -1 +1 @@ -load | @playform/document - v0.0.2

    Generated using TypeDoc

    \ No newline at end of file +load | @playform/document - v0.0.3

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/index.html b/Documentation/index.html index 701123b..93778fe 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -1,8 +1,8 @@ -@playform/document - v0.0.2

    @playform/document - v0.0.2

    📃 Document

    Document all your TypeScript files using TypeDoc.

    +@playform/document - v0.0.3

    @playform/document - v0.0.3

    📃 Document

    Document all your TypeScript files using TypeDoc.

    Installation

    Add configuration and setup scripts:

    npm install -D -E @playform/document
     

    Usage

    package.json

    {
    "scripts": {
    "Document": "Document 'Source/**/*.ts'"
    }
    }
    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Build.Interface.html b/Documentation/interfaces/Build.Interface.html index 6d00525..d04d90f 100644 --- a/Documentation/interfaces/Build.Interface.html +++ b/Documentation/interfaces/Build.Interface.html @@ -1,6 +1,6 @@ -Interface | @playform/document - v0.0.2
    interface Interface ((File, Option?) => Promise<void>)
    • Represents a function that processes file patterns.

      +Interface | @playform/document - v0.0.3
      interface Interface ((File, Option?) => Promise<void>)
      • 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.

        • Optional Option: {
              ESBuild?: string;
              TypeScript?: string;
          }

          An optional object that can contain two properties.

          • Optional ESBuild?: string

            A string representing the ESBuild option.

          • Optional TypeScript?: string

            A string representing the TypeScript option.

            -

        Returns Promise<void>

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Exec.Interface.html b/Documentation/interfaces/Exec.Interface.html index 9fa2b6f..117d2b0 100644 --- a/Documentation/interfaces/Exec.Interface.html +++ b/Documentation/interfaces/Exec.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/document - v0.0.2
    interface Interface ((Command, Echo?) => Promise<void>)
    • The 'Exec' function is an asynchronous function that executes a command and logs the +Interface | @playform/document - v0.0.3

      interface Interface ((Command, Echo?) => Promise<void>)
      • 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>

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<void>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Interface_Mapping.Interface.html b/Documentation/interfaces/Interface_Mapping.Interface.html index f79c3af..cd7718e 100644 --- a/Documentation/interfaces/Interface_Mapping.Interface.html +++ b/Documentation/interfaces/Interface_Mapping.Interface.html @@ -1,5 +1,5 @@ -Interface | @playform/document - v0.0.2
    interface Interface {
        Directory: string;
        Kind: ReflectionKind[];
    }

    Properties

    Directory +Interface | @playform/document - v0.0.3
    interface Interface {
        Directory: string;
        Kind: ReflectionKind[];
    }

    Properties

    Properties

    Directory: string

    The name of the directory the output files should be written to.

    -
    Kind: ReflectionKind[]

    DeclarationReflection.kind this rule applies to.

    -

    Generated using TypeDoc

    \ No newline at end of file +
    Kind: ReflectionKind[]

    DeclarationReflection.kind this rule applies to.

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Interface_Theme.Type.html b/Documentation/interfaces/Interface_Theme.Type.html index 0264284..6d17a5f 100644 --- a/Documentation/interfaces/Interface_Theme.Type.html +++ b/Documentation/interfaces/Interface_Theme.Type.html @@ -1,4 +1,4 @@ -Type | @playform/document - v0.0.2
    interface Type {
        Mapping: Interface[];
        _Mapping: ((Reflection) => undefined | Interface);
        buildUrls: ((Reflection, URLs) => UrlMapping<any>[]);
        componentName: string;
        defaultLayoutTemplate: ((pageEvent, template) => JsxElement);
        hierarchyTemplate: ((pageEvent) => JsxElement);
        icons: {
            1: (() => JsxElement);
            1024: (() => JsxElement);
            1048576: (() => JsxElement);
            128: (() => JsxElement);
            131072: (() => JsxElement);
            16: (() => JsxElement);
            16384: (() => JsxElement);
            2: (() => JsxElement);
            2048: (() => JsxElement);
            2097152: (() => JsxElement);
            256: (() => JsxElement);
            262144: (() => JsxElement);
            32: (() => JsxElement);
            32768: (() => JsxElement);
            4: (() => JsxElement);
            4096: (() => JsxElement);
            4194304: (() => JsxElement);
            512: (() => JsxElement);
            524288: (() => JsxElement);
            64: (() => JsxElement);
            65536: (() => JsxElement);
            8: (() => JsxElement);
            8192: (() => JsxElement);
            anchor: (() => JsxElement);
            checkbox: (() => JsxElement);
            chevronDown: (() => JsxElement);
            chevronSmall: (() => JsxElement);
            menu: (() => JsxElement);
            search: (() => JsxElement);
        };
        indexTemplate: ((pageEvent) => JsxElement);
        markedPlugin: MarkedPlugin;
        reflectionTemplate: ((pageEvent) => JsxElement);
        get _listenId(): any;
        get application(): Application;
        get owner(): O;
        bubble(name, ...args): this;
        buildNavigation(project): NavigationElement[];
        getNavigation(project): NavigationElement[];
        getReflectionClasses(reflection): string;
        getRenderContext(pageEvent): DefaultThemeRenderContext;
        getUrls(project): UrlMapping<any>[];
        initialize(): void;
        listenTo(obj, name, callback?, priority?): this;
        listenToOnce(obj, eventMap): this;
        listenToOnce(obj, name, callback, priority?): this;
        off(): this;
        off(eventMap, context?): this;
        off(name, callback?, context?): this;
        on(eventMap, context?): this;
        on(eventMap, callback?, context?, priority?): this;
        on(name, callback, context?, priority?): this;
        once(eventMap, context?): this;
        once(name, callback, context?, priority?): this;
        render(page, template): string;
        stopListening(obj?, name?, callback?): this;
        trigger(name, ...args): this;
    }

    Hierarchy

    • DefaultTheme
      • Type

    Properties

    Mapping +Type | @playform/document - v0.0.3
    interface Type {
        Mapping: Interface[];
        _Mapping: ((Reflection) => undefined | Interface);
        buildUrls: ((Reflection, URLs) => UrlMapping<any>[]);
        componentName: string;
        defaultLayoutTemplate: ((pageEvent, template) => JsxElement);
        hierarchyTemplate: ((pageEvent) => JsxElement);
        icons: {
            1: (() => JsxElement);
            1024: (() => JsxElement);
            1048576: (() => JsxElement);
            128: (() => JsxElement);
            131072: (() => JsxElement);
            16: (() => JsxElement);
            16384: (() => JsxElement);
            2: (() => JsxElement);
            2048: (() => JsxElement);
            2097152: (() => JsxElement);
            256: (() => JsxElement);
            262144: (() => JsxElement);
            32: (() => JsxElement);
            32768: (() => JsxElement);
            4: (() => JsxElement);
            4096: (() => JsxElement);
            4194304: (() => JsxElement);
            512: (() => JsxElement);
            524288: (() => JsxElement);
            64: (() => JsxElement);
            65536: (() => JsxElement);
            8: (() => JsxElement);
            8192: (() => JsxElement);
            anchor: (() => JsxElement);
            checkbox: (() => JsxElement);
            chevronDown: (() => JsxElement);
            chevronSmall: (() => JsxElement);
            menu: (() => JsxElement);
            search: (() => JsxElement);
        };
        indexTemplate: ((pageEvent) => JsxElement);
        markedPlugin: MarkedPlugin;
        reflectionTemplate: ((pageEvent) => JsxElement);
        get _listenId(): any;
        get application(): Application;
        get owner(): O;
        bubble(name, ...args): this;
        buildNavigation(project): NavigationElement[];
        getNavigation(project): NavigationElement[];
        getReflectionClasses(reflection): string;
        getRenderContext(pageEvent): DefaultThemeRenderContext;
        getUrls(project): UrlMapping<any>[];
        initialize(): void;
        listenTo(obj, name, callback?, priority?): this;
        listenToOnce(obj, eventMap): this;
        listenToOnce(obj, name, callback, priority?): this;
        off(): this;
        off(eventMap, context?): this;
        off(name, callback?, context?): this;
        on(eventMap, context?): this;
        on(eventMap, callback?, context?, priority?): this;
        on(name, callback, context?, priority?): this;
        once(eventMap, context?): this;
        once(name, callback, context?, priority?): this;
        render(page, template): string;
        stopListening(obj?, name?, callback?): this;
        trigger(name, ...args): this;
    }

    Hierarchy

    • DefaultTheme
      • Type

    Properties

    Mapping: Interface[]

    An array of Mappings representing the theme's mapping configuration.

    -
    _Mapping: ((Reflection) => undefined | Interface)

    A function that maps a DeclarationReflection to a Mapping or returns undefined.

    +
    _Mapping: ((Reflection) => undefined | Interface)

    A function that maps a DeclarationReflection to a Mapping or returns undefined.

    Type declaration

      • (Reflection): undefined | Interface
      • Parameters

        • Reflection: DeclarationReflection

          The DeclarationReflection to map to a Mapping.

          -

        Returns undefined | Interface

    buildUrls: ((Reflection, URLs) => UrlMapping<any>[])

    A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.

    +

    Returns undefined | Interface

    buildUrls: ((Reflection, URLs) => UrlMapping<any>[])

    A function that builds URLs for a given DeclarationReflection and an array of URLs mappings.

    Type declaration

      • (Reflection, URLs): UrlMapping<any>[]
      • Parameters

        • Reflection: DeclarationReflection

          The DeclarationReflection for which URLs are being built.

        • URLs: UrlMapping<any>[]

          An array of URLs mappings with any data type.

          -

        Returns UrlMapping<any>[]

    componentName: string

    The name of this component as set by the @Component decorator.

    +

    Returns UrlMapping<any>[]

    componentName: string

    The name of this component as set by the @Component decorator.

    defaultLayoutTemplate: ((pageEvent, template) => JsxElement)

    Type declaration

      • (pageEvent, template): JsxElement
      • Parameters

        • pageEvent: PageEvent<Reflection>
        • template: RenderTemplate<PageEvent<Reflection>>

        Returns JsxElement

    hierarchyTemplate: ((pageEvent) => JsxElement)

    Type declaration

      • (pageEvent): JsxElement
      • Parameters

        • pageEvent: PageEvent<ProjectReflection>

        Returns JsxElement

    icons: {
        1: (() => JsxElement);
        1024: (() => JsxElement);
        1048576: (() => JsxElement);
        128: (() => JsxElement);
        131072: (() => JsxElement);
        16: (() => JsxElement);
        16384: (() => JsxElement);
        2: (() => JsxElement);
        2048: (() => JsxElement);
        2097152: (() => JsxElement);
        256: (() => JsxElement);
        262144: (() => JsxElement);
        32: (() => JsxElement);
        32768: (() => JsxElement);
        4: (() => JsxElement);
        4096: (() => JsxElement);
        4194304: (() => JsxElement);
        512: (() => JsxElement);
        524288: (() => JsxElement);
        64: (() => JsxElement);
        65536: (() => JsxElement);
        8: (() => JsxElement);
        8192: (() => JsxElement);
        anchor: (() => JsxElement);
        checkbox: (() => JsxElement);
        chevronDown: (() => JsxElement);
        chevronSmall: (() => JsxElement);
        menu: (() => JsxElement);
        search: (() => JsxElement);
    }

    The icons which will actually be rendered. The source of truth lives on the theme, and the DefaultThemeRenderContext.icons member will produce references to these.

    These icons will be written twice. Once to an icons.svg file in the assets directory @@ -71,4 +71,4 @@ passed the same arguments as trigger is, apart from the event name (unless you're listening on "all", which will cause your callback to receive the true name of the event as the first argument).

    -

    Parameters

    • name: string | Event | EventMap
    • Rest ...args: any[]

    Returns this

    Generated using TypeDoc

    \ No newline at end of file +

    Parameters

    Returns this

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/JSON.Interface.html b/Documentation/interfaces/JSON.Interface.html index 17d679e..602cd01 100644 --- a/Documentation/interfaces/JSON.Interface.html +++ b/Documentation/interfaces/JSON.Interface.html @@ -1,4 +1,4 @@ -Interface | @playform/document - v0.0.2
    interface Interface ((File, From?) => Promise<any>)
    • The function 'JSON' is a TypeScript function that reads a JSON file and returns its +Interface | @playform/document - v0.0.3

      interface Interface ((File, From?) => Promise<any>)
      • 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>

      Generated using TypeDoc

      \ No newline at end of file +

    Returns Promise<any>

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/interfaces/Load.Interface.html b/Documentation/interfaces/Load.Interface.html index 1931d25..5d795b5 100644 --- a/Documentation/interfaces/Load.Interface.html +++ b/Documentation/interfaces/Load.Interface.html @@ -1,5 +1,5 @@ -Interface | @playform/document - v0.0.2
    interface Interface {
        load: ((Application) => void);
    }

    Properties

    load +Interface | @playform/document - v0.0.3
    interface Interface {
        load: ((Application) => void);
    }

    Properties

    Properties

    load: ((Application) => void)

    The Load function is responsible for loading a plugin into the TypeDoc instance.

    Type declaration

      • (Application): void
      • Parameters

        • Application: Application

          The Application parameter is an instance of TypeDoc's Application class, representing the TypeDoc application to which the plugin should be loaded.

          -

        Returns void

    Generated using TypeDoc

    \ No newline at end of file +

    Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Build.html b/Documentation/modules/Build.html index dd1de94..3dcc3e2 100644 --- a/Documentation/modules/Build.html +++ b/Documentation/modules/Build.html @@ -1,2 +1,2 @@ -Build | @playform/document - v0.0.2

    Index

    Interfaces

    Generated using TypeDoc

    \ No newline at end of file +Build | @playform/document - v0.0.3

    Index

    Interfaces

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Document.html b/Documentation/modules/Document.html index 2d0276e..9a62806 100644 --- a/Documentation/modules/Document.html +++ b/Documentation/modules/Document.html @@ -1,7 +1,7 @@ -Document | @playform/document - v0.0.2

    Index

    Variables

    Current +Document | @playform/document - v0.0.3

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Exec.html b/Documentation/modules/Exec.html index 929120a..5359f10 100644 --- a/Documentation/modules/Exec.html +++ b/Documentation/modules/Exec.html @@ -1,3 +1,3 @@ -Exec | @playform/document - v0.0.2

    Index

    Interfaces

    Interface +Exec | @playform/document - v0.0.3

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Interface_Mapping.html b/Documentation/modules/Interface_Mapping.html index 4fba2fb..2798185 100644 --- a/Documentation/modules/Interface_Mapping.html +++ b/Documentation/modules/Interface_Mapping.html @@ -1,2 +1,2 @@ -Interface/Mapping | @playform/document - v0.0.2

    Module Interface/Mapping

    Index

    Interfaces

    Generated using TypeDoc

    \ No newline at end of file +Interface/Mapping | @playform/document - v0.0.3

    Module Interface/Mapping

    Index

    Interfaces

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Interface_Theme.html b/Documentation/modules/Interface_Theme.html index 40c2dc1..57f4624 100644 --- a/Documentation/modules/Interface_Theme.html +++ b/Documentation/modules/Interface_Theme.html @@ -1,2 +1,2 @@ -Interface/Theme | @playform/document - v0.0.2

    Module Interface/Theme

    Index

    Interfaces

    Generated using TypeDoc

    \ No newline at end of file +Interface/Theme | @playform/document - v0.0.3

    Module Interface/Theme

    Index

    Interfaces

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/JSON.html b/Documentation/modules/JSON.html index 4af8d3b..19d5786 100644 --- a/Documentation/modules/JSON.html +++ b/Documentation/modules/JSON.html @@ -1,3 +1,3 @@ -JSON | @playform/document - v0.0.2

    Index

    Interfaces

    Interface +JSON | @playform/document - v0.0.3

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Load.html b/Documentation/modules/Load.html index e4ddf73..e4af713 100644 --- a/Documentation/modules/Load.html +++ b/Documentation/modules/Load.html @@ -1,5 +1,5 @@ -Load | @playform/document - v0.0.2

    Index

    Interfaces

    Interface +Load | @playform/document - v0.0.3

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/modules/Theme.html b/Documentation/modules/Theme.html index d279b3b..c94f489 100644 --- a/Documentation/modules/Theme.html +++ b/Documentation/modules/Theme.html @@ -1,2 +1,2 @@ -Theme | @playform/document - v0.0.2

    Index

    Classes

    Generated using TypeDoc

    \ No newline at end of file +Theme | @playform/document - v0.0.3

    Index

    Classes

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Document.Current.html b/Documentation/variables/Document.Current.html index bdf6798..82d8138 100644 --- a/Documentation/variables/Document.Current.html +++ b/Documentation/variables/Document.Current.html @@ -1 +1 @@ -Current | @playform/document - v0.0.2

    Variable CurrentConst

    Current: string = ...

    Generated using TypeDoc

    \ No newline at end of file +Current | @playform/document - v0.0.3

    Variable CurrentConst

    Current: string = ...

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Document.Pipe.html b/Documentation/variables/Document.Pipe.html index 9328072..df4bcf0 100644 --- a/Documentation/variables/Document.Pipe.html +++ b/Documentation/variables/Document.Pipe.html @@ -1 +1 @@ -Pipe | @playform/document - v0.0.2
    Pipe: string[] = []

    Generated using TypeDoc

    \ No newline at end of file +Pipe | @playform/document - v0.0.3
    Pipe: string[] = []

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Document.document.html b/Documentation/variables/Document.document.html index 71b2174..036e5fc 100644 --- a/Documentation/variables/Document.document.html +++ b/Documentation/variables/Document.document.html @@ -1 +1 @@ -document | @playform/document - v0.0.2
    document: Command

    Generated using TypeDoc

    \ No newline at end of file +document | @playform/document - v0.0.3
    document: Command

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Load.Theme.html b/Documentation/variables/Load.Theme.html index ee517cc..57c38eb 100644 --- a/Documentation/variables/Load.Theme.html +++ b/Documentation/variables/Load.Theme.html @@ -1 +1 @@ -Theme | @playform/document - v0.0.2
    Theme: typeof theme

    Generated using TypeDoc

    \ No newline at end of file +Theme | @playform/document - v0.0.3
    Theme: typeof theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Documentation/variables/Load.load.html b/Documentation/variables/Load.load.html index 82078c2..38a4cda 100644 --- a/Documentation/variables/Load.load.html +++ b/Documentation/variables/Load.load.html @@ -1 +1 @@ -load | @playform/document - v0.0.2
    load: Interface

    Generated using TypeDoc

    \ No newline at end of file +load | @playform/document - v0.0.3
    load: Interface

    Generated using TypeDoc

    \ No newline at end of file diff --git a/Target/Class/Document.js b/Target/Class/Document.js index feb67a9..85b82b4 100644 --- a/Target/Class/Document.js +++ b/Target/Class/Document.js @@ -1,2 +1,2 @@ #!/usr/bin/env node -var e=new(await import("commander")).Command().name("Document").version("0.0.2").description("\u{1F4C3}\u2000Document.").argument("","File.").action((await import("../Function/Document.js")).default).parse();export{e as default}; +var e=new(await import("commander")).Command().name("Document").version("0.0.3").description("\u{1F4C3}\u2000Document.").argument("","File.").action((await import("../Function/Document.js")).default).parse();export{e as default};