From 053c9f2153f4387855fb1d8fa394d0869c4422d5 Mon Sep 17 00:00:00 2001 From: "Nikola R. Hristov" Date: Thu, 4 Apr 2024 23:40:38 +0300 Subject: [PATCH] squash! --- Documentation/.nojekyll | 2 +- Documentation/assets/highlight.css | 209 +- Documentation/assets/icons.js | 2 +- Documentation/assets/icons.svg | 2 +- Documentation/assets/navigation.js | 2 +- Documentation/assets/search.js | 2 +- Documentation/assets/style.css | 1714 ++++++++--------- Documentation/classes/File.file.html | 1144 ++++++++++- Documentation/functions/Apply.apply.html | 427 +++- Documentation/functions/By.by.html | 472 ++++- Documentation/functions/Bytes.bytes.html | 380 +++- Documentation/functions/File.Merge.html | 559 +++++- Documentation/functions/In.Apply.html | 427 +++- Documentation/functions/In.in.html | 420 +++- Documentation/functions/Merge.merge.html | 559 +++++- Documentation/functions/Not.not.html | 449 ++++- Documentation/functions/Pipe.dirname.html | 345 +++- Documentation/functions/Pipe.pipe.html | 378 +++- Documentation/functions/Pipe.stat.html | 558 +++++- Documentation/hierarchy.html | 290 ++- Documentation/index.html | 510 ++++- Documentation/interfaces/Apply.Type.html | 446 ++++- Documentation/interfaces/By.Type.html | 501 ++++- Documentation/interfaces/Bytes.Type.html | 393 +++- Documentation/interfaces/File.Type.html | 1396 +++++++++++++- Documentation/interfaces/In.Type.html | 448 ++++- .../interfaces/Interface_Action.Type.html | 1651 +++++++++++++++- .../interfaces/Interface_Cache.Type.html | 470 ++++- .../interfaces/Interface_Dir.Type.html | 472 ++++- .../interfaces/Interface_File.Type.html | 656 ++++++- .../interfaces/Interface_Merge.Generic.html | 418 +++- .../interfaces/Interface_Merge.Type.html | 1112 ++++++++++- .../interfaces/Interface_Option.Type.html | 873 ++++++++- .../interfaces/Interface_Plan.Type.html | 827 +++++++- Documentation/interfaces/Not.Type.html | 470 ++++- Documentation/interfaces/Pipe.Type.html | 400 +++- Documentation/modules/Apply.html | 321 ++- Documentation/modules/By.html | 321 ++- Documentation/modules/Bytes.html | 337 +++- Documentation/modules/File.html | 375 +++- Documentation/modules/In.html | 348 +++- Documentation/modules/Interface_Action.html | 307 ++- Documentation/modules/Interface_Cache.html | 307 ++- Documentation/modules/Interface_Dir.html | 305 ++- Documentation/modules/Interface_File.html | 307 ++- Documentation/modules/Interface_Merge.html | 2 +- Documentation/modules/Interface_Option.html | 307 ++- Documentation/modules/Merge.html | 305 ++- Documentation/modules/Not.html | 337 +++- Documentation/modules/Option.html | 305 ++- Documentation/modules/Pipe.html | 343 +++- Documentation/modules/Type_Buffer.html | 305 ++- Documentation/modules/Type_Exclude.html | 305 ++- Documentation/modules/Type_Logger.html | 305 ++- Documentation/modules/Type_Path.html | 305 ++- Documentation/types/Type_Buffer.Type.html | 315 ++- Documentation/types/Type_Exclude.Type.html | 353 +++- Documentation/types/Type_Logger.Type.html | 298 ++- Documentation/types/Type_Path.Type.html | 309 ++- Documentation/variables/Bytes.Kilobyte.html | 295 ++- Documentation/variables/File.Action.html | 1114 ++++++++++- Documentation/variables/File.Cache.html | 322 +++- Documentation/variables/File.Logger.html | 290 ++- Documentation/variables/In._Path.html | 294 ++- Documentation/variables/Not.Filters.html | 302 ++- Documentation/variables/Option.option.html | 1524 ++++++++++++++- README.md | 26 +- Source/Class/{File.ts => Pipe.ts} | 19 +- Source/Function/By.ts | 4 +- Source/Function/Bytes.ts | 2 +- Source/Function/In.ts | 4 +- Source/Interface/By.ts | 2 +- Source/Variable/Option.ts | 2 +- Target/Class/File.d.ts | 28 - Target/Class/Pipe.d.ts | 28 + Target/Class/{File.js => Pipe.js} | 0 Target/Function/In.d.ts | 2 +- Target/Variable/Option.d.ts | 14 +- package.json | 8 +- 79 files changed, 29355 insertions(+), 1331 deletions(-) rename Source/Class/{File.ts => Pipe.ts} (84%) delete mode 100644 Target/Class/File.d.ts create mode 100644 Target/Class/Pipe.d.ts rename Target/Class/{File.js => Pipe.js} (100%) diff --git a/Documentation/.nojekyll b/Documentation/.nojekyll index e2ac6616..9ac476e9 100644 --- a/Documentation/.nojekyll +++ b/Documentation/.nojekyll @@ -1 +1 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. diff --git a/Documentation/assets/highlight.css b/Documentation/assets/highlight.css index a390d83f..148f9f5b 100644 --- a/Documentation/assets/highlight.css +++ b/Documentation/assets/highlight.css @@ -1,99 +1,128 @@ :root { - --light-hl-0: #795E26; - --dark-hl-0: #DCDCAA; - --light-hl-1: #000000; - --dark-hl-1: #D4D4D4; - --light-hl-2: #A31515; - --dark-hl-2: #CE9178; - --light-hl-3: #0000FF; - --dark-hl-3: #569CD6; - --light-hl-4: #AF00DB; - --dark-hl-4: #C586C0; - --light-hl-5: #008000; - --dark-hl-5: #6A9955; - --light-hl-6: #001080; - --dark-hl-6: #9CDCFE; - --light-hl-7: #000000FF; - --dark-hl-7: #D4D4D4; - --light-hl-8: #098658; - --dark-hl-8: #B5CEA8; - --light-hl-9: #267F99; - --dark-hl-9: #4EC9B0; - --light-hl-10: #000000; - --dark-hl-10: #C8C8C8; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; + --light-hl-0: #795e26; + --dark-hl-0: #dcdcaa; + --light-hl-1: #000000; + --dark-hl-1: #d4d4d4; + --light-hl-2: #a31515; + --dark-hl-2: #ce9178; + --light-hl-3: #0000ff; + --dark-hl-3: #569cd6; + --light-hl-4: #af00db; + --dark-hl-4: #c586c0; + --light-hl-5: #008000; + --dark-hl-5: #6a9955; + --light-hl-6: #001080; + --dark-hl-6: #9cdcfe; + --light-hl-7: #000000ff; + --dark-hl-7: #d4d4d4; + --light-hl-8: #098658; + --dark-hl-8: #b5cea8; + --light-hl-9: #267f99; + --dark-hl-9: #4ec9b0; + --light-hl-10: #000000; + --dark-hl-10: #c8c8c8; + --light-code-background: #ffffff; + --dark-code-background: #1e1e1e; } -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --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); - --hl-10: var(--light-hl-10); - --code-background: var(--light-code-background); -} } +@media (prefers-color-scheme: light) { + :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --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); + --hl-10: var(--light-hl-10); + --code-background: var(--light-code-background); + } +} -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --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); - --hl-10: var(--dark-hl-10); - --code-background: var(--dark-code-background); -} } +@media (prefers-color-scheme: dark) { + :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --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); + --hl-10: var(--dark-hl-10); + --code-background: var(--dark-code-background); + } +} -:root[data-theme='light'] { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --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); - --hl-10: var(--light-hl-10); - --code-background: var(--light-code-background); +:root[data-theme="light"] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --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); + --hl-10: var(--light-hl-10); + --code-background: var(--light-code-background); } -:root[data-theme='dark'] { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --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); - --hl-10: var(--dark-hl-10); - --code-background: var(--dark-code-background); +:root[data-theme="dark"] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --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); + --hl-10: var(--dark-hl-10); + --code-background: var(--dark-code-background); } -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.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); } -.hl-10 { color: var(--hl-10); } -pre, code { background: var(--code-background); } +.hl-0 { + color: var(--hl-0); +} +.hl-1 { + color: var(--hl-1); +} +.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); +} +.hl-10 { + color: var(--hl-10); +} +pre, +code { + background: var(--code-background); +} diff --git a/Documentation/assets/icons.js b/Documentation/assets/icons.js index b79c9e89..714bca23 100644 --- a/Documentation/assets/icons.js +++ b/Documentation/assets/icons.js @@ -12,4 +12,4 @@ }); } } -})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file +})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) diff --git a/Documentation/assets/icons.svg b/Documentation/assets/icons.svg index 7dead611..6a918307 100644 --- a/Documentation/assets/icons.svg +++ b/Documentation/assets/icons.svg @@ -1 +1 @@ - \ No newline at end of file + diff --git a/Documentation/assets/navigation.js b/Documentation/assets/navigation.js index ddbd5c14..909e2170 100644 --- a/Documentation/assets/navigation.js +++ b/Documentation/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACq2WUW+bMBSF/4ufo2xN22zLW2jXCW3r+rC3CkUGTGINjGWcqdGU/z7ZkIDh2iYlr1zO4bvHF9uv/5AkbxKt0Jrz/IBmiGO5QytUlOk+J9UH/Xi+k0WOZugPZSlaLWYo2dE8FYSh1evZ4PeBk1ZPmSQiw8nZQpV7PvfL4+wsx+b3sz1LJC3ZSY6HHMu7Y9QxCAD6YCJ64OeOQejgMI99uJJUELEk1VRoZeHj/k7zMj7IjsVfLCiOW4jTG6bL7cJo3mii279yiIfN9FJ4ojkZhqCejsogM+RJjqvqJM8GHjeLz50vW+PTal96a90nlJ2W12VHcA842YHRa7muOtQ/yu2WCKu8Ljv0P4nYEmjZtFxXnasWsuGahWza1IbMG/rmRamArkM21zVHy2vb9hKyObDHLe86WsosQso8MTXdITiL/hC1UTa6DTRHlwfbc4NjjuzTOeQCBvT9WLWZn+qRChfTIxXXIlJWfh5472pdRu9iI4gcm1Jk/7GHTMC/bYH6RhgRNPFw1X7Nu65/d0SPtZe/yV/c99vUb1wr+8bND/aSYyeWql8LSnvZkEaMxPhBKGyHRW1ReE+L51IOv/9cymlRKAPfgfFEc0lEBR0ZSt6UHacG66K3nSsx6zfQ69o2pRfMZsltl4zGpAS8bhfmTFIOrL56Oi1+7eDLP6WC4QIcHq1v6o6jlxv4PTkfdGFoK4nB1dNaVXSuX9M5FEqwzzICnEVKsqmL7whXHnjPA4j345dPN/fmCn99S/J9Ciyytmqq03hOJuOA+rdTgwe6m16K03iMozHvjAbL8Mp4KYl2cHFEx+g/noc3GGMPAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAACq2WUW+bMBSF/4ufo2xN22zLW2jXCW3r+rC3CkUGTGINjGWcqdGU/z7ZkIDh2iYlr1zO4bvHF9uv/5AkbxKt0Jrz/IBmiGO5QytUlOk+J9UH/Xi+k0WOZugPZSlaLWYo2dE8FYSh1evZ4PeBk1ZPmSQiw8nZQpV7PvfL4+wsx+b3sz1LJC3ZSY6HHMu7Y9QxCAD6YCJ64OeOQejgMI99uJJUELEk1VRoZeHj/k7zMj7IjsVfLCiOW4jTG6bL7cJo3mii279yiIfN9FJ4ojkZhqCejsogM+RJjqvqJM8GHjeLz50vW+PTal96a90nlJ2W12VHcA842YHRa7muOtQ/yu2WCKu8Ljv0P4nYEmjZtFxXnasWsuGahWza1IbMG/rmRamArkM21zVHy2vb9hKyObDHLe86WsosQso8MTXdITiL/hC1UTa6DTRHlwfbc4NjjuzTOeQCBvT9WLWZn+qRChfTIxXXIlJWfh5472pdRu9iI4gcm1Jk/7GHTMC/bYH6RhgRNPFw1X7Nu65/d0SPtZe/yV/c99vUb1wr+8bND/aSYyeWql8LSnvZkEaMxPhBKGyHRW1ReE+L51IOv/9cymlRKAPfgfFEc0lEBR0ZSt6UHacG66K3nSsx6zfQ69o2pRfMZsltl4zGpAS8bhfmTFIOrL56Oi1+7eDLP6WC4QIcHq1v6o6jlxv4PTkfdGFoK4nB1dNaVXSuX9M5FEqwzzICnEVKsqmL7whXHnjPA4j345dPN/fmCn99S/J9Ciyytmqq03hOJuOA+rdTgwe6m16K03iMozHvjAbL8Mp4KYl2cHFEx+g/noc3GGMPAAA=" diff --git a/Documentation/assets/search.js b/Documentation/assets/search.js index 2d7f5f59..8c261f7a 100644 --- a/Documentation/assets/search.js +++ b/Documentation/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACuU927LbOHL/Ir/kgaFxB+HKy0w2SU0lm93a3B5crin5HB6bGR1JpYt3nKn591TjQqFBtEgd2bPO5mXMIYDuRt/Q3Wjq/LI67P58XL15+8vqp2H7uHojmtV2/dyv3qz+sD8Nu+2qWZ0Pm9Wb1fPu8bzpj6/D6/bj6XmzalYPm/Xx2B9Xb1arX5sEQ16A7DCQT+vDsH6fgdlR0JrVfn3ot6cLIRf4RmtpRhQ//nj6vO8XoXg1zr2GKa7IEHIm1Ijv79cPH29C16YVC5C2kcIvt9mAPcL9W25uoiOSTnDi3/r14eHjPcS0I4hbaZoyCpH2j7vNY3+4i7QRxBcm7Y/r0208iwtepD0I87/sPny4kSnjkvuxf/ew2BUk7OOSv4zlBPSjStymCpF2ghl/6teP99DSRgA3E/T12eRJG/9P3EFk2CTBwf867E730ZkgfIs89LSN/6vuYWLYJumMjsf+Pk0cQXyLfAzEjf/P7mFk3Ch14qyHzZ2cHEF8i5wMxKX/vzGMwIyM+yTPiYfd834zHD/eyc4C0LfI1JzE9PYuj4n2TGnqefM0bO5W1gzKt8jakb70qrtLZcfdUlnBx/X2w50svcD4FhkaqUsv7jqT0k4pDR02t9EaF9wfpP7Dzw+b8+NtyC9rXoT/kiz/++d9/xqlBynphpEfYeRq3i2Ys1xjeCMowJoDgqfrefeFHJLYIqNA5IaxL0JwBLWQ5EgUSXQpY0R1HPwiZCdYC+lOdJGEf39+eqK4Hca+CNkR1EKqI1E1on/YnvrD0/qhf/3HzXpaSRqHf4Th66RrUyd7SDAm4ObJL8hbVO5ZgO/V9XIPxuqXLczXl+CeyddvQI588BLUV33wDYh/2D7tbkIcF9yNGFzd8SbMacXdqP/UH8+b023IL2vuRv+H7U2Y/0CXZK4jvbiGPw77qQOGl3e7AQ9k3vg9AdedFlEAv7BlQSn8NscVAd7iuibF8VudV4lzsfvKFi4qdS7DfrXYeRPy8phfhn8umLuJhHkfOsG/0IsuQF7UW5ehn6m43kTAkuNrQsDiA6xOwMWO/3V3mpjuv+5Od1srwJg3UMB+3bv8vj98mLrAC2f8+GJq/6nf9ofh4TqzA8g4damDCXQSIv5d3+/9hO8Oh/Xn43/86YdbKXhVBbGIqATnxe42QLnF25bMyAVbkeUXOBoWkTejasgNTTUNhr/gIebB3cJUTx4ZDO7Pp1vwvUorlmC9HhSdT7fiHpfcjfy7p9Oc6yxwpxV3o/6+f9odbpLxq3HJ/chxirsIeVryEuQ1c/ndMM2xL9h/N8xk2TcZC0C7xVaAtpebCsK22FLSqnsMBWNebCcV1KIeXSVBfRFnttCFXXdc84Bf/UBHWjVlvVrSvYZl/mrhsuQHMpn4/vMCZH7SV9/S95/bce7chr7/TG0oDxFpXGHWV98SxJWzpfXLGhxg4qxrWIQwTvvqG/MJ+ey14WVRkZnjreV1xCsow7TlW6sdAzh3nh4Eodfnyx0FAd4th8EtzVlLUL6a6cYqMF9PfXED1iL0Mx1XM+hF5qhO/XEiOf/2bnkFKPNSCjTUqauQ9gXoWkRUlaLv9vvNlCj/9m66ApR50gIN1y2yqGhMTTJeMn45m4wAbzHK631f07v3RXhfzd+2lxRct07crLKQhuvtKTcRUG3yWEbGoraOm4gp7+6X0TF3Wz9HwtLjdJ6EuVioSsncHXzRGbaMoJlesN+AJbjhiw546zy53uKFmjaXkXO1TfM3YEfei0mHlXVmLO++XEbL9X7L34AZqKmSDkXr3CjbKM2FGY/DwT8lap7OW78wXkbF4ZvuozLox9P6RIGGsZfC3edpQgF3X7+Jo+FKlJaf+sMl/rq00ECKE0dvqZ5nNG93NVYA3G21tL+gIl+vw89X3zOqnhGIC10ByDMBKqOtLCtnsHFsdoH9w7alAjSqNJzJ6EfiIwQoFRBtRhTUjNZhWyd0mPnAh6Lyn4fN7v3napd3CMPThNtC8Yzi9yhTuBAdwL8nMoalsKuA2/czMkNBegZvTWhCUIP1vDKUIXbGaeqbJp8rU4kuXQlb2HtYQJ/7Ousy/eYPkuqY5r4+yla98GsjAu9MonsNbyY08nMev55sv6PFlsEmP9bxsMk868uoRAZ+kU686FMbAtP1D2vyRS/tuL2GeOy2pT82mpLwos9kKCquB2lfc//4kxd5CwNe9okLRchMEvM1eYCzF3cLD174dQpFyUyy/zWZgL800bcw4a4vSyh6FhUcviZDal+J3OQg7v0qhJTUbFXqq+pJ+YWHvUlVXv5FB0XQXEXoazKj+DrjJvc5rQRlYefvieTGw6HSpCuXpKIbQT/lF7hxdYD7VL/FpcFqfoldHnbb4+lwfjjtDjPQX+GpVxj2hNEJpi7byK56CTRz97zXoGfXBQT0uSvXa9DzK1AC/Oz95zX46C6SQDB/Efl05aIdXQlSGGbvAwOGd81q2D72P6/e/LL61B+OEFW+WYlWtnAUPw395hF+K2MVqz0Pu+dngPEujv1nD4oEM8KU12zVvGWN4i3j7941b9MC/96/8LM4MYujWWLVvOUNty2TeJpA0+SqeSsayVulNZom0TRFQVNoml41b2UjdculQNM0mmZWzVtVm2bQNLtq3upGdK21eJpF07pV89bUoHVomls1b20jVMuVQdMc5i6jtsoLMQC/u0ba1ijMOo4lwUlRcCwLCGLfuipELA1OioNjeXDgO2dVkH6IN7K1zDRcpAfZqLaLjAwwDIkMi4uDWLiqIsMS4x0JEsuMg2y4rgmXY7EJUmwCi02AcLipUSkKC6JNCMtNgHS4rYLEghOk4AQWnPDS6RruWiY7PBPbkvDicRV/ILB4BMhAsEaZlvMCJBaPACEIXkWO5SNACEJUYWL5SEbClFhAEqQgZA2mxAKSgoZZeDnv5lQVJpaQVDRMLCIJchC6ChOLSBoaJpaRtKQ7jiOtNLoRplGtk6oRtuGt7EQjOrBf7TJQpFv0I36lNl0jXCNbJV0jWXrgjWhZ5xoJ+Li2jZSNaHXcZIDuSP30Qx68chxgiNYpHWBI1TVAdnijG94aJRppGtFaGIJVNnc+CnRDdjUm+6GpA5OuUS2XGScUaI1ijdCtVQ7DgCFPhzW8UcABLmyjeGSFAuoZCBmoF9I0CqiXPAcPquY32HKBheaHxm0CCa2zIoAXrAPwvO06F8CzDpQpskLZRraG2QwPKKrqGmFbgw8wPwLCaK0IKsGNbWBqqxvl+WG6RrPIIc3Dmww0aLYWjTCt0QWHsNIrTaqyH7INa63yVLDWSZA6bw13IGwG3hH2HKaormFtpxsNLzruGi3jFK1gimg0rHHaNdqAsmrZaBvXwGYZ7xrtGt4K0xgW/+XxXxH/BfzMusaA3JhsjI4DJv7r2aVNY7r4IkDMtgwmaqt+U2HrVZZmDvawqqPsPI6I1jHXeK3QtlHxX89Vqw2Ye3gjYb9Ku8aC0SrGG+t1SvHGwkmurc6wOiqgUqPNMh6Ae3ME4E554Kq1UgJw0SoDsMMUq0o11Yw6j/yIdy7GGDB677Eaq6Mzs9GrZbA46WXGobYz0TwNF40FsxFAYQe7566xLjxkUAUVCaaRtlPApuBIQEFlyxXPIEjKt/oRAShBOyWLDxZAsE4A42SrlGg6NiELLK3jFfvWRZBN26COYQNrHbh2fzqAIEHZbed9Am8Vs2BrvGWmCwYCQx2PQx0okOO66YJTMk2nwIg73XRgPMrIpjPpDaAwTQdwtcjVAEwDPNvUanQ6Dr3otPe+SgIMOBdE4yJrGscnPAIzctV4Q2ML02BHrhpFaBzDaEezMw21jMtgfaaz4eDiPuCDB9sFB8VB7YB5xkYOWSMa542Xicbp9GDSg00PXVzlXHzDGRufeHjK0idvSLYRYjzoxgQKx1KGk3vzQ0CSiGeGACX1LgCOOfCnrjNgWbwVygbv7DoB3pm3zJkgOQl+2muDkeCWRavhf1lQouyMMT6aZlWJGBytGUlTjaM1A5YBx83Ulv0QB4KEkmGHGiJVEcw7gwE2A8f6xO6MroMAnyfyWMv4GJzVU1oTfYo0JsCwmjd+sncEnOngJDJwPpFipuJD/VAFWoTR+FUFNJ9sMVuDdokEBVBiQ+7XcNY1ulW5KzY+4GNVgzY41Ld0qG+xelpOis8PTaTWcA7OQclMflZQ8vMjE7FVYUjyoLFY4yydH1jspq0mrdQPeV/KovFJOO1tjFW88QmtQ3zIrQXagycPflvIYIVcxSCpMzZYIfgf7o9tBxsV45McnyKojFAywbdFPcbrJa+XZGw6j5nmMQhV0VNqvyUI8gT4E+bDExBmyyAg9HGglTH+MyLGf3Dy6uRzjHe9Mf6zEs553naigyOJtY51cBKx1jnZAIHhFefeLTPY9WXUx3lONZw7eKdswwVL77yzD08iPGXbJ6sWFp8o1lEnuXUjl8zIJRekym0QqmQmbtzxIFTBeDieNQQOysd3JhzGhqlw+MLpwYXPUuDoEWp80uHpQl5Hlko6bJ4dJ9MCP+Qti8dgv2MxyLfGQBrDWwGC8+ehiVuUPAb3ndZhj0bF6F7CQwxA/YbghAnKyriXH7Cq81KLg8KvsyCrkG2CJLvxyaUnycYnHp6yLZI1ng6fSR24ASkbyVomFJ6JPUTnDx5ZDVI67CI6OpLrcAmhM1RltcM22lmqttoVVVOvzbIOE+tzR0dIXUwcWKu1g9Set0YGPYAEJgQNzIVYQUC06EXKIeLxuaEGuH6dtbrhIVmWDQ8hq39lx6dufHLpyfvK8MTHJzE+yfFpROEdj83zIsdov+awSTg6oHJjRgI+JiTAwgUXqIN7ZxAjB/fuD2rhoy3v3llrdBecohLRF0Zj0boL/GNKRYcAcbONa7wrhDXeFcagHFJs56MM1nYyWFKYHtwjTAP3mEbHFQreOWsarmyMYLn30OGdC08ZQ7wB6WqJ2WETcnRY54eW1HKcNy6oYEyNy2HjcrRxOWxczpAlYWein7M2uGsoV/nURZgoWhm1WzLVwM9lCe+vuZbjEwQeMjtwHV0odzbig7yLhwpJDPSEjOk+sMe7VaivhHMt6VJnoMwD54OKgQEUPsJUX+mAB+6dMhAfnDI8+NwEXKk245Mdn7rwlO2gI+vyfsjTC75Y+0qGbPKcFPQwbkWYPCcNXkOHcwDeBGcPNhNoDk9yfHIxU+WG+eKiaTgcq/FJhKeMakfW6d3ox6wzgTa4XvcuqtM8xGYyVBqgmidDpY6bmAaF08rF2YHa8CTHJ8jtJCikkT6alRfKOLty61RcOzFO3+mw0QfhhBX2I4UOx7Hi0Z9ooRKL3chiN7LY2Ui0T0N9AU3BCBSgWw4BCeQg8Z0dn7rwlFNMX4Cx4gaMSfJSjY1VTtW5S20qqK6WEBiJVjsejRCi5WCE/sm4slDFGX2LxoprNKbJmzmmq2SNFd2RvipZlk3Jou/bWHHhxrwjgerc9DKYxdtTHzWF08ioeDIrFfSYu+S7IJL2BgnnJGfJU/gQyz/5uim4FUCXnkTyEL4eGJ7U+DT6FDv6FGtLT8KZdyW2WuIPgx6zjQm4cLEuaYQI9QZwWTYEvim86HwgAWrYcAuC9xrcsfGJh6ecDEfGumHsr7Cyzf2Ndifqd9jlbTenkpow9E1UHbm/UfcqMqms8/K2PVy3E3PlN1n54+Hmvx5uxcEFURQPl/9dNUcJg/lkQxYywthvWEXkocmgq5YRedlmwK/kOGHw/3rqwkOHRD13iYP/31ISHnpBCCMRS6+NuW8HqV7ScVF2+Fxp8Sm8ju8IqWtk0SzCfU9INZfnRbsI900h1RspXvSLcGGo6y9edIxw3xdCbKswNd8YUg/cip4R7jtDCKhFL5ZvDSE6oorzyfeG1KEWbSNcCjqCDmNL2qJ84wiBsBCk7xwhOqOKrhLue0cIsIUkffMI0R1VNJZwSYtSFqL0/SH1dDiM5XNpWcpClqFfo5p9hbF8Li1MVQhTXTnxlfg2T3FFXzeEsXxuuMeq9i7xojuDK/rOIYx9M5cO3PdOUAdXGPyrvk3gviWkHlCry2XKX+6agPtWFCIlUt1fR/2f+86Xel0/jL1757u8P/WHU//4Q+j2fvt2tWp+Wf0Ym7+tTN3lv/x66fJ+88tKdeGVcuFfLcO/kNe++eXXX38FdCIH1TECVFgaVqSPPS7L+LhqJSLKhCn+G1/z9N7EfyOFIs4TcZ6I82ycZ+O8Ls7rEjyWELDxzYg64UhAIWiID5EhcDTHh8QaqdNDmizTZOUnI75Ehuz95+kZPzpx4QgkNPV163yN1pQUI0U67sdEmm18byOhNtLZxfEu/r+L/+/iehfnu8hTl/bHEjPYqCeJGSwxg6XJowSTCCHaj3xKq1Sao9JylSneGn2nljFPZ7xzmFaIK0pexsEENHwInFnHBVoyg1EfKsBGbsdJJnHdYu5S3LxwSE3IOuJtOkLghGAipMdHDIYJAkzSkyiquDz87Gq+Xl0YZCoMSQxwHMk5gtvsth9ycKab0eLIn7gcSUrbmbW2lAGneH/RRVOTxhYp3OUntijLc7dZ3siqCz0SyQJROLrGhWYTflchVySWqXiCNnra4Fpr3me/P+z2h2F9wr5cUWdAN+4mJ+eAVxtqNbJS+O1sdO5Qzk8TrL5oI58wFLMvYkRGQ5peXUuPn7cPaJOC0vKkAVhipxP8OEJh/ZTZvthNB2Tv10fsTg0ZHSTtxnseeRrhIfFaauMaLQk/r5w7GZM5GVtxMjZfPmCfoimVUjJnVVw97J4xbk6s5nHfKoYQbrRRbDpw6ogMQfz95nx32Rljusruunz5sDnh1WTMNfEeKqcDO4H81EzG4hL9hW1gNONswpISulOhwfKiWKtuDAIq26/6jYfwEy4XeFnEFLebIrAUxkLZawIcT0qwN5v364efsMFRdnCnwSVkiDlm7khBDgZAFDoPWcMNLuYBn6ScxI9iiYf0AXi2MlNlIQtGKOooCYCwepB+x+U7/9gXYrp8yn2V8t3zc3GKwzUftdLmK7dPw4fzYV3GiaRPL9VQoTByhHr5MDvPA7LgCqolBPt2Pr8rzItiRN2cdodDf9zvto+FIikyqMrJPwyn/jCgfMSSRzLLFp4P8FkyDkgUebpmSeTj+rTGbpDif+49H/v35w8fii0KCp+MEsuT18e+3/ufOPMxyPF8GHJQLvNpeurKIojh4L+cLhwwZbA2RY1jhpqp4/hbfLkiZ+l0mkwr9OP5UPoOTbEyPyj7Fi9SVEBS1bd++7A7ww8PlrkbpW4I9eGA7cTMRf4O558RTPrbRxl+l7mv6Nc15bXiemx2gnJbdvSCtiSh4D/piHLL6X/uH86nUnKCClbsmAqYCQzsxyQlx2QNqZ6RS+Qp/nxOrg+ZEtpCCpLyZADnfChDXcqTIAr8j2vkrjOTpMaU62RRY1wkp0aSgsM0OYW5JkZ3ZiazmCb2dHlkYRICe0SskZSmjDtlmHgUmj+lX67M8ihUd5oqPgEo/r5b5sKzgDYs6Mba2VT2KPh6wqYtKY1O6jg5VlM4fk+5CtPzvMYRt6QOjKqrezrsnhGPqYN5zFVdSdioH0gbjv73ULGtdGS2gvZ0+SGjPHTKLKaoUnFJHWYRlH+HjJbapTMTOootUAdhsYXtpFRHhuhlqvrSEmiZ4n6ROub4G0MokKBU7HpS9+E99sGU56wq6of0R9UyMjJ/oKeRRFw3fOpx+iBn8bKuQsDH9faxTGTIeP7q0f7x/FxkNJIKEaqsGJ6wZVD7yZxIZpnDh21ZwKAO1RcWEQZ8ZOf1A4ZV+6KganqNcDkniArl5DC7vSCZCIY/WpuRnB3PZFo4hL/YlB0rmTqmc9hWknoVyU6kqOLstjPbrBWC0WbSL2ZPrwuguf9STaXinAuESR2DZwHYqpsH8DgUxaQshDVudvkkbmJZCmPE7Pr4Y9DZ8Zbh19NyUbl+t59cuGTl6Eq9qQSw32BLF1khS1I3Z8P2tMNMpyKpunsoYn5yMfYOheMf8IkpKE9XzRx+Kjw9dfRV6f9p/KXp/NyVeexHOftN/6nfIEumjuta9rwZtqfX/tqu/3k4fX59PvbHAS7xnob+cbP7MDz0P+8P/fFYWhW1veQ/kXf0WI7n4354GHbn4+vtrv95vxkehtN6i5JuMpCbc8cRT/xF4uy0ykw3LMBcAACUTj6v91ikZCpcu0l7Xu/3ZemGigWxe0zrTw/FRaolYxBerCvTULKCUye9UOWbClcT/+O6XI3H66wiWrohpvIYcHBGRvAzgE7radmKEtIMrPPmNOyx63Zkxe0qqGn9iDS2PMjxf5sgc/vZsafTMTuJllWlGjVNeyyxLOA9P7/HRkdWOlN0U1Wc3fv/7h/QFsiylyrShkv0WrQz5JCxxpAlnaui2aEwlIyq0z6psCchKe+/qQ6PWruGRCysx3u1u3Lsx1Ue9l0pupQJm50UU6aqlUtg3x/WJ+zNNOkNZbmwTMYMFb1Xb2OmEU0W0KRgnjgDwtr1BgcGZLmhdpVT3CBwSvOWXdvtcADeUa6hWhfaxb97msk/Lwwl2VY8ctJkPGcasNfj8/36sH7ui0aVjrx6LvqjyiJA6YYKfu/Xh9Ow3vzdeDHg/zMm9ecDDhYd6e9NDvNYXIZRsQC61drHX3LPj5fsMByVdWxao8L7sh8tvxuOBjrNLCbJY+ZGRqdhquI6ffwbtF9LJv0OL0OrVJ44LMgKqSrQRbmmuS0u6YyEnPoDsviOktfEoc31oSAUmEkkDk7hqILuD1DixA6P7JioObzwl5UybckSWKUKYyrb2642z11WUcsDAUUKiDoLxnO1orHllcZYU3K1bW7W23aidJws7YxmgHQdgBz643lTFG4FdbhXs7/9YffQT4ydbERzeOnzcCxaXCjfWL02grav/nAqri/Je68qGw67T8MjJr8jY6QijMlspRY0HfxfNMng5vlAkuuYjVF1bYACP0GPs1Cyb6sWYQKIMjMy1FkeSUorIQnut+X9niNbfUxlMVIwskYhbb70uNt8Km80yYvpmnIE3UZumexlKazc1Wy7YitZVXtVS+eW+b1Dfzpjpw0fhC9IfMLCwglQvphqOZ3pMD3Gv9SU+bQsvYogx/70WiCNgB0GLFNDxsI1/37scaGKFGg1uz8Oz8NmjYNS8nxHjD4O/1OUJikfiZus4+p9/+DLSliZSW9dU+bwtwhzwnNnwijfcTxNWirIwxrt+LT+CQuKvEUrU9IXtBTPBTdUwHtaHz5gjbCkOqG72bj8Y8FTTrnEie2QN7hVGzoV/YGUBFJ/1iQYKHLRyUUz0d1dNgiUXwCYCKfs6/mK32NM4vDKPeb0QudKpr9QUz4Ox7YMzjh5o19NZ08fD7vzB/x1DPmRAMqGcIWfLJCXWUGKnk0ZRY9snaQ3l6wm8x34zCKPFuobq+uFofIDKpF/QZX0ONYaZNyYjHopTaHXdkafIwE23SymkD6dQ6VeprbPyn1jyrHnd/d62iedXZCs5PTMy9ZWOruyvqyVpMovfvG0qp8dGitBXan5tWXinMVOK0FdqcDK48Nh2Bf3QeSNdc1OztuhyCjI8n81WD1vh5/xiUXfeWcn1nn/WBbauCLbB2vxQYBQhFNkG1stmTgfyzCZzIyvqt0nzlrWMswFOl7PmAd/r2p3xiHW3Od4KMT687qo95Bfd3T5IpSCkalFHePH4aHwqhTTEc6h+FKRk7eWyT2QvTS4BaQeieSoD8Ok39HSvUI6X7nDd53ZFTWfNH/JajvCu8bXOTbDtl+9efvu11//FwmRY8xLrAAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAACuU927LbOHL/Ir/kgaFxB+HKy0w2SU0lm93a3B5crin5HB6bGR1JpYt3nKn591TjQqFBtEgd2bPO5mXMIYDuRt/Q3Wjq/LI67P58XL15+8vqp2H7uHojmtV2/dyv3qz+sD8Nu+2qWZ0Pm9Wb1fPu8bzpj6/D6/bj6XmzalYPm/Xx2B9Xb1arX5sEQ16A7DCQT+vDsH6fgdlR0JrVfn3ot6cLIRf4RmtpRhQ//nj6vO8XoXg1zr2GKa7IEHIm1Ijv79cPH29C16YVC5C2kcIvt9mAPcL9W25uoiOSTnDi3/r14eHjPcS0I4hbaZoyCpH2j7vNY3+4i7QRxBcm7Y/r0208iwtepD0I87/sPny4kSnjkvuxf/ew2BUk7OOSv4zlBPSjStymCpF2ghl/6teP99DSRgA3E/T12eRJG/9P3EFk2CTBwf867E730ZkgfIs89LSN/6vuYWLYJumMjsf+Pk0cQXyLfAzEjf/P7mFk3Ch14qyHzZ2cHEF8i5wMxKX/vzGMwIyM+yTPiYfd834zHD/eyc4C0LfI1JzE9PYuj4n2TGnqefM0bO5W1gzKt8jakb70qrtLZcfdUlnBx/X2w50svcD4FhkaqUsv7jqT0k4pDR02t9EaF9wfpP7Dzw+b8+NtyC9rXoT/kiz/++d9/xqlBynphpEfYeRq3i2Ys1xjeCMowJoDgqfrefeFHJLYIqNA5IaxL0JwBLWQ5EgUSXQpY0R1HPwiZCdYC+lOdJGEf39+eqK4Hca+CNkR1EKqI1E1on/YnvrD0/qhf/3HzXpaSRqHf4Th66RrUyd7SDAm4ObJL8hbVO5ZgO/V9XIPxuqXLczXl+CeyddvQI588BLUV33wDYh/2D7tbkIcF9yNGFzd8SbMacXdqP/UH8+b023IL2vuRv+H7U2Y/0CXZK4jvbiGPw77qQOGl3e7AQ9k3vg9AdedFlEAv7BlQSn8NscVAd7iuibF8VudV4lzsfvKFi4qdS7DfrXYeRPy8phfhn8umLuJhHkfOsG/0IsuQF7UW5ehn6m43kTAkuNrQsDiA6xOwMWO/3V3mpjuv+5Od1srwJg3UMB+3bv8vj98mLrAC2f8+GJq/6nf9ofh4TqzA8g4damDCXQSIv5d3+/9hO8Oh/Xn43/86YdbKXhVBbGIqATnxe42QLnF25bMyAVbkeUXOBoWkTejasgNTTUNhr/gIebB3cJUTx4ZDO7Pp1vwvUorlmC9HhSdT7fiHpfcjfy7p9Oc6yxwpxV3o/6+f9odbpLxq3HJ/chxirsIeVryEuQ1c/ndMM2xL9h/N8xk2TcZC0C7xVaAtpebCsK22FLSqnsMBWNebCcV1KIeXSVBfRFnttCFXXdc84Bf/UBHWjVlvVrSvYZl/mrhsuQHMpn4/vMCZH7SV9/S95/bce7chr7/TG0oDxFpXGHWV98SxJWzpfXLGhxg4qxrWIQwTvvqG/MJ+ey14WVRkZnjreV1xCsow7TlW6sdAzh3nh4Eodfnyx0FAd4th8EtzVlLUL6a6cYqMF9PfXED1iL0Mx1XM+hF5qhO/XEiOf/2bnkFKPNSCjTUqauQ9gXoWkRUlaLv9vvNlCj/9m66ApR50gIN1y2yqGhMTTJeMn45m4wAbzHK631f07v3RXhfzd+2lxRct07crLKQhuvtKTcRUG3yWEbGoraOm4gp7+6X0TF3Wz9HwtLjdJ6EuVioSsncHXzRGbaMoJlesN+AJbjhiw546zy53uKFmjaXkXO1TfM3YEfei0mHlXVmLO++XEbL9X7L34AZqKmSDkXr3CjbKM2FGY/DwT8lap7OW78wXkbF4ZvuozLox9P6RIGGsZfC3edpQgF3X7+Jo+FKlJaf+sMl/rq00ECKE0dvqZ5nNG93NVYA3G21tL+gIl+vw89X3zOqnhGIC10ByDMBKqOtLCtnsHFsdoH9w7alAjSqNJzJ6EfiIwQoFRBtRhTUjNZhWyd0mPnAh6Lyn4fN7v3napd3CMPThNtC8Yzi9yhTuBAdwL8nMoalsKuA2/czMkNBegZvTWhCUIP1vDKUIXbGaeqbJp8rU4kuXQlb2HtYQJ/7Ousy/eYPkuqY5r4+yla98GsjAu9MonsNbyY08nMev55sv6PFlsEmP9bxsMk868uoRAZ+kU686FMbAtP1D2vyRS/tuL2GeOy2pT82mpLwos9kKCquB2lfc//4kxd5CwNe9okLRchMEvM1eYCzF3cLD174dQpFyUyy/zWZgL800bcw4a4vSyh6FhUcviZDal+J3OQg7v0qhJTUbFXqq+pJ+YWHvUlVXv5FB0XQXEXoazKj+DrjJvc5rQRlYefvieTGw6HSpCuXpKIbQT/lF7hxdYD7VL/FpcFqfoldHnbb4+lwfjjtDjPQX+GpVxj2hNEJpi7byK56CTRz97zXoGfXBQT0uSvXa9DzK1AC/Oz95zX46C6SQDB/Efl05aIdXQlSGGbvAwOGd81q2D72P6/e/LL61B+OEFW+WYlWtnAUPw395hF+K2MVqz0Pu+dngPEujv1nD4oEM8KU12zVvGWN4i3j7941b9MC/96/8LM4MYujWWLVvOUNty2TeJpA0+SqeSsayVulNZom0TRFQVNoml41b2UjdculQNM0mmZWzVtVm2bQNLtq3upGdK21eJpF07pV89bUoHVomls1b20jVMuVQdMc5i6jtsoLMQC/u0ba1ijMOo4lwUlRcCwLCGLfuipELA1OioNjeXDgO2dVkH6IN7K1zDRcpAfZqLaLjAwwDIkMi4uDWLiqIsMS4x0JEsuMg2y4rgmXY7EJUmwCi02AcLipUSkKC6JNCMtNgHS4rYLEghOk4AQWnPDS6RruWiY7PBPbkvDicRV/ILB4BMhAsEaZlvMCJBaPACEIXkWO5SNACEJUYWL5SEbClFhAEqQgZA2mxAKSgoZZeDnv5lQVJpaQVDRMLCIJchC6ChOLSBoaJpaRtKQ7jiOtNLoRplGtk6oRtuGt7EQjOrBf7TJQpFv0I36lNl0jXCNbJV0jWXrgjWhZ5xoJ+Li2jZSNaHXcZIDuSP30Qx68chxgiNYpHWBI1TVAdnijG94aJRppGtFaGIJVNnc+CnRDdjUm+6GpA5OuUS2XGScUaI1ijdCtVQ7DgCFPhzW8UcABLmyjeGSFAuoZCBmoF9I0CqiXPAcPquY32HKBheaHxm0CCa2zIoAXrAPwvO06F8CzDpQpskLZRraG2QwPKKrqGmFbgw8wPwLCaK0IKsGNbWBqqxvl+WG6RrPIIc3Dmww0aLYWjTCt0QWHsNIrTaqyH7INa63yVLDWSZA6bw13IGwG3hH2HKaormFtpxsNLzruGi3jFK1gimg0rHHaNdqAsmrZaBvXwGYZ7xrtGt4K0xgW/+XxXxH/BfzMusaA3JhsjI4DJv7r2aVNY7r4IkDMtgwmaqt+U2HrVZZmDvawqqPsPI6I1jHXeK3QtlHxX89Vqw2Ye3gjYb9Ku8aC0SrGG+t1SvHGwkmurc6wOiqgUqPNMh6Ae3ME4E554Kq1UgJw0SoDsMMUq0o11Yw6j/yIdy7GGDB677Eaq6Mzs9GrZbA46WXGobYz0TwNF40FsxFAYQe7566xLjxkUAUVCaaRtlPApuBIQEFlyxXPIEjKt/oRAShBOyWLDxZAsE4A42SrlGg6NiELLK3jFfvWRZBN26COYQNrHbh2fzqAIEHZbed9Am8Vs2BrvGWmCwYCQx2PQx0okOO66YJTMk2nwIg73XRgPMrIpjPpDaAwTQdwtcjVAEwDPNvUanQ6Dr3otPe+SgIMOBdE4yJrGscnPAIzctV4Q2ML02BHrhpFaBzDaEezMw21jMtgfaaz4eDiPuCDB9sFB8VB7YB5xkYOWSMa542Xicbp9GDSg00PXVzlXHzDGRufeHjK0idvSLYRYjzoxgQKx1KGk3vzQ0CSiGeGACX1LgCOOfCnrjNgWbwVygbv7DoB3pm3zJkgOQl+2muDkeCWRavhf1lQouyMMT6aZlWJGBytGUlTjaM1A5YBx83Ulv0QB4KEkmGHGiJVEcw7gwE2A8f6xO6MroMAnyfyWMv4GJzVU1oTfYo0JsCwmjd+sncEnOngJDJwPpFipuJD/VAFWoTR+FUFNJ9sMVuDdokEBVBiQ+7XcNY1ulW5KzY+4GNVgzY41Ld0qG+xelpOis8PTaTWcA7OQclMflZQ8vMjE7FVYUjyoLFY4yydH1jspq0mrdQPeV/KovFJOO1tjFW88QmtQ3zIrQXagycPflvIYIVcxSCpMzZYIfgf7o9tBxsV45McnyKojFAywbdFPcbrJa+XZGw6j5nmMQhV0VNqvyUI8gT4E+bDExBmyyAg9HGglTH+MyLGf3Dy6uRzjHe9Mf6zEs553naigyOJtY51cBKx1jnZAIHhFefeLTPY9WXUx3lONZw7eKdswwVL77yzD08iPGXbJ6sWFp8o1lEnuXUjl8zIJRekym0QqmQmbtzxIFTBeDieNQQOysd3JhzGhqlw+MLpwYXPUuDoEWp80uHpQl5Hlko6bJ4dJ9MCP+Qti8dgv2MxyLfGQBrDWwGC8+ehiVuUPAb3ndZhj0bF6F7CQwxA/YbghAnKyriXH7Cq81KLg8KvsyCrkG2CJLvxyaUnycYnHp6yLZI1ng6fSR24ASkbyVomFJ6JPUTnDx5ZDVI67CI6OpLrcAmhM1RltcM22lmqttoVVVOvzbIOE+tzR0dIXUwcWKu1g9Set0YGPYAEJgQNzIVYQUC06EXKIeLxuaEGuH6dtbrhIVmWDQ8hq39lx6dufHLpyfvK8MTHJzE+yfFpROEdj83zIsdov+awSTg6oHJjRgI+JiTAwgUXqIN7ZxAjB/fuD2rhoy3v3llrdBecohLRF0Zj0boL/GNKRYcAcbONa7wrhDXeFcagHFJs56MM1nYyWFKYHtwjTAP3mEbHFQreOWsarmyMYLn30OGdC08ZQ7wB6WqJ2WETcnRY54eW1HKcNy6oYEyNy2HjcrRxOWxczpAlYWein7M2uGsoV/nURZgoWhm1WzLVwM9lCe+vuZbjEwQeMjtwHV0odzbig7yLhwpJDPSEjOk+sMe7VaivhHMt6VJnoMwD54OKgQEUPsJUX+mAB+6dMhAfnDI8+NwEXKk245Mdn7rwlO2gI+vyfsjTC75Y+0qGbPKcFPQwbkWYPCcNXkOHcwDeBGcPNhNoDk9yfHIxU+WG+eKiaTgcq/FJhKeMakfW6d3ox6wzgTa4XvcuqtM8xGYyVBqgmidDpY6bmAaF08rF2YHa8CTHJ8jtJCikkT6alRfKOLty61RcOzFO3+mw0QfhhBX2I4UOx7Hi0Z9ooRKL3chiN7LY2Ui0T0N9AU3BCBSgWw4BCeQg8Z0dn7rwlFNMX4Cx4gaMSfJSjY1VTtW5S20qqK6WEBiJVjsejRCi5WCE/sm4slDFGX2LxoprNKbJmzmmq2SNFd2RvipZlk3Jou/bWHHhxrwjgerc9DKYxdtTHzWF08ioeDIrFfSYu+S7IJL2BgnnJGfJU/gQyz/5uim4FUCXnkTyEL4eGJ7U+DT6FDv6FGtLT8KZdyW2WuIPgx6zjQm4cLEuaYQI9QZwWTYEvim86HwgAWrYcAuC9xrcsfGJh6ecDEfGumHsr7Cyzf2Ndifqd9jlbTenkpow9E1UHbm/UfcqMqms8/K2PVy3E3PlN1n54+Hmvx5uxcEFURQPl/9dNUcJg/lkQxYywthvWEXkocmgq5YRedlmwK/kOGHw/3rqwkOHRD13iYP/31ISHnpBCCMRS6+NuW8HqV7ScVF2+Fxp8Sm8ju8IqWtk0SzCfU9INZfnRbsI900h1RspXvSLcGGo6y9edIxw3xdCbKswNd8YUg/cip4R7jtDCKhFL5ZvDSE6oorzyfeG1KEWbSNcCjqCDmNL2qJ84wiBsBCk7xwhOqOKrhLue0cIsIUkffMI0R1VNJZwSYtSFqL0/SH1dDiM5XNpWcpClqFfo5p9hbF8Li1MVQhTXTnxlfg2T3FFXzeEsXxuuMeq9i7xojuDK/rOIYx9M5cO3PdOUAdXGPyrvk3gviWkHlCry2XKX+6agPtWFCIlUt1fR/2f+86Xel0/jL1757u8P/WHU//4Q+j2fvt2tWp+Wf0Ym7+tTN3lv/x66fJ+88tKdeGVcuFfLcO/kNe++eXXX38FdCIH1TECVFgaVqSPPS7L+LhqJSLKhCn+G1/z9N7EfyOFIs4TcZ6I82ycZ+O8Ls7rEjyWELDxzYg64UhAIWiID5EhcDTHh8QaqdNDmizTZOUnI75Ehuz95+kZPzpx4QgkNPV163yN1pQUI0U67sdEmm18byOhNtLZxfEu/r+L/+/iehfnu8hTl/bHEjPYqCeJGSwxg6XJowSTCCHaj3xKq1Sao9JylSneGn2nljFPZ7xzmFaIK0pexsEENHwInFnHBVoyg1EfKsBGbsdJJnHdYu5S3LxwSE3IOuJtOkLghGAipMdHDIYJAkzSkyiquDz87Gq+Xl0YZCoMSQxwHMk5gtvsth9ycKab0eLIn7gcSUrbmbW2lAGneH/RRVOTxhYp3OUntijLc7dZ3siqCz0SyQJROLrGhWYTflchVySWqXiCNnra4Fpr3me/P+z2h2F9wr5cUWdAN+4mJ+eAVxtqNbJS+O1sdO5Qzk8TrL5oI58wFLMvYkRGQ5peXUuPn7cPaJOC0vKkAVhipxP8OEJh/ZTZvthNB2Tv10fsTg0ZHSTtxnseeRrhIfFaauMaLQk/r5w7GZM5GVtxMjZfPmCfoimVUjJnVVw97J4xbk6s5nHfKoYQbrRRbDpw6ogMQfz95nx32Rljusruunz5sDnh1WTMNfEeKqcDO4H81EzG4hL9hW1gNONswpISulOhwfKiWKtuDAIq26/6jYfwEy4XeFnEFLebIrAUxkLZawIcT0qwN5v364efsMFRdnCnwSVkiDlm7khBDgZAFDoPWcMNLuYBn6ScxI9iiYf0AXi2MlNlIQtGKOooCYCwepB+x+U7/9gXYrp8yn2V8t3zc3GKwzUftdLmK7dPw4fzYV3GiaRPL9VQoTByhHr5MDvPA7LgCqolBPt2Pr8rzItiRN2cdodDf9zvto+FIikyqMrJPwyn/jCgfMSSRzLLFp4P8FkyDkgUebpmSeTj+rTGbpDif+49H/v35w8fii0KCp+MEsuT18e+3/ufOPMxyPF8GHJQLvNpeurKIojh4L+cLhwwZbA2RY1jhpqp4/hbfLkiZ+l0mkwr9OP5UPoOTbEyPyj7Fi9SVEBS1bd++7A7ww8PlrkbpW4I9eGA7cTMRf4O558RTPrbRxl+l7mv6Nc15bXiemx2gnJbdvSCtiSh4D/piHLL6X/uH86nUnKCClbsmAqYCQzsxyQlx2QNqZ6RS+Qp/nxOrg+ZEtpCCpLyZADnfChDXcqTIAr8j2vkrjOTpMaU62RRY1wkp0aSgsM0OYW5JkZ3ZiazmCb2dHlkYRICe0SskZSmjDtlmHgUmj+lX67M8ihUd5oqPgEo/r5b5sKzgDYs6Mba2VT2KPh6wqYtKY1O6jg5VlM4fk+5CtPzvMYRt6QOjKqrezrsnhGPqYN5zFVdSdioH0gbjv73ULGtdGS2gvZ0+SGjPHTKLKaoUnFJHWYRlH+HjJbapTMTOootUAdhsYXtpFRHhuhlqvrSEmiZ4n6ROub4G0MokKBU7HpS9+E99sGU56wq6of0R9UyMjJ/oKeRRFw3fOpx+iBn8bKuQsDH9faxTGTIeP7q0f7x/FxkNJIKEaqsGJ6wZVD7yZxIZpnDh21ZwKAO1RcWEQZ8ZOf1A4ZV+6KganqNcDkniArl5DC7vSCZCIY/WpuRnB3PZFo4hL/YlB0rmTqmc9hWknoVyU6kqOLstjPbrBWC0WbSL2ZPrwuguf9STaXinAuESR2DZwHYqpsH8DgUxaQshDVudvkkbmJZCmPE7Pr4Y9DZ8Zbh19NyUbl+t59cuGTl6Eq9qQSw32BLF1khS1I3Z8P2tMNMpyKpunsoYn5yMfYOheMf8IkpKE9XzRx+Kjw9dfRV6f9p/KXp/NyVeexHOftN/6nfIEumjuta9rwZtqfX/tqu/3k4fX59PvbHAS7xnob+cbP7MDz0P+8P/fFYWhW1veQ/kXf0WI7n4354GHbn4+vtrv95vxkehtN6i5JuMpCbc8cRT/xF4uy0ykw3LMBcAACUTj6v91ikZCpcu0l7Xu/3ZemGigWxe0zrTw/FRaolYxBerCvTULKCUye9UOWbClcT/+O6XI3H66wiWrohpvIYcHBGRvAzgE7radmKEtIMrPPmNOyx63Zkxe0qqGn9iDS2PMjxf5sgc/vZsafTMTuJllWlGjVNeyyxLOA9P7/HRkdWOlN0U1Wc3fv/7h/QFsiylyrShkv0WrQz5JCxxpAlnaui2aEwlIyq0z6psCchKe+/qQ6PWruGRCysx3u1u3Lsx1Ue9l0pupQJm50UU6aqlUtg3x/WJ+zNNOkNZbmwTMYMFb1Xb2OmEU0W0KRgnjgDwtr1BgcGZLmhdpVT3CBwSvOWXdvtcADeUa6hWhfaxb97msk/Lwwl2VY8ctJkPGcasNfj8/36sH7ui0aVjrx6LvqjyiJA6YYKfu/Xh9Ow3vzdeDHg/zMm9ecDDhYd6e9NDvNYXIZRsQC61drHX3LPj5fsMByVdWxao8L7sh8tvxuOBjrNLCbJY+ZGRqdhquI6ffwbtF9LJv0OL0OrVJ44LMgKqSrQRbmmuS0u6YyEnPoDsviOktfEoc31oSAUmEkkDk7hqILuD1DixA6P7JioObzwl5UybckSWKUKYyrb2642z11WUcsDAUUKiDoLxnO1orHllcZYU3K1bW7W23aidJws7YxmgHQdgBz643lTFG4FdbhXs7/9YffQT4ydbERzeOnzcCxaXCjfWL02grav/nAqri/Je68qGw67T8MjJr8jY6QijMlspRY0HfxfNMng5vlAkuuYjVF1bYACP0GPs1Cyb6sWYQKIMjMy1FkeSUorIQnut+X9niNbfUxlMVIwskYhbb70uNt8Km80yYvpmnIE3UZumexlKazc1Wy7YitZVXtVS+eW+b1Dfzpjpw0fhC9IfMLCwglQvphqOZ3pMD3Gv9SU+bQsvYogx/70WiCNgB0GLFNDxsI1/37scaGKFGg1uz8Oz8NmjYNS8nxHjD4O/1OUJikfiZus4+p9/+DLSliZSW9dU+bwtwhzwnNnwijfcTxNWirIwxrt+LT+CQuKvEUrU9IXtBTPBTdUwHtaHz5gjbCkOqG72bj8Y8FTTrnEie2QN7hVGzoV/YGUBFJ/1iQYKHLRyUUz0d1dNgiUXwCYCKfs6/mK32NM4vDKPeb0QudKpr9QUz4Ox7YMzjh5o19NZ08fD7vzB/x1DPmRAMqGcIWfLJCXWUGKnk0ZRY9snaQ3l6wm8x34zCKPFuobq+uFofIDKpF/QZX0ONYaZNyYjHopTaHXdkafIwE23SymkD6dQ6VeprbPyn1jyrHnd/d62iedXZCs5PTMy9ZWOruyvqyVpMovfvG0qp8dGitBXan5tWXinMVOK0FdqcDK48Nh2Bf3QeSNdc1OztuhyCjI8n81WD1vh5/xiUXfeWcn1nn/WBbauCLbB2vxQYBQhFNkG1stmTgfyzCZzIyvqt0nzlrWMswFOl7PmAd/r2p3xiHW3Od4KMT687qo95Bfd3T5IpSCkalFHePH4aHwqhTTEc6h+FKRk7eWyT2QvTS4BaQeieSoD8Ok39HSvUI6X7nDd53ZFTWfNH/JajvCu8bXOTbDtl+9efvu11//FwmRY8xLrAAA"; diff --git a/Documentation/assets/style.css b/Documentation/assets/style.css index 072daed8..49330169 100644 --- a/Documentation/assets/style.css +++ b/Documentation/assets/style.css @@ -1,260 +1,260 @@ :root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-icon-background: var(--light-color-background); - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - --light-color-link: #1f70c2; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: var(--light-color-ts-class); - --light-color-ts-property: var(--light-color-ts-variable); - --light-color-ts-method: var(--light-color-ts-function); - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: var(--light-color-ts-property); - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - --dark-color-link: #00aff4; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: var(--dark-color-ts-class); - --dark-color-ts-property: var(--dark-color-ts-variable); - --dark-color-ts-method: var(--dark-color-ts-function); - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: var(--dark-color-ts-property); - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-icon-background: var(--light-color-background); + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + --light-color-link: #1f70c2; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: var(--light-color-ts-variable); + --light-color-ts-method: var(--light-color-ts-function); + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var(--light-color-ts-constructor); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: var(--light-color-ts-property); + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + --dark-color-link: #00aff4; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: var(--dark-color-ts-variable); + --dark-color-ts-method: var(--dark-color-ts-function); + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: var(--dark-color-ts-property); + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; } @media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); - } + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } } @media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); - } + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } } html { - color-scheme: var(--color-scheme); + color-scheme: var(--color-scheme); } body { - margin: 0; + margin: 0; } :root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + --color-link: var(--light-color-link); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); } :root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + --color-link: var(--dark-color-link); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); } .always-visible, .always-visible .tsd-signatures { - display: inherit !important; + display: inherit !important; } h1, @@ -263,7 +263,7 @@ h3, h4, h5, h6 { - line-height: 1.2; + line-height: 1.2; } h1 > a:not(.link), @@ -272,1144 +272,1144 @@ h3 > a:not(.link), h4 > a:not(.link), h5 > a:not(.link), h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); + text-decoration: none; + color: var(--color-text); } h1 { - font-size: 1.875rem; - margin: 0.67rem 0; + font-size: 1.875rem; + margin: 0.67rem 0; } h2 { - font-size: 1.5rem; - margin: 0.83rem 0; + font-size: 1.5rem; + margin: 0.83rem 0; } h3 { - font-size: 1.25rem; - margin: 1rem 0; + font-size: 1.25rem; + margin: 1rem 0; } h4 { - font-size: 1.05rem; - margin: 1.33rem 0; + font-size: 1.05rem; + margin: 1.33rem 0; } h5 { - font-size: 1rem; - margin: 1.5rem 0; + font-size: 1rem; + margin: 1.5rem 0; } h6 { - font-size: 0.875rem; - margin: 2.33rem 0; + font-size: 0.875rem; + margin: 2.33rem 0; } .uppercase { - text-transform: uppercase; + text-transform: uppercase; } dl, menu, ol, ul { - margin: 1em 0; + margin: 1em 0; } dd { - margin: 0 0 0 40px; + margin: 0 0 0 40px; } .container { - max-width: 1700px; - padding: 0 2rem; + max-width: 1700px; + padding: 0 2rem; } /* Footer */ .tsd-generator { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; } .tsd-generator > p { - margin-top: 0; - margin-bottom: 0; - padding: 0 1rem; + margin-top: 0; + margin-bottom: 0; + padding: 0 1rem; } .container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); } @keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } + from { + opacity: 0; + } + to { + opacity: 1; + } } @keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } } @keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } } @keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } } @keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } } @keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } } body { - background: var(--color-background); - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; - font-size: 16px; - color: var(--color-text); + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); } a { - color: var(--color-link); - text-decoration: none; + color: var(--color-link); + text-decoration: none; } a:hover { - text-decoration: underline; + text-decoration: underline; } a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; } code, pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; } pre { - position: relative; - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); + position: relative; + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); } pre code { - padding: 0; - font-size: 100%; + padding: 0; + font-size: 100%; } pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; } pre:hover > button, pre > button.visible { - opacity: 1; + opacity: 1; } blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; } .tsd-typography { - line-height: 1.333em; + line-height: 1.333em; } .tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; + list-style: square; + padding: 0 0 0 20px; + margin: 0; } .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h4, .tsd-typography h5, .tsd-typography h6 { - font-size: 1em; + font-size: 1em; } .tsd-typography h5, .tsd-typography h6 { - font-weight: normal; + font-weight: normal; } .tsd-typography p, .tsd-typography ul, .tsd-typography ol { - margin: 1em 0; + margin: 1em 0; } .tsd-typography table { - border-collapse: collapse; - border: none; + border-collapse: collapse; + border: none; } .tsd-typography td, .tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); + padding: 6px 13px; + border: 1px solid var(--color-accent); } .tsd-typography thead, .tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); + background-color: var(--color-background-secondary); } .tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); + margin: 0; + padding: 0; + color: var(--color-text-aside); } .tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; + color: var(--color-text-aside); + text-decoration: none; } .tsd-breadcrumb a:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-breadcrumb li { - display: inline; + display: inline; } .tsd-breadcrumb li:after { - content: " / "; + content: " / "; } .tsd-comment-tags { - display: flex; - flex-direction: column; + display: flex; + flex-direction: column; } dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; } dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; } dl.tsd-comment-tag-group dd { - margin: 0; + margin: 0; } code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; } h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; + margin-left: 0.25em; } dl.tsd-comment-tag-group dd:before, dl.tsd-comment-tag-group dd:after { - content: " "; + content: " "; } dl.tsd-comment-tag-group dd pre, dl.tsd-comment-tag-group dd:after { - clear: both; + clear: both; } dl.tsd-comment-tag-group p { - margin: 0; + margin: 0; } .tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; } .tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; + margin-bottom: 0; } .tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; } .tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; + margin-bottom: 0.5rem; } .tsd-filter-input { - display: flex; - width: fit-content; - width: -moz-fit-content; - align-items: center; - user-select: none; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - cursor: pointer; + display: flex; + width: fit-content; + width: -moz-fit-content; + align-items: center; + user-select: none; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + cursor: pointer; } .tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; } .tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; + pointer-events: none; } .tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. Don't remove unless you know what you're doing. */ - opacity: 0.99; + opacity: 0.99; } .tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); + transform: scale(0.95); } .tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); + transform: scale(1); } .tsd-checkbox-background { - fill: var(--color-accent); + fill: var(--color-accent); } input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); + stroke: var(--color-text); } .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; } .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); + stroke: var(--color-accent); } .tsd-theme-toggle { - padding-top: 0.75rem; + padding-top: 0.75rem; } .tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; + display: inline; + vertical-align: middle; + margin-right: 0.75rem; } .tsd-hierarchy { - list-style: square; - margin: 0; + list-style: square; + margin: 0; } .tsd-hierarchy .target { - font-weight: bold; + font-weight: bold; } .tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); } .tsd-full-hierarchy, .tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; + list-style: none; + margin: 0; + padding: 0; } .tsd-full-hierarchy ul { - padding-left: 1.5rem; + padding-left: 1.5rem; } .tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); } .tsd-panel-group.tsd-index-group { - margin-bottom: 0; + margin-bottom: 0; } .tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; } @media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); - } + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } } @media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); - } + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } } .tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; } .tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; } .tsd-anchor { - position: relative; - top: -100px; + position: relative; + top: -100px; } .tsd-member { - position: relative; + position: relative; } .tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; } .tsd-navigation.settings { - margin: 1rem 0; + margin: 1rem 0; } .tsd-navigation > a, .tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; + width: calc(100% - 0.25rem); + display: flex; + align-items: center; } .tsd-navigation a, .tsd-navigation summary > span, .tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; } .tsd-navigation a.current, .tsd-page-navigation a.current { - background: var(--color-active-menu-item); + background: var(--color-active-menu-item); } .tsd-navigation a:hover, .tsd-page-navigation a:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-navigation ul, .tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; } .tsd-navigation li, .tsd-page-navigation li { - padding: 0; - max-width: 100%; + padding: 0; + max-width: 100%; } .tsd-nested-navigation { - margin-left: 3rem; + margin-left: 3rem; } .tsd-nested-navigation > li > details { - margin-left: -1.5rem; + margin-left: -1.5rem; } .tsd-small-nested-navigation { - margin-left: 1.5rem; + margin-left: 1.5rem; } .tsd-small-nested-navigation > li > details { - margin-left: -1.5rem; + margin-left: -1.5rem; } .tsd-page-navigation ul { - padding-left: 1.75rem; + padding-left: 1.75rem; } #tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; } #tsd-sidebar-links a:last-of-type { - margin-bottom: 0; + margin-bottom: 0; } a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); } .tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ } .tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ + display: none; /* hide marker on safari */ } .tsd-accordion-summary, .tsd-accordion-summary a { - user-select: none; - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; + user-select: none; + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; - cursor: pointer; + cursor: pointer; } .tsd-accordion-summary a { - width: calc(100% - 1.5rem); + width: calc(100% - 1.5rem); } .tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; } .tsd-index-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; + margin-left: 0.25rem; } .tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; + margin-top: 0.75rem; } .tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; + margin-top: 1.5rem; + margin-bottom: 0.75rem; } .tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; } .tsd-kind-icon path { - transform-origin: center; - transform: scale(1.1); + transform-origin: center; + transform: scale(1.1); } .tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; + margin-right: 0.8rem; } .tsd-panel { - margin-bottom: 2.5rem; + margin-bottom: 2.5rem; } .tsd-panel.tsd-member { - margin-bottom: 4rem; + margin-bottom: 4rem; } .tsd-panel:empty { - display: none; + display: none; } .tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; } .tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; + margin-bottom: 0; + border-bottom: none; } .tsd-panel-group { - margin: 4rem 0; + margin: 4rem 0; } .tsd-panel-group.tsd-index-group { - margin: 2rem 0; + margin: 2rem 0; } .tsd-panel-group.tsd-index-group details { - margin: 2rem 0; + margin: 2rem 0; } #tsd-search { - transition: background-color 0.2s; + transition: background-color 0.2s; } #tsd-search .title { - position: relative; - z-index: 2; + position: relative; + z-index: 2; } #tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; } #tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); } #tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; + position: absolute; + overflow: hidden; + right: -40px; } #tsd-search .field input, #tsd-search .title, #tsd-toolbar-links a { - transition: opacity 0.2s; + transition: opacity 0.2s; } #tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); } #tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; + background-color: var(--color-background); + line-height: initial; + padding: 4px; } #tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); + background-color: var(--color-background-secondary); } #tsd-search .results li.state { - display: none; + display: none; } #tsd-search .results li.current:not(.no-results), #tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); + background-color: var(--color-accent); } #tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; } #tsd-search .results a:before { - top: 10px; + top: 10px; } #tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; + color: var(--color-text-aside); + font-weight: normal; } #tsd-search.has-focus { - background-color: var(--color-accent); + background-color: var(--color-accent); } #tsd-search.has-focus .field input { - top: 0; - opacity: 1; + top: 0; + opacity: 1; } #tsd-search.has-focus .title, #tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; + z-index: 0; + opacity: 0; } #tsd-search.has-focus .results { - visibility: visible; + visibility: visible; } #tsd-search.loading .results li.state.loading { - display: block; + display: block; } #tsd-search.failure .results li.state.failure { - display: block; + display: block; } #tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; } #tsd-toolbar-links a { - margin-left: 1.5rem; + margin-left: 1.5rem; } #tsd-toolbar-links a:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; } .tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; + color: var(--color-ts-keyword); + font-weight: normal; } .tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; + color: var(--color-text-aside); + font-weight: normal; } .tsd-signature-type { - font-style: italic; - font-weight: normal; + font-style: italic; + font-weight: normal; } .tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; } .tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; } .tsd-description .tsd-signatures .tsd-signature { - border-width: 1px; + border-width: 1px; } ul.tsd-parameter-list, ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; + list-style: square; + margin: 0; + padding-left: 20px; } ul.tsd-parameter-list > li.tsd-parameter-signature, ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; + list-style: none; + margin-left: -20px; } ul.tsd-parameter-list h5, ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; + font-size: 16px; + margin: 1em 0 0.5em 0; } .tsd-sources { - margin-top: 1rem; - font-size: 0.875em; + margin-top: 1rem; + font-size: 0.875em; } .tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; + color: var(--color-text-aside); + text-decoration: underline; } .tsd-sources ul { - list-style: none; - padding: 0; + list-style: none; + padding: 0; } .tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; } .tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; + color: var(--color-text); + text-decoration: none; } .tsd-page-toolbar a.title { - font-weight: bold; + font-weight: bold; } .tsd-page-toolbar a.title:hover { - text-decoration: underline; + text-decoration: underline; } .tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; } .tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; + position: relative; + white-space: nowrap; + line-height: 40px; } .tsd-page-toolbar .table-cell:first-child { - width: 100%; + width: 100%; } .tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; + box-sizing: border-box; + line-height: 0; + padding: 12px 0; } .tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; } .tsd-widget:hover { - opacity: 0.9; + opacity: 0.9; } .tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); + opacity: 1; + background-color: var(--color-accent); } .tsd-widget.no-caption { - width: 40px; + width: 40px; } .tsd-widget.no-caption:before { - margin: 0; + margin: 0; } .tsd-widget.options, .tsd-widget.menu { - display: none; + display: none; } input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; + background-position: -120px 0; } input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; + background-position: -160px 0; } img { - max-width: 100%; + max-width: 100%; } .tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + vertical-align: middle; + color: var(--color-text); } .tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; + width: 1em; + height: 1em; + visibility: hidden; } .tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; + visibility: visible; } .deprecated { - text-decoration: line-through !important; + text-decoration: line-through !important; } .warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); } .tsd-kind-project { - color: var(--color-ts-project); + color: var(--color-ts-project); } .tsd-kind-module { - color: var(--color-ts-module); + color: var(--color-ts-module); } .tsd-kind-namespace { - color: var(--color-ts-namespace); + color: var(--color-ts-namespace); } .tsd-kind-enum { - color: var(--color-ts-enum); + color: var(--color-ts-enum); } .tsd-kind-enum-member { - color: var(--color-ts-enum-member); + color: var(--color-ts-enum-member); } .tsd-kind-variable { - color: var(--color-ts-variable); + color: var(--color-ts-variable); } .tsd-kind-function { - color: var(--color-ts-function); + color: var(--color-ts-function); } .tsd-kind-class { - color: var(--color-ts-class); + color: var(--color-ts-class); } .tsd-kind-interface { - color: var(--color-ts-interface); + color: var(--color-ts-interface); } .tsd-kind-constructor { - color: var(--color-ts-constructor); + color: var(--color-ts-constructor); } .tsd-kind-property { - color: var(--color-ts-property); + color: var(--color-ts-property); } .tsd-kind-method { - color: var(--color-ts-method); + color: var(--color-ts-method); } .tsd-kind-call-signature { - color: var(--color-ts-call-signature); + color: var(--color-ts-call-signature); } .tsd-kind-index-signature { - color: var(--color-ts-index-signature); + color: var(--color-ts-index-signature); } .tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); + color: var(--color-ts-constructor-signature); } .tsd-kind-parameter { - color: var(--color-ts-parameter); + color: var(--color-ts-parameter); } .tsd-kind-type-literal { - color: var(--color-ts-type-literal); + color: var(--color-ts-type-literal); } .tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); + color: var(--color-ts-type-parameter); } .tsd-kind-accessor { - color: var(--color-ts-accessor); + color: var(--color-ts-accessor); } .tsd-kind-get-signature { - color: var(--color-ts-get-signature); + color: var(--color-ts-get-signature); } .tsd-kind-set-signature { - color: var(--color-ts-set-signature); + color: var(--color-ts-set-signature); } .tsd-kind-type-alias { - color: var(--color-ts-type-alias); + color: var(--color-ts-type-alias); } /* if we have a kind icon, don't color the text by kind */ .tsd-kind-icon ~ span { - color: var(--color-text); + color: var(--color-text); } * { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); } *::-webkit-scrollbar { - width: 0.75rem; + width: 0.75rem; } *::-webkit-scrollbar-track { - background: var(--color-icon-background); + background: var(--color-icon-background); } *::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); } /* mobile */ @media (max-width: 769px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } - - .container-main { - display: flex; - } - html .col-content { - float: none; - max-width: 100%; - width: 100%; - } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); - } - html .col-sidebar > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; - } - .has-menu .tsd-navigation { - max-height: 100%; - } + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } } /* one sidebar */ @media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; - } - - .col-sidebar { - grid-area: sidebar; - } - .col-content { - grid-area: content; - padding: 0 1rem; - } + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } } @media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; - } - .site-menu { - margin-top: 1rem; - } + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } } /* two sidebars */ @media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; - } - - .col-sidebar { - display: contents; - } - - .page-menu { - grid-area: toc; - padding-left: 1rem; - } - .site-menu { - grid-area: sidebar; - } - - .site-menu { - margin-top: 1rem 0; - } - - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - } + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem 0; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } } diff --git a/Documentation/classes/File.file.html b/Documentation/classes/File.file.html index 8ce02e8f..c37f0e39 100644 --- a/Documentation/classes/File.file.html +++ b/Documentation/classes/File.file.html @@ -1,7 +1,1137 @@ -file | @playform/pipe - v0.0.2

Class file

Implements

Constructors

constructor -

Properties

Plan -

Methods

By -In -Not -Pipe -

Constructors

constructor

Properties

Plan

Plan: Type = ...

Methods

By

In

Not

Pipe

Settings

Member Visibility

Theme

On This Page

constructorPlanByInNotPipe

Generated using TypeDoc

\ No newline at end of file + + + + + + + file | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Class file

+
+
+

Implements

+ +
+ +
+
+
+ + + +
+
+

+ Constructors +

+
+ + constructor +
+
+
+

+ Properties +

+
+ + Plan +
+
+
+

Methods

+
+ + By + + In + + Not + + Pipe +
+
+
+
+
+
+
+

Constructors

+
+ +

+ constructor + +

+ +
+
+
+

Properties

+
+ +

+ Plan + +

+
+ Plan: + Type = ... +
+ +
+
+
+

Methods

+
+ +

+ By + +

+ +
+
+ +

+ In + +

+ +
+
+ +

+ Not + +

+ +
+
+ +

+ Pipe + +

+ +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ + constructor + Plan + By + In + Not + Pipe +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/Apply.apply.html b/Documentation/functions/Apply.apply.html index 443b38a3..2b52836b 100644 --- a/Documentation/functions/Apply.apply.html +++ b/Documentation/functions/Apply.apply.html @@ -1,2 +1,425 @@ -apply | @playform/pipe - v0.0.2

Function apply

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + apply | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function apply

+
+
+
    +
  • + apply(_Function, + Test): Promise<any> + +
    • +
  • +
    +

    + biome-ignore lint/suspicious/noExplicitAny: +

    +
    +
    +

    Parameters

    +
      +
    • + _Function: + ((Test) + => any) +
        +
      • +
          +
        • + (Test): any +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + Test: + any +
            • +
          +
          +

          + Returns + any +

          +
          • +
        +
        • +
      +
      • +
    • + Test: + any +
      • +
    +
    +

    + Returns + Promise<any> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/By.by.html b/Documentation/functions/By.by.html index 7c0ddeb1..1af57558 100644 --- a/Documentation/functions/By.by.html +++ b/Documentation/functions/By.by.html @@ -1,13 +1,459 @@ -by | @playform/pipe - v0.0.2

Function by

  • by(File, Paths, Results): Promise<Map<string, string>>

  • The function By takes in a file pattern or an array of file patterns, a set -of input and output paths, and a map of results, and returns the updated map -of results after matching the file patterns with the input paths.

    -

    Parameters

    • File: string | string[]

      File is either a single file pattern or an array of file -patterns. These patterns are used to match files in the input directory -(Input) that will be processed.

      -
    • Paths: Map<string, string>

      Paths is an array of tuples that represent the input and -output paths. -Each tuple contains two elements: the input path and the output path.

      -
    • Results: Map<string, string>

      Map object that stores the mapping between the output file -paths and their corresponding input file paths. It is used to keep track of -the files that have been processed and their respective destinations.

      -

    Returns Promise<Map<string, string>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + by | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function by

+
+
+
    +
  • + by(File, + Paths, + Results): Promise<Map<string, string>> + +
    • +
  • +
    +

    + The function By takes in a file + pattern or an array of file patterns, a set + of input and output paths, and a map of + results, and returns the updated map of + results after matching the file patterns + with the input paths. +

    +
    +
    +

    Parameters

    +
      +
    • + File: + string + | string[] +
      +

      + File is either a single file + pattern or an array of file + patterns. These patterns are + used to match files in the input + directory (Input) + that will be processed. +

      +
      +
      +
      • +
    • + Paths: + Map<string, string> +
      +

      + Paths is an array of tuples that + represent the input and output + paths. Each tuple contains two + elements: the input path and the + output path. +

      +
      +
      +
      • +
    • + Results: + Map<string, string> +
      +

      + Map object that stores the + mapping between the output file + paths and their corresponding + input file paths. It is used to + keep track of the files that + have been processed and their + respective destinations. +

      +
      +
      +
      • +
    +
    +

    + Returns + Promise<Map<string, string>> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/Bytes.bytes.html b/Documentation/functions/Bytes.bytes.html index a305b21c..19f41970 100644 --- a/Documentation/functions/Bytes.bytes.html +++ b/Documentation/functions/Bytes.bytes.html @@ -1,7 +1,373 @@ -bytes | @playform/pipe - v0.0.2

Function bytes

  • bytes(Bytes, Decimals?): string

  • The function converts a given number of bytes into a human-readable format with appropriate units -(e.g., KB, MB, GB).

    -

    Parameters

    • Bytes: number

      The Bytes parameter is the number of bytes that you want to convert to a -human-readable format.

      -
    • Optional Decimals: number

      The Decimals parameter is an optional parameter that specifies the number -of decimal places to round the result to. If not provided, it defaults to 2.

      -

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + bytes | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function bytes

+
+
+
    +
  • + bytes(Bytes, + Decimals?): string + +
    • +
  • +
    +

    + The function converts a given number of + bytes into a human-readable format with + appropriate units (e.g., KB, MB, GB). +

    +
    +
    +

    Parameters

    +
      +
    • + Bytes: + number +
      +

      + The Bytes parameter + is the number of bytes that you + want to convert to a + human-readable format. +

      +
      +
      +
      • +
    • + Optional + Decimals: + number +
      +

      + The + Decimals parameter + is an optional parameter that + specifies the number of decimal + places to round the result to. + If not provided, it defaults to + 2. +

      +
      +
      +
      • +
    +
    +

    + Returns + string +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/File.Merge.html b/Documentation/functions/File.Merge.html index f617de73..e5a388b3 100644 --- a/Documentation/functions/File.Merge.html +++ b/Documentation/functions/File.Merge.html @@ -1,2 +1,557 @@ -Merge | @playform/pipe - v0.0.2

Function Merge

  • Merge<Ts>(...Objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

  • Merges multiple objects of type Ts using the provided merge functions and built-in metadata.

    -

    Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...Objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Merge | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function Merge

+
+
+
    +
  • + Merge<Ts>(...Objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>> + +
    • +
  • +
    +

    + Merges multiple objects of type Ts using the + provided merge functions and built-in + metadata. +

    +
    +
    +

    Type Parameters

    +
      +
    • + Ts + extends readonly unknown[] +
      • +
    +
    +
    +

    Parameters

    +
      +
    • + Rest + ...Objects: + Ts +
      • +
    +
    +

    + Returns + DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/In.Apply.html b/Documentation/functions/In.Apply.html index 5408382f..c3612d24 100644 --- a/Documentation/functions/In.Apply.html +++ b/Documentation/functions/In.Apply.html @@ -1,2 +1,425 @@ -Apply | @playform/pipe - v0.0.2

Function Apply

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Apply | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function Apply

+
+
+
    +
  • + Apply(_Function, + Test): Promise<any> + +
    • +
  • +
    +

    + biome-ignore lint/suspicious/noExplicitAny: +

    +
    +
    +

    Parameters

    +
      +
    • + _Function: + ((Test) + => any) +
        +
      • +
          +
        • + (Test): any +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + Test: + any +
            • +
          +
          +

          + Returns + any +

          +
          • +
        +
        • +
      +
      • +
    • + Test: + any +
      • +
    +
    +

    + Returns + Promise<any> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/In.in.html b/Documentation/functions/In.in.html index 3466c009..ee135e43 100644 --- a/Documentation/functions/In.in.html +++ b/Documentation/functions/In.in.html @@ -1,6 +1,414 @@ -in | @playform/pipe - v0.0.2

Function in

  • in(Path, Paths): Promise<Map<string, string>>

  • The function In takes a Path and a Paths object, and adds the Path to the Paths object.

    -

    Parameters

    • Path: Type

      The Path parameter is a string or URL that represents the path to a file or -directory.

      -
    • Paths: Map<string, string>

      Paths is a variable of type Plan["Paths"]. It is likely an object or a map that -stores key-value pairs.

      -

    Returns Promise<Map<string, string>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + in | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function in

+
+
+
    +
  • + in(Path, + Paths): Promise<Map<string, string>> + +
    • +
  • +
    +

    + The function In takes a + Path and a + Paths object, and adds the + Path to the + Paths object. +

    +
    +
    +

    Parameters

    +
      +
    • + Path: + Type +
      +

      + The Path parameter + is a string or URL that + represents the path to a file or + directory. +

      +
      +
      +
      • +
    • + Paths: + Map<string, string> +
      +

      + Paths is a variable of type + Plan["Paths"]. It is + likely an object or a map that + stores key-value pairs. +

      +
      +
      +
      • +
    +
    +

    + Returns + Promise<Map<string, string>> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/Merge.merge.html b/Documentation/functions/Merge.merge.html index 5d12471f..f85bf91e 100644 --- a/Documentation/functions/Merge.merge.html +++ b/Documentation/functions/Merge.merge.html @@ -1,2 +1,557 @@ -merge | @playform/pipe - v0.0.2

Function merge

  • merge<Ts>(...Objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

  • Merges multiple objects of type Ts using the provided merge functions and built-in metadata.

    -

    Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...Objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + merge | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function merge

+
+
+
    +
  • + merge<Ts>(...Objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>> + +
    • +
  • +
    +

    + Merges multiple objects of type Ts using the + provided merge functions and built-in + metadata. +

    +
    +
    +

    Type Parameters

    +
      +
    • + Ts + extends readonly unknown[] +
      • +
    +
    +
    +

    Parameters

    +
      +
    • + Rest + ...Objects: + Ts +
      • +
    +
    +

    + Returns + DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: "DeepMergeLeafURI";
        DeepMergeMapsURI: "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: "DeepMergeLeafURI";
        DeepMergeRecordsURI: "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/Not.not.html b/Documentation/functions/Not.not.html index 0724ba1b..dc07803d 100644 --- a/Documentation/functions/Not.not.html +++ b/Documentation/functions/Not.not.html @@ -1,8 +1,441 @@ -not | @playform/pipe - v0.0.2

Function not

  • not(Pattern, Results): Map<string, string>

  • The function Not filters out files from the File array based on the provided Pattern -parameter.

    -

    Parameters

    • Pattern: undefined | boolean | Type | Set<Type> | Type[]

      The Pattern parameter is of type Option["Exclude"]. It represents the patterns -or filters that will be used to exclude certain files from the Results array.

      -
    • Results: Map<string, string>

      The Results parameter is expected to be an array of results from a plan. Each element -in the array should be an array itself, with two elements. The first element represents the file -name, and the second element represents the file content.

      -

    Returns Map<string, string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + not | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function not

+
+
+
    +
  • + not(Pattern, + Results): Map<string, string> + +
    • +
  • +
    +

    + The function Not filters out + files from the File array based + on the provided + Pattern parameter. +

    +
    +
    +

    Parameters

    +
      +
    • + Pattern: + undefined + | boolean + | Type + | Set<Type> + | Type[] +
      +

      + The + Pattern parameter + is of type + Option["Exclude"]. It represents the patterns or + filters that will be used to + exclude certain files from the + Results array. +

      +
      +
      +
      • +
    • + Results: + Map<string, string> +
      +

      + The + Results parameter + is expected to be an array of + results from a plan. Each + element in the array should be + an array itself, with two + elements. The first element + represents the file name, and + the second element represents + the file content. +

      +
      +
      +
      • +
    +
    +

    + Returns + Map<string, string> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/Pipe.dirname.html b/Documentation/functions/Pipe.dirname.html index 85add39b..235d766c 100644 --- a/Documentation/functions/Pipe.dirname.html +++ b/Documentation/functions/Pipe.dirname.html @@ -1,4 +1,341 @@ -dirname | @playform/pipe - v0.0.2

Function dirname

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + dirname | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function dirname

+
+
+
    +
  • + dirname(path): string + +
    • +
  • +
    +

    + Return the directory name of a path. Similar + to the Unix dirname command. +

    +
    +
    +

    Parameters

    +
      +
    • + path: + string +
      +

      the path to evaluate.

      +
      +
      +
      • +
    +
    +

    + Returns + string +

    +
    +

    Throws

    +

    if path is not a string.

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/Pipe.pipe.html b/Documentation/functions/Pipe.pipe.html index 596d2ee5..8bc4249f 100644 --- a/Documentation/functions/Pipe.pipe.html +++ b/Documentation/functions/Pipe.pipe.html @@ -1,3 +1,375 @@ -pipe | @playform/pipe - v0.0.2

Function pipe

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + pipe | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function pipe

+
+
+ +
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/functions/Pipe.stat.html b/Documentation/functions/Pipe.stat.html index d6f1e16a..8acbc826 100644 --- a/Documentation/functions/Pipe.stat.html +++ b/Documentation/functions/Pipe.stat.html @@ -1,3 +1,555 @@ -stat | @playform/pipe - v0.0.2

Function stat

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + stat | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Function stat

+
+
+ +
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/hierarchy.html b/Documentation/hierarchy.html index af075af5..bdf084ea 100644 --- a/Documentation/hierarchy.html +++ b/Documentation/hierarchy.html @@ -1 +1,289 @@ -@playform/pipe - v0.0.2

@playform/pipe - v0.0.2

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+

@playform/pipe - v0.0.2

+
+

Class Hierarchy

+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/index.html b/Documentation/index.html index 786a9f91..d82a2db3 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -1,43 +1,467 @@ -@playform/pipe - v0.0.2

@playform/pipe - v0.0.2

🧪 Pipe

Pipe allows you to process files in a pipeline, making it easy to perform -various operations on them.

-

Installation

To get started with Pipe, follow these steps:

-

Install the Pipe package using npm:

-
npm install -D -E @playform/pipe
-
-

Create a new pipe instance using the following code in your Index.ts file:

-

Index.ts

-
await new (await import("@playform/pipe")).default().In("./Input");
-
-

Getting started

With Pipe, you can use the Pipe method to perform operations on files within -the pipe. Here's an example of how to use it in your Index.ts:

-

Index.ts

-
await(
    await(await new (await import("@playform/pipe")).default().In("./Input")).By(
        "**/*.md"
    )
).Pipe({
    // Append some content to all of the text files
    Wrote: (On) => (On.Buffer += "LICENSE [MIT]"),
});
-
-

Default Callbacks

Pipe provides default callbacks for file processing. These callbacks can -be customized to suit your specific needs. Here are the default callbacks:

-
await new (await import("@playform/pipe")).default().Pipe({
    // Read the file into a buffer
    Read: async ({ Input }) => await fs.promises.readFile(Input, "utf-8"),

    // Wrote the buffer into a file
    Wrote: async ({ Buffer }) => Buffer,

    // Passed the file through a check
    Passed: async (On) => On && true,

    // Failed processing the file
    Failed: async ({ Input }) => `Error: Cannot process file ${Input}!`,

    // Accomplished processing the file
    Accomplished: async ({ Input, Output }) =>
        `Processed ${Input} in ${Output}.`,

    // Fulfilled the whole plan
    Fulfilled: async ({ File }) =>
        `Successfully processed a total of ${File} ${
            File === 1 ? "file" : "files"
        }.`,

    // Changed the plan
    Changed: async (Plan) => Plan,
});
-
-

Add Multiple Paths

You can add multiple paths to your pipe by specifying an array as the Path -variable:

-

Index.ts

-
await new (await import("@playform/pipe")).default().In(["./Input", "./Input2"]);
-
-

Input-Output Mapping

Pipe will allow you to provide a map of paths for different input and -output directories, making it easy to control where files are read from and -written to:

-

Index.ts

-
await new (await import("@playform/pipe")).default().In(
    new Map([["./Input", "./Output"]])
);
-
-

File Filtering

You can filter files to exclude specific ones from your Pipe. Filters can -be an array of regular expressions or a single match. You can also use functions -to match on file names:

-

Index.ts

-
await new (await import("@playform/pipe")).default().Not([
    "File.txt",
    (File: string) => File === "./Input/File.txt",
]);
-
-

Controlling Logging

You can control the logging level by setting the Logger parameter. The default -value is 2, but you can set it to 0 if you don't want to see debug messages:

-

Index.ts

-
new (await import("@playform/pipe")).default(0);
-
-

Changelog

See CHANGELOG.md for a history of changes to this component.

-

Settings

Member Visibility

Theme

On This Page

🧪 Pipe

Generated using TypeDoc

\ No newline at end of file + + + + + + + @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+

@playform/pipe - v0.0.2

+
+
+ +

+ 🧪 + Pipe +

+

+ Pipe allows you to process files in a + pipeline, making it easy to perform various operations + on them. +

+ +

Installation

+

+ To get started with Pipe, follow these + steps: +

+

Install the Pipe package using npm:

+ 
npm install -D -E @playform/pipe
+
+

+ Create a new pipe instance using the following code in + your Index.ts file: +

+

+ Index.ts +

+ 
await new (await import("@playform/pipe")).default().In("./Input");
+
+ +

Getting started

+

+ With Pipe, you can use the Pipe method to + perform operations on files within the pipe. Here's + an example of how to use it in your Index.ts: +

+

+ Index.ts +

+ 
await(
    await(await new (await import("@playform/pipe")).default().In("./Input")).By(
        "**/*.md"
    )
).Pipe({
    // Append some content to all of the text files
    Wrote: (On) => (On.Buffer += "LICENSE [MIT]"),
});
+
+ +

+ Default Callbacks +

+

+ Pipe provides default callbacks for file + processing. These callbacks can be customized to suit + your specific needs. Here are the default callbacks: +

+ 
await new (await import("@playform/pipe")).default().Pipe({
    // Read the file into a buffer
    Read: async ({ Input }) => await fs.promises.readFile(Input, "utf-8"),

    // Wrote the buffer into a file
    Wrote: async ({ Buffer }) => Buffer,

    // Passed the file through a check
    Passed: async (On) => On && true,

    // Failed processing the file
    Failed: async ({ Input }) => `Error: Cannot process file ${Input}!`,

    // Accomplished processing the file
    Accomplished: async ({ Input, Output }) =>
        `Processed ${Input} in ${Output}.`,

    // Fulfilled the whole plan
    Fulfilled: async ({ File }) =>
        `Successfully processed a total of ${File} ${
            File === 1 ? "file" : "files"
        }.`,

    // Changed the plan
    Changed: async (Plan) => Plan,
});
+
+ +

+ Add Multiple Paths +

+

+ You can add multiple paths to your pipe by specifying an + array as the Path variable: +

+

+ Index.ts +

+ 
await new (await import("@playform/pipe")).default().In(["./Input", "./Input2"]);
+
+ +

+ Input-Output Mapping +

+

+ Pipe will allow you to provide a map of + paths for different input and output directories, making + it easy to control where files are read from and written + to: +

+

+ Index.ts +

+ 
await new (await import("@playform/pipe")).default().In(
    new Map([["./Input", "./Output"]])
);
+
+ +

File Filtering

+

+ You can filter files to exclude specific ones from your + Pipe. Filters can be an array of regular + expressions or a single match. You can also use + functions to match on file names: +

+

+ Index.ts +

+ 
await new (await import("@playform/pipe")).default().Not([
    "File.txt",
    (File: string) => File === "./Input/File.txt",
]);
+
+ +

+ Controlling Logging +

+

+ You can control the logging level by setting the + Logger parameter. The default value is + 2, but you can set it to 0 if + you don't want to see debug messages: +

+

+ Index.ts +

+ 
new (await import("@playform/pipe")).default(0);
+
+ +

Changelog

+

+ See CHANGELOG.md for a + history of changes to this component. +

+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ 🧪 Pipe + +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Apply.Type.html b/Documentation/interfaces/Apply.Type.html index c28f6125..cb7cd3df 100644 --- a/Documentation/interfaces/Apply.Type.html +++ b/Documentation/interfaces/Apply.Type.html @@ -1,2 +1,444 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type ((_Function, Test) => Promise<any>)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + ((_Function, + Test) => Promise<any>) +
+
+
    +
  • + Type(_Function, + Test): Promise<any> + +
    • +
  • +
    +

    + biome-ignore lint/suspicious/noExplicitAny: +

    +
    +
    +

    Parameters

    +
      +
    • + _Function: + ((Test) + => any) +
        +
      • +
          +
        • + (Test): any +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + Test: + any +
            • +
          +
          +

          + Returns + any +

          +
          • +
        +
        • +
      +
      • +
    • + Test: + any +
      • +
    +
    +

    + Returns + Promise<any> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/By.Type.html b/Documentation/interfaces/By.Type.html index a05945c6..51636f32 100644 --- a/Documentation/interfaces/By.Type.html +++ b/Documentation/interfaces/By.Type.html @@ -1,13 +1,488 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type ((File, Paths, Results) => Promise<Map<string, string>>)
  • Type(File, Paths, Results): Promise<Map<string, string>>

  • The function By takes in a file pattern or an array of file patterns, a set -of input and output paths, and a map of results, and returns the updated map -of results after matching the file patterns with the input paths.

    -

    Parameters

    • File: string | string[]

      File is either a single file pattern or an array of file -patterns. These patterns are used to match files in the input directory -(Input) that will be processed.

      -
    • Paths: Map<string, string>

      Paths is an array of tuples that represent the input and -output paths. -Each tuple contains two elements: the input path and the output path.

      -
    • Results: Map<string, string>

      Map object that stores the mapping between the output file -paths and their corresponding input file paths. It is used to keep track of -the files that have been processed and their respective destinations.

      -

    Returns Promise<Map<string, string>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + ((File, + Paths, + Results) => Promise<Map<string, string>>) +
+
+
    +
  • + Type(File, + Paths, + Results): Promise<Map<string, string>> + +
    • +
  • +
    +

    + The function By takes in a file + pattern or an array of file patterns, a set + of input and output paths, and a map of + results, and returns the updated map of + results after matching the file patterns + with the input paths. +

    +
    +
    +

    Parameters

    +
      +
    • + File: + string + | string[] +
      +

      + File is either a single file + pattern or an array of file + patterns. These patterns are + used to match files in the input + directory (Input) + that will be processed. +

      +
      +
      +
      • +
    • + Paths: + Map<string, string> +
      +

      + Paths is an array of tuples that + represent the input and output + paths. Each tuple contains two + elements: the input path and the + output path. +

      +
      +
      +
      • +
    • + Results: + Map<string, string> +
      +

      + Map object that stores the + mapping between the output file + paths and their corresponding + input file paths. It is used to + keep track of the files that + have been processed and their + respective destinations. +

      +
      +
      +
      • +
    +
    +

    + Returns + Promise<Map<string, string>> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Bytes.Type.html b/Documentation/interfaces/Bytes.Type.html index d386df54..dcdb295f 100644 --- a/Documentation/interfaces/Bytes.Type.html +++ b/Documentation/interfaces/Bytes.Type.html @@ -1,7 +1,386 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type ((Bytes, Decimals?) => string)
  • Type(Bytes, Decimals?): string

  • The function converts a given number of bytes into a human-readable format with appropriate units -(e.g., KB, MB, GB).

    -

    Parameters

    • Bytes: number

      The Bytes parameter is the number of bytes that you want to convert to a -human-readable format.

      -
    • Optional Decimals: number

      The Decimals parameter is an optional parameter that specifies the number -of decimal places to round the result to. If not provided, it defaults to 2.

      -

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + ((Bytes, + Decimals?) => string) +
+
+
    +
  • + Type(Bytes, + Decimals?): string + +
    • +
  • +
    +

    + The function converts a given number of + bytes into a human-readable format with + appropriate units (e.g., KB, MB, GB). +

    +
    +
    +

    Parameters

    +
      +
    • + Bytes: + number +
      +

      + The Bytes parameter + is the number of bytes that you + want to convert to a + human-readable format. +

      +
      +
      +
      • +
    • + Optional + Decimals: + number +
      +

      + The + Decimals parameter + is an optional parameter that + specifies the number of decimal + places to round the result to. + If not provided, it defaults to + 2. +

      +
      +
      +
      • +
    +
    +

    + Returns + string +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/File.Type.html b/Documentation/interfaces/File.Type.html index 78918faf..e9b3b97b 100644 --- a/Documentation/interfaces/File.Type.html +++ b/Documentation/interfaces/File.Type.html @@ -1,24 +1,1372 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type {
    By: ((File) => Promise<ThisType<Type>>);
    In: ((Path) => Promise<ThisType<Type>>);
    Not: ((File) => Promise<ThisType<Type>>);
    Pipe: ((Action?) => Promise<ThisType<Type>>);
    Plan: Type;
}

Implemented by

Properties

By -In -Not -Pipe -Plan -

Properties

By

By: ((File) => Promise<ThisType<Type>>)

The function By takes a file pattern or an array of file patterns and returns a promise that -resolves to the results of executing the patterns on the specified paths.

-

Type declaration

    • (File): Promise<ThisType<Type>>

    • Parameters

      • File: string | string[]

        parameter is of type Pattern or -Pattern[]. It represents the file or files that you want to search for. The Pattern type is a -string pattern that can include wildcards to match multiple files.

        -

      Returns Promise<ThisType<Type>>

In

In: ((Path) => Promise<ThisType<Type>>)

The function In takes a path and updates the Plan.Paths property with the input and output -paths.

-

Type declaration

    • (Path): Promise<ThisType<Type>>

    • Parameters

      • Path: Type

        parameter is a string that represents the path to a file or -directory. It has a default value of "./", which means it will use the current directory if no path -is provided.

        -

      Returns Promise<ThisType<Type>>

Not

Not: ((File) => Promise<ThisType<Type>>)

The function Not takes a File parameter and excludes it from the Plan.Results array.

-

Type declaration

Pipe

Pipe: ((Action?) => Promise<ThisType<Type>>)

The function Pipe is a TypeScript async function that takes an optional Action -parameter and returns the result of calling Pipe with this.Plan and Action.

-

Type declaration

    • (Action?): Promise<ThisType<Type>>

    • Parameters

      • Optional Action: Type

        The Action parameter is an optional parameter that -specifies the execution strategy to be used in the Pipe function. It has a default value of -Default.Pipe, which means that if no Action parameter is provided when calling the Pipe -function, it will use the default execution strategy.

        -

      Returns Promise<ThisType<Type>>

Plan

Plan: Type

Settings

Member Visibility

Theme

On This Page

ByInNotPipePlan

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + {
    By: ((File) => Promise<ThisType<Type>>);
    In: ((Path) => Promise<ThisType<Type>>);
    Not: ((File) => Promise<ThisType<Type>>);
    Pipe: ((Action?) => Promise<ThisType<Type>>);
    Plan: Type;
} +
+
+

Implemented by

+ +
+ +
+
+
+ + + +
+
+

+ Properties +

+
+ + By + + In + + Not + + Pipe + + Plan +
+
+
+
+
+
+
+

Properties

+
+ +

+ By + +

+
+ By: + ((File) => Promise<ThisType<Type>>) +
+
+

+ The function By takes a file + pattern or an array of file patterns and returns + a promise that resolves to the results of + executing the patterns on the specified paths. +

+
+
+

Type declaration

+
    +
  • +
      +
    • + (File): Promise<ThisType<Type>> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + File: + string + | string[] +
        +

        + parameter is of + type + Pattern + or + Pattern[]. It represents + the file or + files that you + want to search + for. The + Pattern + type is a string + pattern that can + include + wildcards to + match multiple + files. +

        +
        +
        +
        • +
      +
      +

      + Returns + Promise<ThisType<Type>> +

      +
      • +
    +
    • +
+
+
+ +
+
+ +

+ In + +

+
+ In: + ((Path) => Promise<ThisType<Type>>) +
+
+

+ The function In takes a path and + updates the Plan.Paths property + with the input and output paths. +

+
+
+

Type declaration

+
    +
  • +
      +
    • + (Path): Promise<ThisType<Type>> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + Path: + Type +
        +

        + parameter is a + string that + represents the + path to a file + or directory. It + has a default + value of + "./", + which means it + will use the + current + directory if no + path is + provided. +

        +
        +
        +
        • +
      +
      +

      + Returns + Promise<ThisType<Type>> +

      +
      • +
    +
    • +
+
+
+ +
+
+ +

+ Not + +

+
+ Not: + ((File) => Promise<ThisType<Type>>) +
+
+

+ The function Not takes a + File parameter and excludes it from + the Plan.Results array. +

+
+
+

Type declaration

+ +
+
+ +
+
+ +

+ Pipe + +

+
+ Pipe: + ((Action?) => Promise<ThisType<Type>>) +
+
+

+ The function Pipe is a TypeScript + async function that takes an optional Action + parameter and returns the result of calling Pipe + with this.Plan and Action. +

+
+
+

Type declaration

+
    +
  • +
      +
    • + (Action?): Promise<ThisType<Type>> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + Optional + Action: + Type +
        +

        + The Action + parameter is an + optional + parameter that + specifies the + execution + strategy to be + used in the Pipe + function. It has + a default value + of Default.Pipe, + which means that + if no Action + parameter is + provided when + calling the Pipe + function, it + will use the + default + execution + strategy. +

        +
        +
        +
        • +
      +
      +

      + Returns + Promise<ThisType<Type>> +

      +
      • +
    +
    • +
+
+
+ +
+
+ +

+ Plan + +

+
+ Plan: + Type +
+ +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ + By + In + Not + Pipe + Plan +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/In.Type.html b/Documentation/interfaces/In.Type.html index 8ae98b5b..7ec56cb3 100644 --- a/Documentation/interfaces/In.Type.html +++ b/Documentation/interfaces/In.Type.html @@ -1,6 +1,442 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type ((Path, Paths) => Promise<Map<string, string>>)
  • Type(Path, Paths): Promise<Map<string, string>>

  • The function In takes a Path and a Paths object, and adds the Path to the Paths object.

    -

    Parameters

    • Path: Type

      The Path parameter is a string or URL that represents the path to a file or -directory.

      -
    • Paths: Map<string, string>

      Paths is a variable of type Plan["Paths"]. It is likely an object or a map that -stores key-value pairs.

      -

    Returns Promise<Map<string, string>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + ((Path, + Paths) => Promise<Map<string, string>>) +
+
+
    +
  • + Type(Path, + Paths): Promise<Map<string, string>> + +
    • +
  • +
    +

    + The function In takes a + Path and a + Paths object, and adds the + Path to the + Paths object. +

    +
    +
    +

    Parameters

    +
      +
    • + Path: + Type +
      +

      + The Path parameter + is a string or URL that + represents the path to a file or + directory. +

      +
      +
      +
      • +
    • + Paths: + Map<string, string> +
      +

      + Paths is a variable of type + Plan["Paths"]. It is + likely an object or a map that + stores key-value pairs. +

      +
      +
      +
      • +
    +
    +

    + Returns + Promise<Map<string, string>> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Interface_Action.Type.html b/Documentation/interfaces/Interface_Action.Type.html index 4abef2d5..2e7cd645 100644 --- a/Documentation/interfaces/Interface_Action.Type.html +++ b/Documentation/interfaces/Interface_Action.Type.html @@ -1,22 +1,1629 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type {
    Accomplished?: boolean | ((On) => Promise<string | false>);
    Changed?: ((Plan) => Promise<Type>);
    Failed?: boolean | ((Input, _Error) => Promise<string | false>);
    Fulfilled?: boolean | ((Plan) => Promise<string | false>);
    Passed?: ((On) => Promise<boolean>);
    Read?: ((On) => Promise<Type>);
    Wrote?: ((On) => Promise<Type>);
}

Properties

Accomplished? -Changed? -Failed? -Fulfilled? -Passed? -Read? -Wrote? -

Properties

Optional Accomplished

Accomplished?: boolean | ((On) => Promise<string | false>)

Attaches a callback for actions that are accomplished.

-

Type declaration

Param: On

The file on which an action was accomplished.

-

Optional Changed

Changed?: ((Plan) => Promise<Type>)

Attaches a callback for actions that result in changes to the plan.

-

Type declaration

Optional Failed

Failed?: boolean | ((Input, _Error) => Promise<string | false>)

Attaches a callback for handling failures in the Action.

-

Type declaration

    • (Input, _Error): Promise<string | false>

    • Parameters

      • Input: Type
      • _Error: unknown

      Returns Promise<string | false>

Param: Input

The input file being processed.

-

Param: _Error

The error encountered during execution.

-

Optional Fulfilled

Fulfilled?: boolean | ((Plan) => Promise<string | false>)

Attaches a callback for the fulfillment of the Action.

-

Type declaration

Param: Plan

Optional Passed

Passed?: ((On) => Promise<boolean>)

Attaches a callback for actions that check if a file can pass through the pipe.

-

Type declaration

    • (On): Promise<boolean>

    • Parameters

      • On: Type

        The file on which the action is being checked.

        -

      Returns Promise<boolean>

Optional Read

Read?: ((On) => Promise<Type>)

Attaches a callback for reading from a file.

-

Type declaration

Optional Wrote

Wrote?: ((On) => Promise<Type>)

Attaches a callback for writing to a file.

-

Type declaration

Settings

Member Visibility

Theme

On This Page

AccomplishedChangedFailedFulfilledPassedReadWrote

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + {
    Accomplished?: boolean | ((On) => Promise<string | false>);
    Changed?: ((Plan) => Promise<Type>);
    Failed?: boolean | ((Input, + _Error) => Promise<string | false>);
    Fulfilled?: boolean | ((Plan) => Promise<string | false>);
    Passed?: ((On) => Promise<boolean>);
    Read?: ((On) => Promise<Type>);
    Wrote?: ((On) => Promise<Type>);
} +
+ +
+
+
+ + + +
+
+

+ Properties +

+
+ + Accomplished? + + Changed? + + Failed? + + Fulfilled? + + Passed? + + Read? + + Wrote? +
+
+
+
+
+
+
+

Properties

+
+ +

+ Optional + Accomplished + +

+
+ Accomplished?: + boolean | ((On) => Promise<string | false>) +
+
+

+ Attaches a callback for actions that are + accomplished. +

+
+
+

Type declaration

+
    +
  • +
      +
    • + (On): Promise<string + | false> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + On: + Type +
        • +
      +
      +

      + Returns + Promise<string + | false> +

      +
      • +
    +
    • +
+
+
+

Param: On

+

The file on which an action was accomplished.

+
+ +
+
+ +

+ Optional + Changed + +

+
+ Changed?: + ((Plan) => Promise<Type>) +
+
+

+ Attaches a callback for actions that result in + changes to the plan. +

+
+
+

Type declaration

+
    +
  • +
      +
    • + (Plan): Promise<Type> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + Plan: + Type +
        +

        + The execution + plan to be + changed. +

        +
        +
        +
        • +
      +
      +

      + Returns + Promise<Type> +

      +
      • +
    +
    • +
+
+
+ +
+
+ +

+ Optional + Failed + +

+
+ Failed?: + boolean | ((Input, + _Error) => Promise<string | false>) +
+
+

+ Attaches a callback for handling failures in the + Action. +

+
+
+

Type declaration

+
    +
  • +
      +
    • + (Input, + _Error): Promise<string + | false> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + Input: + Type +
        • +
      • + _Error: + unknown +
        • +
      +
      +

      + Returns + Promise<string + | false> +

      +
      • +
    +
    • +
+
+
+

Param: Input

+

The input file being processed.

+

Param: _Error

+

The error encountered during execution.

+
+ +
+
+ +

+ Optional + Fulfilled + +

+
+ Fulfilled?: + boolean | ((Plan) => Promise<string | false>) +
+
+

+ Attaches a callback for the fulfillment of the + Action. +

+
+
+

Type declaration

+
    +
  • +
      +
    • + (Plan): Promise<string + | false> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + Plan: + Type +
        • +
      +
      +

      + Returns + Promise<string + | false> +

      +
      • +
    +
    • +
+
+
+

Param: Plan

+
+ +
+
+ +

+ Optional + Passed + +

+
+ Passed?: + ((On) => Promise<boolean>) +
+
+

+ Attaches a callback for actions that check if a + file can pass through the pipe. +

+
+
+

Type declaration

+
    +
  • +
      +
    • + (On): Promise<boolean> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + On: + Type +
        +

        + The file on + which the action + is being + checked. +

        +
        +
        +
        • +
      +
      +

      + Returns + Promise<boolean> +

      +
      • +
    +
    • +
+
+
+ +
+
+ +

+ Optional + Read + +

+
+ Read?: + ((On) => Promise<Type>) +
+
+

Attaches a callback for reading from a file.

+
+
+

Type declaration

+
    +
  • +
      +
    • + (On): Promise<Type> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + On: + Type +
        +

        + The file to be + read. +

        +
        +
        +
        • +
      +
      +

      + Returns + Promise<Type> +

      +
      • +
    +
    • +
+
+
+ +
+
+ +

+ Optional + Wrote + +

+
+ Wrote?: + ((On) => Promise<Type>) +
+
+

Attaches a callback for writing to a file.

+
+
+

Type declaration

+
    +
  • +
      +
    • + (On): Promise<Type> +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + On: + Type +
        +

        + The file to be + written to. +

        +
        +
        +
        • +
      +
      +

      + Returns + Promise<Type> +

      +
      • +
    +
    • +
+
+
+ +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ + Accomplished + Changed + Failed + Fulfilled + Passed + Read + Wrote +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Interface_Cache.Type.html b/Documentation/interfaces/Interface_Cache.Type.html index 8800aa65..3364a78c 100644 --- a/Documentation/interfaces/Interface_Cache.Type.html +++ b/Documentation/interfaces/Interface_Cache.Type.html @@ -1,3 +1,467 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type {
    Folder: string | URL;
    Search: string | URL;
}

Properties

Folder -Search -

Properties

Folder

Folder: string | URL

Search

Search: string | URL

Settings

Member Visibility

Theme

On This Page

FolderSearch

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + {
    Folder: string | URL;
    Search: string | URL;
} +
+ +
+
+
+ + + +
+
+

+ Properties +

+
+ + Folder + + Search +
+
+
+
+
+
+
+

Properties

+
+ +

+ Folder + +

+
+ Folder: + string | URL +
+ +
+
+ +

+ Search + +

+
+ Search: + string | URL +
+ +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ + Folder + Search +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Interface_Dir.Type.html b/Documentation/interfaces/Interface_Dir.Type.html index 0d5dc84a..9863a189 100644 --- a/Documentation/interfaces/Interface_Dir.Type.html +++ b/Documentation/interfaces/Interface_Dir.Type.html @@ -1,5 +1,467 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type {
    Input: string;
    Output: string;
}

Properties

Input -Output -

Properties

Input

Input: string

The input directory.

-

Output

Output: string

The output directory.

-

Settings

Member Visibility

Theme

On This Page

InputOutput

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + {
    Input: string;
    Output: string;
} +
+ +
+
+
+ + + +
+
+

+ Properties +

+
+ + Input + + Output +
+
+
+
+
+
+
+

Properties

+
+ +

+ Input + +

+
+ Input: + string +
+
+

The input directory.

+
+
+ +
+
+ +

+ Output + +

+
+ Output: + string +
+
+

The output directory.

+
+
+ +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ + Input + Output +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Interface_File.Type.html b/Documentation/interfaces/Interface_File.Type.html index 25a456d7..6c43fd77 100644 --- a/Documentation/interfaces/Interface_File.Type.html +++ b/Documentation/interfaces/Interface_File.Type.html @@ -1,11 +1,645 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type {
    After: number;
    Before: number;
    Buffer: Type;
    Input: string;
    Output: string;
}

Properties

After -Before -Buffer -Input -Output -

Properties

After

After: number

The size after the action.

-

Before

Before: number

The size before the action.

-

Buffer

Buffer: Type

The buffer data.

-

Input

Input: string

The input file.

-

Output

Output: string

The output file.

-

Settings

Member Visibility

Theme

On This Page

AfterBeforeBufferInputOutput

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + {
    After: number;
    Before: number;
    Buffer: Type;
    Input: string;
    Output: string;
} +
+ +
+
+
+ + + +
+
+

+ Properties +

+
+ + After + + Before + + Buffer + + Input + + Output +
+
+
+
+
+
+
+

Properties

+
+ +

+ After + +

+
+ After: + number +
+
+

The size after the action.

+
+
+ +
+
+ +

+ Before + +

+
+ Before: + number +
+
+

The size before the action.

+
+
+ +
+
+ +

+ Buffer + +

+
+ Buffer: + Type +
+
+

The buffer data.

+
+
+ +
+
+ +

+ Input + +

+
+ Input: + string +
+
+

The input file.

+
+
+ +
+
+ +

+ Output + +

+
+ Output: + string +
+
+

The output file.

+
+
+ +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ + After + Before + Buffer + Input + Output +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Interface_Merge.Generic.html b/Documentation/interfaces/Interface_Merge.Generic.html index d091bf32..fe66ba0c 100644 --- a/Documentation/interfaces/Interface_Merge.Generic.html +++ b/Documentation/interfaces/Interface_Merge.Generic.html @@ -1,2 +1,416 @@ -Generic | @playform/pipe - v0.0.2

Interface Generic

interface Generic {
    DeepMergeArraysURI: "DeepMergeLeafURI";
}

Properties

DeepMergeArraysURI -

Properties

DeepMergeArraysURI

DeepMergeArraysURI: "DeepMergeLeafURI"

Settings

Member Visibility

Theme

On This Page

DeepMergeArraysURI

Generated using TypeDoc

\ No newline at end of file + + + + + + + Generic | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Generic

+
+
+ interface Generic + {
    DeepMergeArraysURI: "DeepMergeLeafURI";
} +
+ +
+
+
+ + + +
+
+

+ Properties +

+
+ + DeepMergeArraysURI +
+
+
+
+
+
+
+

Properties

+
+ +

+ DeepMergeArraysURI + +

+
+ DeepMergeArraysURI: + "DeepMergeLeafURI" +
+ +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ + DeepMergeArraysURI +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Interface_Merge.Type.html b/Documentation/interfaces/Interface_Merge.Type.html index 761da56d..ac16269b 100644 --- a/Documentation/interfaces/Interface_Merge.Type.html +++ b/Documentation/interfaces/Interface_Merge.Type.html @@ -1,2 +1,1110 @@ -Type | @playform/pipe - v0.0.2

Interface Type<PMF>

interface Type<PMF> (<Ts>(...Objects) => DeepMergeHKT<Ts, Readonly<{
    DeepMergeArraysURI: PMF["DeepMergeArraysURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeArraysDefaultURI";
    DeepMergeMapsURI: PMF["DeepMergeMapsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeMapsDefaultURI";
    DeepMergeOthersURI: PMF["DeepMergeOthersURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeLeafURI";
    DeepMergeRecordsURI: PMF["DeepMergeRecordsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeRecordsDefaultURI";
    DeepMergeSetsURI: PMF["DeepMergeSetsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeSetsDefaultURI";
}>, Readonly<{
    key: PropertyKey;
    parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>>)

Type Parameters

  • PMF extends Partial<DeepMergeMergeFunctionsURIs>
  • Type<Ts>(...Objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: PMF["DeepMergeArraysURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeArraysDefaultURI";
        DeepMergeMapsURI: PMF["DeepMergeMapsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: PMF["DeepMergeOthersURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeLeafURI";
        DeepMergeRecordsURI: PMF["DeepMergeRecordsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: PMF["DeepMergeSetsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

  • Merges multiple objects of type Ts using the provided merge functions and built-in metadata.

    -

    Type Parameters

    • Ts extends readonly unknown[]

    Parameters

    • Rest ...Objects: Ts

    Returns DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: PMF["DeepMergeArraysURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeArraysDefaultURI";
        DeepMergeMapsURI: PMF["DeepMergeMapsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: PMF["DeepMergeOthersURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeLeafURI";
        DeepMergeRecordsURI: PMF["DeepMergeRecordsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: PMF["DeepMergeSetsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type<PMF>

+
+
+ interface Type<PMF> + (<Ts>(...Objects) => DeepMergeHKT<Ts, Readonly<{
    DeepMergeArraysURI: PMF["DeepMergeArraysURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeArraysDefaultURI";
    DeepMergeMapsURI: PMF["DeepMergeMapsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeMapsDefaultURI";
    DeepMergeOthersURI: PMF["DeepMergeOthersURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeLeafURI";
    DeepMergeRecordsURI: PMF["DeepMergeRecordsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeRecordsDefaultURI";
    DeepMergeSetsURI: PMF["DeepMergeSetsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
        ? any[any]
        : "DeepMergeSetsDefaultURI";
}>, Readonly<{
    key: PropertyKey;
    parents: readonly Readonly<Record<PropertyKey, unknown>>[];
}>>) +
+
+

Type Parameters

+
    +
  • + PMF + extends Partial<DeepMergeMergeFunctionsURIs> +
    • +
+
+
+
    +
  • + Type<Ts>(...Objects): DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: PMF["DeepMergeArraysURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeArraysDefaultURI";
        DeepMergeMapsURI: PMF["DeepMergeMapsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: PMF["DeepMergeOthersURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeLeafURI";
        DeepMergeRecordsURI: PMF["DeepMergeRecordsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: PMF["DeepMergeSetsURI"] extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>> + +
    • +
  • +
    +

    + Merges multiple objects of type Ts using the + provided merge functions and built-in + metadata. +

    +
    +
    +

    Type Parameters

    +
      +
    • + Ts + extends readonly unknown[] +
      • +
    +
    +
    +

    Parameters

    +
      +
    • + Rest + ...Objects: + Ts +
      • +
    +
    +

    + Returns + DeepMergeHKT<Ts, Readonly<{
        DeepMergeArraysURI: PMF["DeepMergeArraysURI"] + extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeArraysDefaultURI";
        DeepMergeMapsURI: PMF["DeepMergeMapsURI"] + extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeMapsDefaultURI";
        DeepMergeOthersURI: PMF["DeepMergeOthersURI"] + extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeLeafURI";
        DeepMergeRecordsURI: PMF["DeepMergeRecordsURI"] + extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeRecordsDefaultURI";
        DeepMergeSetsURI: PMF["DeepMergeSetsURI"] + extends keyof DeepMergeMergeFunctionURItoKind<any, any, any>
            ? any[any]
            : "DeepMergeSetsDefaultURI";
    }>, Readonly<{
        key: PropertyKey;
        parents: readonly Readonly<Record<PropertyKey, unknown>>[];
    }>> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Interface_Option.Type.html b/Documentation/interfaces/Interface_Option.Type.html index 5d2528e0..bc4a6fcc 100644 --- a/Documentation/interfaces/Interface_Option.Type.html +++ b/Documentation/interfaces/Interface_Option.Type.html @@ -1,19 +1,860 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type {
    Action?: boolean | Type;
    Cache?: boolean | Type;
    Exclude?: boolean | Type | Set<Type> | Type[];
    File?: string | boolean | string[];
    Logger?: boolean | Type;
    Path?: boolean | Type | Set<Type> | Type[];
}

Properties

Action? -Cache? -Exclude? -File? -Logger? -Path? -

Properties

Optional Action

Action?: boolean | Type

Action pipe configuration.

-

Optional Cache

Cache?: boolean | Type

Configuration for the target cache.

-

Default

{ Search: "./", Folder: "./Cache" }
+
+
+	
+		
+		
+		
+		Type | @playform/pipe - v0.0.2
+		
+		
+		
+		
+		
+		
+		
+		
+		
+	
+	
+		
+		

+			

+				
+				

+					
+							
+				

+			

+		

+		

+			

+				

+					
+					
Interface Type

+				

+				

+					interface Type
+					{ 
    Action?: boolean | Type; 
    Cache?: boolean | Type; 
    Exclude?: boolean | Type | Set<Type> | Type[]; 
    File?: string | boolean | string[]; 
    Logger?: boolean | Type; 
    Path?: boolean | Type | Set<Type> | Type[]; 
}
+				

+				
+				

+					

+						

+							
+								
+							
+							

+								

+									

+										Properties
+									

+									

+										
+												Action?
+										
+												Cache?
+										
+												Exclude?
+										
+												File?
+										
+												Logger?
+										
+												Path?
+									

+								

+							

+						

+					

+				

+				

+					
Properties

+					

+						
+						

+							Optional
+							Action
+									
+						

+						

+							Action?:
+							boolean | Type
+						

+						

+							
Action pipe configuration.

+						

+						

+						
+					

+					

+						
+						

+							Optional
+							Cache
+									
+						

+						

+							Cache?:
+							boolean | Type
+						

+						

+							
Configuration for the target cache.

+						

+						

+							
Default

+							
{ Search: "./", Folder: "./Cache" }
 

-
Optional Exclude
Exclude?: boolean | Type | Set<Type> | Type[]
Criteria for excluding files.

-
Optional File
File?: string | boolean | string[]
File patterns to be matched.

-
Optional Logger
Logger?: boolean | Type
Debugging level.

-
Default
2
+						

+						
+					

+					

+						
+						

+							Optional
+							Exclude
+									
+						

+						

+							Exclude?:
+							boolean | Type | Set<Type> | Type[]
+						

+						

+							
Criteria for excluding files.

+						

+						

+						
+					

+					

+						
+						

+							Optional
+							File
+									
+						

+						

+							File?:
+							string | boolean | string[]
+						

+						

+							
File patterns to be matched.

+						

+						

+						
+					

+					

+						
+						

+							Optional
+							Logger
+									
+						

+						

+							Logger?:
+							boolean | Type
+						

+						

+							
Debugging level.

+						

+						

+							
Default

+							
2
 

-
Optional Path
Path?: boolean | Type | Set<Type> | Type[]
Configuration for the target path(s).

-
Default
"./Target"
+						

+						
+					

+					

+						
+						

+							Optional
+							Path
+									
+						

+						

+							Path?:
+							boolean | Type | Set<Type> | Type[]
+						

+						

+							
Configuration for the target path(s).

+						

+						

+							
Default

+							
"./Target"
 

-
Settings
Member Visibility
Theme
On This Page
ActionCacheExcludeFileLoggerPath
Generated using TypeDoc

\ No newline at end of file
+
+ +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ + Action + Cache + Exclude + File + Logger + Path +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Interface_Plan.Type.html b/Documentation/interfaces/Interface_Plan.Type.html index ae47987f..74ad8276 100644 --- a/Documentation/interfaces/Interface_Plan.Type.html +++ b/Documentation/interfaces/Interface_Plan.Type.html @@ -1,15 +1,812 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type {
    Cache: Type;
    File: number;
    Info: any;
    Logger: Type;
    On: Type;
    Paths: Map<string, string>;
    Results: Map<string, string>;
}

Properties

Cache -File -Info -Logger -On -Paths -Results -

Properties

Cache

Cache: Type

Represents the cache configuration.

-

File

File: number

The number of files in the execution plan.

-

Info

Info: any

biome-ignore lint/suspicious/noExplicitAny:

-

Logger

Logger: Type

The debugging level for the execution plan.

-

On

On: Type

The file currently being operated on.

-

Paths

Paths: Map<string, string>

Mapping of input paths to output paths.

-

Results

Results: Map<string, string>

Mapping of result paths to corresponding input paths.

-

Settings

Member Visibility

Theme

On This Page

CacheFileInfoLoggerOnPathsResults

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + {
    Cache: Type;
    File: number;
    Info: any;
    Logger: Type;
    On: Type;
    Paths: Map<string, string>;
    Results: Map<string, string>;
} +
+ +
+
+
+ + + +
+
+

+ Properties +

+
+ + Cache + + File + + Info + + Logger + + On + + Paths + + Results +
+
+
+
+
+
+
+

Properties

+
+ +

+ Cache + +

+
+ Cache: + Type +
+
+

Represents the cache configuration.

+
+
+ +
+
+ +

+ File + +

+
+ File: + number +
+
+

The number of files in the execution plan.

+
+
+ +
+
+ +

+ Info + +

+
+ Info: + any +
+
+

biome-ignore lint/suspicious/noExplicitAny:

+
+
+ +
+
+ +

+ Logger + +

+
+ Logger: + Type +
+
+

The debugging level for the execution plan.

+
+
+ +
+
+ +

+ On + +

+
+ On: + Type +
+
+

The file currently being operated on.

+
+
+ +
+
+ +

+ Paths + +

+
+ Paths: + Map<string, string> +
+
+

Mapping of input paths to output paths.

+
+
+ +
+
+ +

+ Results + +

+
+ Results: + Map<string, string> +
+
+

+ Mapping of result paths to corresponding input + paths. +

+
+
+ +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+ +

+ + On This Page +

+ +
+ + Cache + File + Info + Logger + On + Paths + Results +
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Not.Type.html b/Documentation/interfaces/Not.Type.html index 6b79d182..bb5df587 100644 --- a/Documentation/interfaces/Not.Type.html +++ b/Documentation/interfaces/Not.Type.html @@ -1,8 +1,462 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type ((Pattern, Results) => Map<string, string>)
  • Type(Pattern, Results): Map<string, string>

  • The function Not filters out files from the File array based on the provided Pattern -parameter.

    -

    Parameters

    • Pattern: undefined | boolean | Type | Set<Type> | Type[]

      The Pattern parameter is of type Option["Exclude"]. It represents the patterns -or filters that will be used to exclude certain files from the Results array.

      -
    • Results: Map<string, string>

      The Results parameter is expected to be an array of results from a plan. Each element -in the array should be an array itself, with two elements. The first element represents the file -name, and the second element represents the file content.

      -

    Returns Map<string, string>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + ((Pattern, + Results) => Map<string, string>) +
+
+
    +
  • + Type(Pattern, + Results): Map<string, string> + +
    • +
  • +
    +

    + The function Not filters out + files from the File array based + on the provided + Pattern parameter. +

    +
    +
    +

    Parameters

    +
      +
    • + Pattern: + undefined + | boolean + | Type + | Set<Type> + | Type[] +
      +

      + The + Pattern parameter + is of type + Option["Exclude"]. It represents the patterns or + filters that will be used to + exclude certain files from the + Results array. +

      +
      +
      +
      • +
    • + Results: + Map<string, string> +
      +

      + The + Results parameter + is expected to be an array of + results from a plan. Each + element in the array should be + an array itself, with two + elements. The first element + represents the file name, and + the second element represents + the file content. +

      +
      +
      +
      • +
    +
    +

    + Returns + Map<string, string> +

    +
    + +
    • +
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/interfaces/Pipe.Type.html b/Documentation/interfaces/Pipe.Type.html index 873a9ede..b7550247 100644 --- a/Documentation/interfaces/Pipe.Type.html +++ b/Documentation/interfaces/Pipe.Type.html @@ -1,3 +1,397 @@ -Type | @playform/pipe - v0.0.2

Interface Type

interface Type ((Plan, Action) => Promise<Type>)

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Interface Type

+
+
+ interface Type + ((Plan, + Action) => Promise<Type>) +
+
+ +
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Apply.html b/Documentation/modules/Apply.html index c5a01cb1..500f2c6d 100644 --- a/Documentation/modules/Apply.html +++ b/Documentation/modules/Apply.html @@ -1,3 +1,318 @@ -Apply | @playform/pipe - v0.0.2

Module Apply

Index

Interfaces

Type -

Functions

apply -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Apply | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Apply

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+

Functions

+
+ + apply +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/By.html b/Documentation/modules/By.html index d92b0f48..eda21762 100644 --- a/Documentation/modules/By.html +++ b/Documentation/modules/By.html @@ -1,3 +1,318 @@ -By | @playform/pipe - v0.0.2

Module By

Index

Interfaces

Type -

Functions

by -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + By | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module By

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+

Functions

+
+ + by +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Bytes.html b/Documentation/modules/Bytes.html index 30225795..b26dede8 100644 --- a/Documentation/modules/Bytes.html +++ b/Documentation/modules/Bytes.html @@ -1,4 +1,333 @@ -Bytes | @playform/pipe - v0.0.2

Module Bytes

Index

Interfaces

Type -

Variables

Kilobyte -

Functions

bytes -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Bytes | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Bytes

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+

Variables

+
+ + Kilobyte +
+
+
+

Functions

+
+ + bytes +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/File.html b/Documentation/modules/File.html index 370a81de..589e6848 100644 --- a/Documentation/modules/File.html +++ b/Documentation/modules/File.html @@ -1,7 +1,368 @@ -File | @playform/pipe - v0.0.2

Module File

Index

Classes

file -

Interfaces

Type -

Variables

Action -Cache -Logger -

Functions

Merge -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + File | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module File

+
+ +
+
+

Index

+
+

Classes

+
+ + file +
+
+
+

Interfaces

+
+ + Type +
+
+
+

Variables

+
+ + Action + + Cache + + Logger +
+
+
+

Functions

+
+ + Merge +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/In.html b/Documentation/modules/In.html index d18c8d48..ded3415f 100644 --- a/Documentation/modules/In.html +++ b/Documentation/modules/In.html @@ -1,5 +1,343 @@ -In | @playform/pipe - v0.0.2

Module In

Index

Interfaces

Type -

Variables

_Path -

Functions

Apply -in -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + In | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module In

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+

Variables

+
+ + _Path +
+
+
+

Functions

+
+ + Apply + + in +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Interface_Action.html b/Documentation/modules/Interface_Action.html index f99d87a9..ebe905ec 100644 --- a/Documentation/modules/Interface_Action.html +++ b/Documentation/modules/Interface_Action.html @@ -1,2 +1,305 @@ -Interface/Action | @playform/pipe - v0.0.2

Module Interface/Action

Index

Interfaces

Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Interface/Action | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Interface/Action

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Interface_Cache.html b/Documentation/modules/Interface_Cache.html index 0b176984..5a760d49 100644 --- a/Documentation/modules/Interface_Cache.html +++ b/Documentation/modules/Interface_Cache.html @@ -1,2 +1,305 @@ -Interface/Cache | @playform/pipe - v0.0.2

Module Interface/Cache

Index

Interfaces

Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Interface/Cache | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Interface/Cache

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Interface_Dir.html b/Documentation/modules/Interface_Dir.html index 5b7b17fd..a380b53f 100644 --- a/Documentation/modules/Interface_Dir.html +++ b/Documentation/modules/Interface_Dir.html @@ -1,2 +1,303 @@ -Interface/Dir | @playform/pipe - v0.0.2

Module Interface/Dir

Index

Interfaces

Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Interface/Dir | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Interface/Dir

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Interface_File.html b/Documentation/modules/Interface_File.html index 22dc40bf..2c1b0c9e 100644 --- a/Documentation/modules/Interface_File.html +++ b/Documentation/modules/Interface_File.html @@ -1,2 +1,305 @@ -Interface/File | @playform/pipe - v0.0.2

Module Interface/File

Index

Interfaces

Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Interface/File | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Interface/File

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Interface_Merge.html b/Documentation/modules/Interface_Merge.html index c6ad63bf..04ce5aac 100644 --- a/Documentation/modules/Interface_Merge.html +++ b/Documentation/modules/Interface_Merge.html @@ -1,4 +1,4 @@ Interface/Merge | @playform/pipe - v0.0.2

Module Interface/Merge

Template: PMF

A type parameter representing Partial.

Index

Interfaces

Generic Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

Generated using TypeDoc

diff --git a/Documentation/modules/Interface_Option.html b/Documentation/modules/Interface_Option.html index 96c86a59..56be3f17 100644 --- a/Documentation/modules/Interface_Option.html +++ b/Documentation/modules/Interface_Option.html @@ -1,2 +1,305 @@ -Interface/Option | @playform/pipe - v0.0.2

Module Interface/Option

Index

Interfaces

Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Interface/Option | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Interface/Option

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Merge.html b/Documentation/modules/Merge.html index ddd60b53..49cbd30d 100644 --- a/Documentation/modules/Merge.html +++ b/Documentation/modules/Merge.html @@ -1,2 +1,303 @@ -Merge | @playform/pipe - v0.0.2

Module Merge

Index

Functions

merge -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Merge | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Merge

+
+ +
+
+

Index

+
+

Functions

+
+ + merge +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Not.html b/Documentation/modules/Not.html index 3b0d7b5f..619571d7 100644 --- a/Documentation/modules/Not.html +++ b/Documentation/modules/Not.html @@ -1,4 +1,333 @@ -Not | @playform/pipe - v0.0.2

Module Not

Index

Interfaces

Type -

Variables

Filters -

Functions

not -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Not | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Not

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+

Variables

+
+ + Filters +
+
+
+

Functions

+
+ + not +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Option.html b/Documentation/modules/Option.html index 3f8eda57..d6fc03de 100644 --- a/Documentation/modules/Option.html +++ b/Documentation/modules/Option.html @@ -1,2 +1,303 @@ -Option | @playform/pipe - v0.0.2

Module Option

Index

Variables

option -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Option | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Option

+
+ +
+
+

Index

+
+

Variables

+
+ + option +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Pipe.html b/Documentation/modules/Pipe.html index 8707117c..613091cb 100644 --- a/Documentation/modules/Pipe.html +++ b/Documentation/modules/Pipe.html @@ -1,5 +1,338 @@ -Pipe | @playform/pipe - v0.0.2

Module Pipe

Index

Interfaces

Type -

Functions

dirname -pipe -stat -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Pipe | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Pipe

+
+ +
+
+

Index

+
+

Interfaces

+
+ + Type +
+
+
+

Functions

+
+ + dirname + + pipe + + stat +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Type_Buffer.html b/Documentation/modules/Type_Buffer.html index fe536e85..e6e67355 100644 --- a/Documentation/modules/Type_Buffer.html +++ b/Documentation/modules/Type_Buffer.html @@ -1,2 +1,303 @@ -Type/Buffer | @playform/pipe - v0.0.2

Module Type/Buffer

Index

Type Aliases

Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type/Buffer | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Type/Buffer

+
+ +
+
+

Index

+
+

Type Aliases

+
+ + Type +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Type_Exclude.html b/Documentation/modules/Type_Exclude.html index 4b4423b9..88566d18 100644 --- a/Documentation/modules/Type_Exclude.html +++ b/Documentation/modules/Type_Exclude.html @@ -1,2 +1,303 @@ -Type/Exclude | @playform/pipe - v0.0.2

Module Type/Exclude

Index

Type Aliases

Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type/Exclude | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Type/Exclude

+
+ +
+
+

Index

+
+

Type Aliases

+
+ + Type +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Type_Logger.html b/Documentation/modules/Type_Logger.html index c6cf4678..e7c8cb18 100644 --- a/Documentation/modules/Type_Logger.html +++ b/Documentation/modules/Type_Logger.html @@ -1,2 +1,303 @@ -Type/Logger | @playform/pipe - v0.0.2

Module Type/Logger

Index

Type Aliases

Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type/Logger | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Type/Logger

+
+ +
+
+

Index

+
+

Type Aliases

+
+ + Type +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/modules/Type_Path.html b/Documentation/modules/Type_Path.html index d75ce420..1241de84 100644 --- a/Documentation/modules/Type_Path.html +++ b/Documentation/modules/Type_Path.html @@ -1,2 +1,303 @@ -Type/Path | @playform/pipe - v0.0.2

Module Type/Path

Index

Type Aliases

Type -

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type/Path | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Module Type/Path

+
+ +
+
+

Index

+
+

Type Aliases

+
+ + Type +
+
+
+
+
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/types/Type_Buffer.Type.html b/Documentation/types/Type_Buffer.Type.html index 5274976f..595daae8 100644 --- a/Documentation/types/Type_Buffer.Type.html +++ b/Documentation/types/Type_Buffer.Type.html @@ -1 +1,314 @@ -Type | @playform/pipe - v0.0.2

Type alias Type

Type: string | NodeJS.ArrayBufferView | Iterable<string | NodeJS.ArrayBufferView> | AsyncIterable<string | NodeJS.ArrayBufferView> | Stream

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type alias Type

+
+
+ Type: + string | NodeJS.ArrayBufferView | Iterable<string | NodeJS.ArrayBufferView> | AsyncIterable<string | NodeJS.ArrayBufferView> | Stream +
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/types/Type_Exclude.Type.html b/Documentation/types/Type_Exclude.Type.html index 6b537019..43d5fc16 100644 --- a/Documentation/types/Type_Exclude.Type.html +++ b/Documentation/types/Type_Exclude.Type.html @@ -1 +1,352 @@ -Type | @playform/pipe - v0.0.2

Type alias Type

Type: string | RegExp | ((File) => boolean)

Type declaration

    • (File): boolean

    • Parameters

      • File: string

      Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type alias Type

+
+
+ Type: + string | RegExp | ((File) => boolean) +
+
+

Type declaration

+
    +
  • +
      +
    • + (File): boolean +
      • +
    • +
      +

      + Parameters +

      +
        +
      • + File: + string +
        • +
      +
      +

      + Returns + boolean +

      +
      • +
    +
    • +
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/types/Type_Logger.Type.html b/Documentation/types/Type_Logger.Type.html index f296d030..cdd68721 100644 --- a/Documentation/types/Type_Logger.Type.html +++ b/Documentation/types/Type_Logger.Type.html @@ -1 +1,297 @@ -Type | @playform/pipe - v0.0.2

Type alias Type

Type: 0 | 1 | 2

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type alias Type

+
+
+ Type: + 0 | 1 | 2 +
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/types/Type_Path.Type.html b/Documentation/types/Type_Path.Type.html index 5e8d990a..042cc75a 100644 --- a/Documentation/types/Type_Path.Type.html +++ b/Documentation/types/Type_Path.Type.html @@ -1 +1,308 @@ -Type | @playform/pipe - v0.0.2

Type alias Type

Type: string | URL | Map<string | URL, string | URL>

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Type | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Type alias Type

+
+
+ Type: + string | URL | Map<string | URL, string | URL> +
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/variables/Bytes.Kilobyte.html b/Documentation/variables/Bytes.Kilobyte.html index 8c529c54..8658cc79 100644 --- a/Documentation/variables/Bytes.Kilobyte.html +++ b/Documentation/variables/Bytes.Kilobyte.html @@ -1 +1,294 @@ -Kilobyte | @playform/pipe - v0.0.2

Variable KilobyteConst

Kilobyte: 1024 = 1024

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Kilobyte | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

+ Variable KilobyteConst +

+
+
+ Kilobyte: + 1024 = 1024 +
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/variables/File.Action.html b/Documentation/variables/File.Action.html index da7b6a25..4bf5fda7 100644 --- a/Documentation/variables/File.Action.html +++ b/Documentation/variables/File.Action.html @@ -1,2 +1,1112 @@ -Action | @playform/pipe - v0.0.2

Variable Action

Action: {
    Accomplished: ((__namedParameters) => Promise<string>);
    Changed: ((Plan) => Promise<Type>);
    Failed: ((__namedParameters) => Promise<string>);
    Fulfilled: ((__namedParameters) => Promise<string | false>);
    Passed: ((On) => Promise<true>);
    Read: ((__namedParameters) => Promise<string>);
    Wrote: ((__namedParameters) => Promise<Type>);
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Action | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Variable Action

+
+
+ Action: + {
    Accomplished: ((__namedParameters) => Promise<string>);
    Changed: ((Plan) => Promise<Type>);
    Failed: ((__namedParameters) => Promise<string>);
    Fulfilled: ((__namedParameters) => Promise<string | false>);
    Passed: ((On) => Promise<true>);
    Read: ((__namedParameters) => Promise<string>);
    Wrote: ((__namedParameters) => Promise<Type>);
} +
+
+

Type declaration

+
    +
  • +
    + Accomplished: ((__namedParameters) + => Promise<string>) +
    +
      +
    • +
        +
      • + (__namedParameters): Promise<string> +
        • +
      • +
        +

        + Parameters +

        +
          +
        • + __namedParameters: + Type +
          • +
        +
        +

        + Returns + Promise<string> +

        +
        • +
      +
      • +
    +
    • +
  • +
    + Changed: ((Plan) + => Promise<Type>) +
    + +
    • +
  • +
    + Failed: ((__namedParameters) + => Promise<string>) +
    +
      +
    • +
        +
      • + (__namedParameters): Promise<string> +
        • +
      • +
        +

        + Parameters +

        +
          +
        • + __namedParameters: + Type +
          • +
        +
        +

        + Returns + Promise<string> +

        +
        • +
      +
      • +
    +
    • +
  • +
    + Fulfilled: ((__namedParameters) + => Promise<string | false>) +
    +
      +
    • +
        +
      • + (__namedParameters): Promise<string + | false> +
        • +
      • +
        +

        + Parameters +

        +
          +
        • + __namedParameters: + Type +
          • +
        +
        +

        + Returns + Promise<string + | false> +

        +
        • +
      +
      • +
    +
    • +
  • +
    + Passed: ((On) + => Promise<true>) +
    +
    +

    + biome-ignore + lint/complexity/useSimplifiedLogicExpression: +

    +
    +
    +
      +
    • +
        +
      • + (On): Promise<true> +
        • +
      • +
        +

        + Parameters +

        +
          +
        • + On: + Type +
          • +
        +
        +

        + Returns + Promise<true> +

        +
        • +
      +
      • +
    +
    • +
  • +
    + Read: ((__namedParameters) + => Promise<string>) +
    +
      +
    • +
        +
      • + (__namedParameters): Promise<string> +
        • +
      • +
        +

        + Parameters +

        +
          +
        • + __namedParameters: + Type +
          • +
        +
        +

        + Returns + Promise<string> +

        +
        • +
      +
      • +
    +
    • +
  • +
    + Wrote: ((__namedParameters) + => Promise<Type>) +
    +
      +
    • +
        +
      • + (__namedParameters): Promise<Type> +
        • +
      • +
        +

        + Parameters +

        +
          +
        • + __namedParameters: + Type +
          • +
        +
        +

        + Returns + Promise<Type> +

        +
        • +
      +
      • +
    +
    • +
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/variables/File.Cache.html b/Documentation/variables/File.Cache.html index 9c126473..0ef8c230 100644 --- a/Documentation/variables/File.Cache.html +++ b/Documentation/variables/File.Cache.html @@ -1 +1,321 @@ -Cache | @playform/pipe - v0.0.2

Variable Cache

Cache: {
    Folder: string;
    Search: string;
}

Type declaration

  • Folder: string
  • Search: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Cache | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Variable Cache

+
+
+ Cache: + {
    Folder: string;
    Search: string;
} +
+
+

Type declaration

+
    +
  • +
    + Folder: string +
    +
    • +
  • +
    + Search: string +
    +
    • +
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/variables/File.Logger.html b/Documentation/variables/File.Logger.html index 9ac2e2d6..1a0fab6e 100644 --- a/Documentation/variables/File.Logger.html +++ b/Documentation/variables/File.Logger.html @@ -1 +1,289 @@ -Logger | @playform/pipe - v0.0.2

Variable Logger

Logger: 2

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Logger | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Variable Logger

+
+
+ Logger: + 2 +
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/variables/In._Path.html b/Documentation/variables/In._Path.html index 56865854..c57eb83d 100644 --- a/Documentation/variables/In._Path.html +++ b/Documentation/variables/In._Path.html @@ -1 +1,293 @@ -_Path | @playform/pipe - v0.0.2

Variable _Path

_Path: Type

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + _Path | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Variable _Path

+
+
+ _Path: + Type +
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/variables/Not.Filters.html b/Documentation/variables/Not.Filters.html index 8fdad8f6..a0acfd69 100644 --- a/Documentation/variables/Not.Filters.html +++ b/Documentation/variables/Not.Filters.html @@ -1 +1,301 @@ -Filters | @playform/pipe - v0.0.2

Variable FiltersConst

Filters: Set<unknown> = ...

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + Filters | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

+ Variable FiltersConst +

+
+
+ Filters: + Set<unknown> = ... +
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/Documentation/variables/Option.option.html b/Documentation/variables/Option.option.html index ff8b75a9..ccf03690 100644 --- a/Documentation/variables/Option.option.html +++ b/Documentation/variables/Option.option.html @@ -1,2 +1,1522 @@ -option | @playform/pipe - v0.0.2

Variable option

option: {
    Action: {
        Accomplished: ((__namedParameters) => Promise<string>);
        Changed: ((Plan) => Promise<Type>);
        Failed: ((__namedParameters) => Promise<string>);
        Fulfilled: ((__namedParameters) => Promise<string | false>);
        Passed: ((On) => Promise<true>);
        Read: ((__namedParameters) => Promise<string>);
        Wrote: ((__namedParameters) => Promise<Type>);
    };
    Cache: {
        Folder: string;
        Search: string;
    };
    Exclude: false;
    File: string;
    Logger: 2;
    Path: string;
}

Type declaration

  • Action: {
        Accomplished: ((__namedParameters) => Promise<string>);
        Changed: ((Plan) => Promise<Type>);
        Failed: ((__namedParameters) => Promise<string>);
        Fulfilled: ((__namedParameters) => Promise<string | false>);
        Passed: ((On) => Promise<true>);
        Read: ((__namedParameters) => Promise<string>);
        Wrote: ((__namedParameters) => Promise<Type>);
    }
  • Cache: {
        Folder: string;
        Search: string;
    }
    • Folder: string
    • Search: string
  • Exclude: false
  • File: string
  • Logger: 2
  • Path: string

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file + + + + + + + option | @playform/pipe - v0.0.2 + + + + + + + + + + + + +
+
+ +
+ + +
+
+
+
+
+
+ +

Variable option

+
+
+ option: + {
    Action: {
        Accomplished: ((__namedParameters) => Promise<string>);
        Changed: ((Plan) => Promise<Type>);
        Failed: ((__namedParameters) => Promise<string>);
        Fulfilled: ((__namedParameters) => Promise<string | false>);
        Passed: ((On) => Promise<true>);
        Read: ((__namedParameters) => Promise<string>);
        Wrote: ((__namedParameters) => Promise<Type>);
    };
    Cache: {
        Folder: string;
        Search: string;
    };
    Exclude: false;
    File: string;
    Logger: 2;
    Path: string;
} +
+
+

Type declaration

+
    +
  • +
    + Action: {
        Accomplished: ((__namedParameters) + => Promise<string>);
        Changed: ((Plan) + => Promise<Type>);
        Failed: ((__namedParameters) + => Promise<string>);
        Fulfilled: ((__namedParameters) + => Promise<string | false>);
        Passed: ((On) + => Promise<true>);
        Read: ((__namedParameters) + => Promise<string>);
        Wrote: ((__namedParameters) + => Promise<Type>);
    } +
    +
      +
    • +
      + Accomplished: ((__namedParameters) + => Promise<string>) +
      +
        +
      • +
          +
        • + (__namedParameters): Promise<string> +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + __namedParameters: + Type +
            • +
          +
          +

          + Returns + Promise<string> +

          +
          • +
        +
        • +
      +
      • +
    • +
      + Changed: ((Plan) + => Promise<Type>) +
      + +
      • +
    • +
      + Failed: ((__namedParameters) + => Promise<string>) +
      +
        +
      • +
          +
        • + (__namedParameters): Promise<string> +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + __namedParameters: + Type +
            • +
          +
          +

          + Returns + Promise<string> +

          +
          • +
        +
        • +
      +
      • +
    • +
      + Fulfilled: ((__namedParameters) + => Promise<string + | false>) +
      +
        +
      • +
          +
        • + (__namedParameters): Promise<string + | false> +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + __namedParameters: + Type +
            • +
          +
          +

          + Returns + Promise<string + | false> +

          +
          • +
        +
        • +
      +
      • +
    • +
      + Passed: ((On) + => Promise<true>) +
      +
      +

      + biome-ignore + lint/complexity/useSimplifiedLogicExpression: +

      +
      +
      +
        +
      • +
          +
        • + (On): Promise<true> +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + On: + Type +
            • +
          +
          +

          + Returns + Promise<true> +

          +
          • +
        +
        • +
      +
      • +
    • +
      + Read: ((__namedParameters) + => Promise<string>) +
      +
        +
      • +
          +
        • + (__namedParameters): Promise<string> +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + __namedParameters: + Type +
            • +
          +
          +

          + Returns + Promise<string> +

          +
          • +
        +
        • +
      +
      • +
    • +
      + Wrote: ((__namedParameters) + => Promise<Type>) +
      +
        +
      • +
          +
        • + (__namedParameters): Promise<Type> +
          • +
        • +
          +

          + Parameters +

          +
            +
          • + __namedParameters: + Type +
            • +
          +
          +

          + Returns + Promise<Type> +

          +
          • +
        +
        • +
      +
      • +
    +
    • +
  • +
    + Cache: {
        Folder: string;
        Search: string;
    } +
    +
      +
    • +
      + Folder: string +
      +
      • +
    • +
      + Search: string +
      +
      • +
    +
    • +
  • +
    + Exclude: false +
    +
    • +
  • +
    + File: string +
    +
    • +
  • +
    + Logger: 2 +
    +
    • +
  • +
    + Path: string +
    +
    • +
+
+ +
+
+
+
+
+ +

+ + Settings +

+ +
+
+

Member Visibility

+
+
    +
  • + +
    • +
  • + +
    • +
  • + +
    • +
  • + +
    • +
+
+
+
+

Theme

+ +
+
+
+
+
+
+ +
+
+
+
+

+ Generated using + TypeDoc +

+
+
+ + diff --git a/README.md b/README.md index 8447b006..a9f8aaa4 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ the pipe. Here's an example of how to use it in your Index.ts: ```ts await( - await(await new (await import("@playform/pipe")).default().In("./Input")).By( - "**/*.md" - ) + await( + await new (await import("@playform/pipe")).default().In("./Input") + ).By("**/*.md") ).Pipe({ // Append some content to all of the text files Wrote: (On) => (On.Buffer += "LICENSE [MIT]"), @@ -41,8 +41,8 @@ await( ### Default Callbacks -`Pipe` provides default callbacks for file processing. These callbacks can -be customized to suit your specific needs. Here are the default callbacks: +`Pipe` provides default callbacks for file processing. These callbacks can be +customized to suit your specific needs. Here are the default callbacks: ```ts await new (await import("@playform/pipe")).default().Pipe({ @@ -81,14 +81,16 @@ variable: **`Index.ts`** ```ts -await new (await import("@playform/pipe")).default().In(["./Input", "./Input2"]); +await new (await import("@playform/pipe")).default().In([ + "./Input", + "./Input2", +]); ``` ### Input-Output Mapping -`Pipe` will allow you to provide a map of paths for different input and -output directories, making it easy to control where files are read from and -written to: +`Pipe` will allow you to provide a map of paths for different input and output +directories, making it easy to control where files are read from and written to: **`Index.ts`** @@ -100,9 +102,9 @@ await new (await import("@playform/pipe")).default().In( ### File Filtering -You can filter files to exclude specific ones from your `Pipe`. Filters can -be an array of regular expressions or a single match. You can also use functions -to match on file names: +You can filter files to exclude specific ones from your `Pipe`. Filters can be +an array of regular expressions or a single match. You can also use functions to +match on file names: **`Index.ts`** diff --git a/Source/Class/File.ts b/Source/Class/Pipe.ts similarity index 84% rename from Source/Class/File.ts rename to Source/Class/Pipe.ts index 38644bd0..cf5e9725 100644 --- a/Source/Class/File.ts +++ b/Source/Class/Pipe.ts @@ -1,5 +1,5 @@ /** - * @module File + * @module Pipe * */ export default class implements Type { @@ -14,11 +14,9 @@ export default class implements Type { }; By = async (...[File]: Parameters) => { - this.Plan.Results = await (await import("../Function/By.js")).default( - File, - this.Plan.Paths, - this.Plan.Results, - ); + this.Plan.Results = await ( + await import("../Function/By.js") + ).default(File, this.Plan.Paths, this.Plan.Results); return this; }; @@ -26,17 +24,16 @@ export default class implements Type { Not = async (...[Exclude]: Parameters) => { this.Plan.Results = (await import("../Function/Not.js")).default( Exclude, - this.Plan.Results, + this.Plan.Results ); return this; }; Pipe = async (...[_Action]: Parameters) => { - this.Plan = await (await import("../Function/Pipe.js")).default( - this.Plan, - Merge(Action, _Action ?? {}), - ); + this.Plan = await ( + await import("../Function/Pipe.js") + ).default(this.Plan, Merge(Action, _Action ?? {})); return this; }; diff --git a/Source/Function/By.ts b/Source/Function/By.ts index fd0ab920..60d9123d 100644 --- a/Source/Function/By.ts +++ b/Source/Function/By.ts @@ -4,7 +4,9 @@ */ export default (async (...[File, Paths, Results]: Parameters) => { for (const [Input, Output] of Paths) { - for (const Result of await (await import("fast-glob")).default(File, { + for (const Result of await ( + await import("fast-glob") + ).default(File, { cwd: Input ?? (await import("process")).cwd(), onlyFiles: true, })) { diff --git a/Source/Function/Bytes.ts b/Source/Function/Bytes.ts index 8a9e48bd..fdd92fec 100644 --- a/Source/Function/Bytes.ts +++ b/Source/Function/Bytes.ts @@ -10,7 +10,7 @@ export default ((...[Bytes, Decimals = 2.0]: Parameters) => { const I = Math.floor(Math.log(Bytes) / Math.log(Kilobyte)); return `${Number.parseFloat( - (Bytes / Kilobyte ** I).toFixed(Decimals < 0 ? 0 : Decimals), + (Bytes / Kilobyte ** I).toFixed(Decimals < 0 ? 0 : Decimals) )} ${["Bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"][I]}`; }) satisfies Type as Type; diff --git a/Source/Function/In.ts b/Source/Function/In.ts index 4d33970c..31de3251 100644 --- a/Source/Function/In.ts +++ b/Source/Function/In.ts @@ -10,8 +10,8 @@ export default (async (...[Path, Paths]: Parameters) => { _URL instanceof URL ? (await import("url")).fileURLToPath(_URL) : _URL, - Path, - ), + Path + ) ); if (_Path instanceof Map) { diff --git a/Source/Interface/By.ts b/Source/Interface/By.ts index 64feb697..27560620 100644 --- a/Source/Interface/By.ts +++ b/Source/Interface/By.ts @@ -24,7 +24,7 @@ export default interface Interface { ( File: Pattern | Pattern[], Paths: Plan["Paths"], - Results: Plan["Results"], + Results: Plan["Results"] ): Promise; } diff --git a/Source/Variable/Option.ts b/Source/Variable/Option.ts index bdeefe03..89626214 100644 --- a/Source/Variable/Option.ts +++ b/Source/Variable/Option.ts @@ -22,7 +22,7 @@ export default { File > 0 ? `Successfully processed a total of ${File} ${ File === 1 ? "file" : "files" - }.` + }.` : false, Changed: async (Plan) => Plan, }, diff --git a/Target/Class/File.d.ts b/Target/Class/File.d.ts deleted file mode 100644 index 02d2ef9f..00000000 --- a/Target/Class/File.d.ts +++ /dev/null @@ -1,28 +0,0 @@ -/** - * @module File - * - */ -export default class implements Type { - In: (Path: import("@Type/Path.js").Type) => Promise; - By: (File: string | string[]) => Promise; - Not: (File: boolean | import("@Type/Exclude.js").Type | Set | import("@Type/Exclude.js").Type[] | undefined) => Promise; - Pipe: (Action?: import("@Interface/Action.js").default | undefined) => Promise; - Plan: Plan; - constructor(Cache?: Option["Cache"], Logger?: Option["Logger"]); -} -import type Type from "../Interface/Class.js"; -import type Option from "../Interface/Option.js"; -import type Plan from "../Interface/Plan.js"; -export declare const Cache: { - Search: string; - Folder: string; -}, Logger: 2, Action: { - Read: ({ Input }: import("@Interface/File.js").default) => Promise; - Wrote: ({ Buffer }: import("@Interface/File.js").default) => Promise; - Passed: (On: import("@Interface/File.js").default) => Promise; - Failed: ({ Input }: import("@Interface/File.js").default) => Promise; - Accomplished: ({ Input, Output }: import("@Interface/File.js").default) => Promise; - Fulfilled: ({ File }: Plan) => Promise; - Changed: (Plan: Plan) => Promise; -}; -export declare const Merge: import("@Interface/Merge.js").default; diff --git a/Target/Class/Pipe.d.ts b/Target/Class/Pipe.d.ts new file mode 100644 index 00000000..42697937 --- /dev/null +++ b/Target/Class/Pipe.d.ts @@ -0,0 +1,28 @@ +/** + * @module Pipe + * + */ +export default class implements Type { + In: (Path: import("../Type/Path.js").Type) => Promise; + By: (File: string | string[]) => Promise; + Not: (File: boolean | import("../Type/Exclude.js").Type | Set | import("../Type/Exclude.js").Type[] | undefined) => Promise; + Pipe: (Action?: import("../Interface/Action.js").default | undefined) => Promise; + Plan: Plan; + constructor(Cache?: Option["Cache"], Logger?: Option["Logger"]); +} +import type Type from "../Interface/Class.js"; +import type Option from "../Interface/Option.js"; +import type Plan from "../Interface/Plan.js"; +export declare const Cache: { + Search: string; + Folder: string; +}, Logger: 2, Action: { + Read: ({ Input }: import("../Interface/File.js").default) => Promise; + Wrote: ({ Buffer }: import("../Interface/File.js").default) => Promise; + Passed: (On: import("../Interface/File.js").default) => Promise; + Failed: ({ Input }: import("../Interface/File.js").default) => Promise; + Accomplished: ({ Input, Output }: import("../Interface/File.js").default) => Promise; + Fulfilled: ({ File }: Plan) => Promise; + Changed: (Plan: Plan) => Promise; +}; +export declare const Merge: import("../Interface/Merge.js").default; diff --git a/Target/Class/File.js b/Target/Class/Pipe.js similarity index 100% rename from Target/Class/File.js rename to Target/Class/Pipe.js diff --git a/Target/Function/In.d.ts b/Target/Function/In.d.ts index f3b833fe..43be29ec 100644 --- a/Target/Function/In.d.ts +++ b/Target/Function/In.d.ts @@ -6,5 +6,5 @@ declare const _default: Type; export default _default; import type Type from "../Interface/In.js"; import type Path from "../Type/Path.js"; -export declare const Apply: import("@Interface/Apply.js").default; +export declare const Apply: import("../Interface/Apply.js").default; export declare let _Path: Path; diff --git a/Target/Variable/Option.d.ts b/Target/Variable/Option.d.ts index ba01e884..714e29b6 100644 --- a/Target/Variable/Option.d.ts +++ b/Target/Variable/Option.d.ts @@ -10,13 +10,13 @@ declare const _default: { Path: string; Logger: 2; Action: { - Read: ({ Input }: import("@Interface/File.js").default) => Promise; - Wrote: ({ Buffer }: import("@Interface/File.js").default) => Promise; - Passed: (On: import("@Interface/File.js").default) => Promise; - Failed: ({ Input }: import("@Interface/File.js").default) => Promise; - Accomplished: ({ Input, Output }: import("@Interface/File.js").default) => Promise; - Fulfilled: ({ File }: import("@Interface/Plan.js").default) => Promise; - Changed: (Plan: import("@Interface/Plan.js").default) => Promise; + Read: ({ Input }: import("../Interface/File.js").default) => Promise; + Wrote: ({ Buffer }: import("../Interface/File.js").default) => Promise; + Passed: (On: import("../Interface/File.js").default) => Promise; + Failed: ({ Input }: import("../Interface/File.js").default) => Promise; + Accomplished: ({ Input, Output }: import("../Interface/File.js").default) => Promise; + Fulfilled: ({ File }: import("../Interface/Plan.js").default) => Promise; + Changed: (Plan: import("../Interface/Plan.js").default) => Promise; }; File: string; Exclude: false; diff --git a/package.json b/package.json index cf3241f9..09c38c0e 100644 --- a/package.json +++ b/package.json @@ -24,10 +24,9 @@ "url": "https://playform.cloud" }, "type": "module", - "main": "./Target/Class/File.js", - "types": "./Target/Class/File.d.ts", + "main": "./Target/Class/Pipe.js", + "types": "./Target/Class/Pipe.d.ts", "scripts": { - "Document": "Document 'Source/**/*.ts'", "prepublishOnly": "Build 'Source/**/*.ts'" }, "dependencies": { @@ -36,8 +35,7 @@ "fast-glob": "3.3.2" }, "devDependencies": { - "@playform/build": "0.0.2", - "@playform/document": "0.0.3" + "@playform/build": "0.0.4" }, "publishConfig": { "access": "public"