diff --git a/docs/assets/dmt/dmt-component-data.js b/docs/assets/dmt/dmt-component-data.js index b76d467d..aec4ed0d 100644 --- a/docs/assets/dmt/dmt-component-data.js +++ b/docs/assets/dmt/dmt-component-data.js @@ -1 +1 @@ -globalThis.dmtComponentDataBCMP = 'vX1Zc1zHlSba44lwzLx0zMTMw8QstGi3ZUngAlISpXZLArGIkAkSZoHShGMiEBdVF8AVC1XlWkhBT/4JMz1bzx42SRAAV+2W5CXC89ryU78ookO/pU/u68085xahB0kU63zny5sn15MnT34z808f7xSj1X5n0i1HK71O+d4fD7tV78Zopd3v/ccH/I+tcnizapf/+ZuZf3SvszteK8Y7n1fw8+j0SPxyulON2v1h59Sgt313XI275YNF8TcnFnaK8e3JsPvbnfF4MHr19Onx3mCn33t3dKrqK9hpS/FvXMXb1Xhnsmn03n+zGl+abJ64Vg76TO3Xs0qvlGz3dzXF7NbN8Xi2W23qv7GIPnGJeoNdi+XK2uqJtaJ9o9guOct5xXLr1q1TIArFZ0QDIXL6DYfx9HDSG1e75eNdXqsrI6np/z/sFTdFTbPK/eNj+N9quxhX/R6veKjf79wZl++ND05KDQftnarbGZa9v1E/3W33u/2h/vv/9M3MP+Z/v8//vnNnAF/29TOCeHR6Q+rZ4L+Kf3dO7Yx3u3duVL3Od+62u8Vo9HczM1rh38/8S6Xy3qA72a56I6HzuaTODSmb1A1/1sVdsIr7Yy5ZW1whajT/7S/Tqu2amN2a9NqsguuUi//MnjXq30hrh3/KntT+fE67EMbqPtwux8v94W4xFupP5dRreXTph0Wv099Fll4IY3UfXC42ualk4aveuBxuFe1auyp5Q/DVn81kKNo7NAopT6D493vvkyiUPIFivrdnUfwYxo5a7UrUaP/TzImZjP5Loy5WvxKl6D8EUGERPJchELLEL7iJ/wIhSvyCm4QvkLK0L7hld4b0F0hR2hfc2sR/gZIlMUD3RDNoWRpDewfPoGQpDPtrfFYS6n+UUi8ESRa+to22sBIl1Q6A0LWjZUkMMHShGbQsjkEsVu50inGhf4Dljaw6WDoNhuVIrixOBisLBgNiIZRZrvxcaX04P9rrtRcc1WeDlYWr2oGgVxiPOWyxdD/jHIbLgNBsDyRwq1uMS0F1BkfFEWie+xz15qT3fjUQNKcxNAJA/JqVHvVrJALN8wFHXWdlc8hexJDZMGL9ART2G4T6EwBi2/t5NXAaBKrtGRCa7VAA9RfNongo33PgdtgXMgTkvnrEelynvL6+fEGu6DIMRp7GYX8FhoP4Hfccez+fJaDZ+WipR6slI4/fl9lDy3MZ/cRR5Z7Tx3O1Q+3Zd/l4ULdXdXVzUfxoGA5QudGw0dj0hKPWQGB9Z9ifbO8IrvMYLguFt7U9DOZsTRwBb8M4Jld0GcUgiO8B/pCa6wENRtNHgAlsMJfnaWKBO2bQfjbHQBqv3ZHuTMSH4GpXf8C7WB4oSAsmE1lJaBqGwRIddbxxO09jEPjveWRA5ovOE6go33SvYzfi0wgWLo7/mvsSYT7lLJaE8h3729ZsEXOEuQxCGv8VRwJgPiLfkA0CbYvKHtjztpDiBFtIBMUWFgTtlxyNh8vD/u51uTjIf4kGoKsKEOt9RRDz2gYETByr/q7VmPLKiW3p0GtK+eoht6R9QOjxPN8bhDShNwgApTcYBJbktrZAzPHsaifV/z2n9vPmJdb9HVPzL+R1k+r9wK31vGGpdf6R7Qm4OuC6BderMcd2vRdBYvFO7g8t54BD/AqS2IHieZ8IsM/6Mpa1CaeoZbkmb1TLLhbPLLwB6+Vwt+oVm10507yEZDU4PKPlV3G+9AKS00ZSW5PYKDRqTQ6UWr+wBHdIsfVrcHhG4cUE5MDY8zyej6OovYVtABr1FguI53wUG45ezDM2HYmOlhlsaThUfu6zeS4DIVguMtghLNdwnPtI4FrjYVnsUsecCBbPfD8YXOcQjE2+8VFsSEW0lKaj6ccSGKnUv0SzNqxV4QkSzkfZTs/lOW0QnuszG7YAxRwPJ+2x6h6v0WgtPL4Eh1zDcqVGuDNIToYg9EiNAdv00T3SQVEt6LQarAXJreWAwwaljEM5jeQBAK32/IkBV3tNZoWPBK7ZeBbBEr4Tps358XhYbU7GJf47HRShlQBupTeYjE3jR7QSG0SY+fyFC2Lma7JmOXCXK4jWSF+p3A8WKYhZp9H6RJx5sQlLbigRx9MnDUacjL+ROXu/Y/Q/i9FPUb1tTlkwqpn47Fmk8gMmbXasL2AJOARH8SmvS74CWxwWVe8SRKF11Zx4wYtRiCxKAyQlJuIzo0IMJw77K0h2B0qhF7sr1TusISJPbIMolA95iReKbncTolRlD07SOQAK1Yd19Xo+z9e4SuVCebXc3SyHDuuLSdYIjEQLBa5625GPTdNGYCRr8nmeYk0HQKF6rNdJ8A+MxHKKyZMZCIVOHGEyrFObczi+BlXJZmqvG55KkjXtgY/MbnMBVtSyS9wshhXThtijMpQhPJEMydrf4gHD+qf/ol3Mm8WofOl8ck4S2A0hmYnL+hd6PirGfRUQU+fgdBUzAPqwkAmv9bt7W1W3K70XeBYFRPuCN8f9gvQtDID+Fibc6FtsIOVbJtRvmQTa4RAV2mMb2mInenLBjjFVo649nXJ5BAQfkc9jUUgMAoI+4BHi16+tZM5uYySAQh8Ui+sCFycwOOp7F68gyRwousUJmJh0SC3OBmLZngjQdVi4X5gfDos96VuhMBowula32Emkx4msVReKP/cdvV10K7k5rw0qcKkkBm25cd//JqTlbCB6rJhQx3AGoI4Vup9dljWHnYVOGiBuj3HEDHvRmvDOoaksJHLLNO7bTGfRTBqH49l3WOqWDy6PgOTXDrJdv710rbVy9Yq0Do5CYgKOTFu4d7McjqCVZVZDLpfE2Aew6S+6++6o33tRRpMlDcMFk0uev9ZK32pdvSKV1js2Hb0cQTi2EeNutbXnnkvFlqcOj4+jLFPv7Y622X1HGQeZrC0pmlki/vOaoLJ0v5e6cfcD9PL2iYx7mYcppGc+YykzmgVkvhr0SbwPvKi66qVpiwCa0HMhkwegE+m4QC2AqwTL/YEL09+/PB094eshhto6Xqm5G+K14OBwJReJLCKjSRwSgo9HZveJJUPNHQOPgQPwNxm4uPBBJG9NxFgEDF9fog2T6ktC0BzgFOEA+4tepjARv+lB0ekssdWqmcAu4Br5KRuJjgJsd8ti2OpPhm3Zo3MrQcVmAdG7LXs/l1vaKp4pNnRYCtqODnSrGaA21M0joAz2DyBWu9dZ7vaL8bk5WgOwkYToQPM92AoTGPTEIcRXJ7C9HCh32KskKoVFj9bIk0ePjB7js3z56vz6ubmNq2vrsFBtyS5U9ia7GSoPaCi/lyT89cJZ6U7MrGoVzwJ6PftlNboC+SRulvPtdgn+Tp5bYomHeMnd6JtIzoQi9HZh0oMUG6ojpxeMUhS3wH6yPSwGO+VuuQJNAtx4cvL4SaY5Kg4fjW2QDxWwNehWMkVDzo/gc3JonlD6akVghf5J5we52y7aOyY5iE4CcviLSdW+MdsdSr9ezV5TqN3gSjY4ZAMguLo/+BmTv3ztuhwC4tNoDYPC4lcHblhabH9TQ0Xa4MjbypAHZyes1LuFcbHUnHfKMjD8BpdO1uV/M5f4AWA5cF5KVqalXePwSyANuT6upG85bbsYHcPib6pCdhJwaU1KdhPgp6X8xtfqOkxI6+HRXkZdXDeCK9F4Yt/aYId8W39l9KAoJHO+CnFhH+SXq7LbUXMimkWgKJ1hfwRLw3akO9wBF4Ic0msiI2QJhIINJp7sDv9bd7RfTMqhrMAaf1yoGro8gHBj1+N1ALQ49meGaiHZDUIqTwm6P3zqAZ3WeSlhymwRGjTVI6NCrk+xtWCRU665QgGvlZ1JW+2M04OPzWdj0YwfrphiOrwLtevICHWoBL+sNINBehb2u8lJhsN5fP3x4GUykUTj6OID+l/RSH0dSB86M8QVcziO6y28qTIUKQTH2NzpoX9F4HTgFPJPgga3CDSiAPPkAlgqKIX4ItBwrRyVY1OS5aYl0XoaFqc12Ry1IeTSDQGhF8fXQ1olwrLeTIvav3y43Z2FX4bVe6JQPwi6BcNtbHfZf0EK6xq/s1qMpQshTD3gqWSieCcik5abwvCGfkQzPgMfK/M5fJnPkRRLrzFGseUYzin+2UQl3csqZqL4WmbS0n7ZWuay+DK/XbaxLYOJkhRjzcdESYqx5mOiaMWPhGeidat6/33oc9JnHdlpeCQuDH1rk/WGy9UNlW3EG34iXYcJkxb6vL8ZihfyFFyalL+M9TzKV3BhKsN5CgMXJtUT7zHoetLSpK9gKPRXKGESA+udaAYlTGXA21oJUxnwtlbCFAbIdQAL90HfnFv+RXyKteSSk6xOR3cHVgCJ3ACBUiaOPvZdMcBlqVuuJ2MbkYArAifc84qgrxS7svp+ErNRhpuhSTEDg529UdWWI3KYlphzSpmksbT74cn6W623y26/XY331of61CNMgOao9kH4KWui3GV/iBee/Y6LQDiCEW7nmpV/t2Y9wDUaWfxSA37cVZmR6toxV84F0bNdp9xe718r1FIxqVnJopUPi856f7GUsYdp5UoW7T4XOanDNnRvt+hBOm65fQhX6gIHzFwqad3/p7+kvFn2xpsT2dRD15irdEOJJ7X/T21bkFTrmtA1VqN6g4NwY6BX/Ncip0RplvB70odDj4S6JYd2kUzrasGSP4Are2OX+iKZ2taBJT5wSUOHf10rCYlyDn+FWBv231OBtmQ6DiYswyWsVbYnQzXNkEkFGs16yHHGO+Hfr0nSUZ0RwoCrhRxnfUdUkgtQpPsnHOQm2aDQNXA/PbaBVydyR+yfnGBYAUy6AqNsz/+rLv5SeDWW5Otzm9zVzXfjvj5ciwU4iVzknF7p3ezfKLkm3KAgc1VbOHRX+ciGtiaDQX8oSUP3f4JUIvFjkQCv2rNumPYwSigx+JOGctQuBuV6MQRHs5wvI4sKj8sGoaMBZMA+5D/YquT6JXYxxKNyUFiu34jKkPUeZGx4I7aViFZnqIGQ+cdRsbI7kMfI0RQ8KXYGJSTlYEM0DCdChRPL4scDeKQxIKWDfuQqsEYmP9A6SUweldwvvlbu9m82+WIJJE05Amk3af/yaNSwfmtGnD8KoJm1ZzE81Nn6sWUCQ+VfGY1SNVodfOwMWsnYldRo1yB25WDEpiDY3tq7HbkNancr+JZItBDsLgcA2pLLw9PBxkIp3RAqNjQAd95+uHh1dc0iiF30qqfQYOwoGdARvkdD7bsj3034IT4YFb1qXL1fvgPPTr1ddUqZX+Zqs28E2kAhPkzsZgm3qe1do/yh4CUJd3v3gAr21cpZF9YTV7gh4BtSOGnz/xpXHfPBx5UHJJmMlew2QH9kko7E4mvjTAaJfzUJbnbrZGxoIoFCR3EL8eV+W+0OY7GFKSYORS9fxv3t7W65WI6LqqtCpNCEDhhLeVt7vsKrVi6N4/aKtLb/rptB0b1V7I0udicqk0T2E5hug0LHPxdQw3ut9rDf7Y77cveXb3OczEGim4OAjfeS51l1bByGdsIVcFnTVGEsgDzCIzHowbka8fapVjKxVXnIokFoO8ENIRhDr26yZ/100hgUl4ucjhDRvl0cdtq5PxlAeANkX4Fo1/rrUwg2Sw/hErAKHQ3zQ7iUWa+4XiM87Oz1it2qPW8djeTtJZzNNhL7ER8v2qhkhGiEMgYmnYc4s2PoeVaUiBlXN4mHUtreoKSGQXfC9bcniFGpgku72lb1LcFIZmJd/pmeZ7vldtGuX40GijcEAOfi/kQE+2wWw9G8/xVLgTeiniyqBu2g+NzA2dONQUlWGpXEU4UuzSctrjxaEkqdRNWgS/GBgAclCGNEI20rwOIdx3AquFgV3b7c6oYuqQidxqBpnlhla4115/9JzG0SIfTReM/JwzfLsagds/eNOmsirA6UkLFVgK6VbNC8qa6JITldLOE7tU3o3+lACU4p3yqGuW4WSZiU7NZYhUuCkDcB9LR2SpUqyHdKRYg9HImzBc5C1s2SGQdiVnVxpFMBjr2+4ub/RVJqGIXxN8Fo4nC/juCuUUByjvm91k+qVstLbUkfun3O6j9YRhtKcq7qnndxMh73LU+gf+yT6rUGS4uyVnh4jLvoOib2o2JS7Daaws9iWISGpIswRd2A9QsNhhAYuGAetG4/wDzFH6igOCsPuQumF3VK3oH34HN+KQ2HP9kHxakICmcWNoNmeDod5/DR+BXW0u5gvBcnn0eSR1XgD/3AaHH+15H8EQX4AzkA8z38O3ADtu6ssZZWI0l8b7Lf14qecg3i+TSy2erOVO1ryLbrozN+AL2Z2bd3ewvxjpunop9N3YWIkIEKmWlKy3WQWFvdvvrYxqxcB2maSHTdBaR9oyoaGdm/IUjjm87Sb07FPZW5p6Mm27x+sJxHWjyioJG9/VtNFLbprL00BfNUtp6GmGzpyMT0Kt7EGtnItjX7iDTNdEZ9rQnlVNZsxNjIjN58TzCjRh6vGW2ab8mMNuW3Y0abkWzG/bIY6RS0J+sMKIRwyTUeQizXEpdnlxeyh05StQNCnwEZiHFehkkMw4846QFFXeUuQ3/oosyNDj8a1SUMUbTQUA6/Vm6V8INKNFbjmHAYNYTkAhEqjOnOROKzXTaDwEZjS5LL1UiGCmJJGAJLcmd7pOaX79c1CSaCy5Eh7zRkzl6YPhlhhDtDurvZ76mwg1MIrRtcPqnbeTEMkOzl/v5IZQ6p25LxmrDE8TGmnWGxvc1sx9D1ycBtHgeCTmMJQwST98eWxPE8Jwtg6OgT+2g0afJT/lFoZCbT15E+hydSzNdLLw73nMrFWMKDbpPVqqGEeEZ0JL3puQKQfKAMt9Irh+OqcN+WzHOHUJIfkMHXb5Wl64er8QP6vDaQdAbt9MQwLZtNF/TC1NrogJXK+HHPJD5D6VUI2oMuAFrrRxyYqcZiM3pg0rzEa96KLveDSes4/eByxFMusREtaS0HgI0oudd3qpAyZAKFBGPHsk/dIdBdvtQcJukpYboFDG820UWM/7hSnLfRMsaa/J+tX1uI+cGZgzKX55iwPwHF8rH7BLHZB01l1kl4KspKaR+28gMVQlW7BxBCyFuNcOUXblu8r57vqW/cUquSR4ehwp3Uqn+x/54K0otlk3UpDAIdqjmCDJxt9yZYYicjeRwQNpT47ojN3OFmyoRuhpfuJS1HZiM3jWkg+ZO12gjTWAdqFQC9JDy6Ue5BGs5bxTAfc2hoDAhrn8eqZG7C2vioEn5Pg1noztbNseyKtaG0gogJIg3SATfMrr6FdiavF75CIJIEf6N3Aezw0OGoPXyLcVho/OGbBVqA+FvoEHolvdyQ3OjB51NfgkfkOh0IvFiTLwi9nlhcx/gtBfhl9W/YFNkx5fZujV0mlqFOG75Av41Wo9NrfprqNQibNOhMXz8T1XSdB8g6hfvZlIVzVJK2KJY6zJF9pkRNAmMseKRmak5pMuVoXB9w22kMz1xtq0kXMVYpBC5a4DHzZ0J7bzk8byCGDM3jaSAd11+GgJqQfpFI72vBB0ZeX4H+PYYbC4I4mqomwa3h+KHhvlXQZBhQjM/CklyaFs5sW2v83RlecuCVhSX26Bh9wx6tWsYCPG9B7tF2U4sqalyaCbDswp16M1k3LI2tiFKa39cpWe539dsuq9OXSaijlOwDS9X1FdNq32hUGKGBwn+4zRqdiWI+V78TtBagGoTdCh6A34S7aDKRYIJDCWfuGfy5vRJVPqC612DiBBYQ75nmV7JcvoSbxWN0wOjLVtpNU/8eTJxOA9FPnczzeySA1Yvbv8xOF5rOBhMyEWjYm/BcykATR/MgZIiVBsLja8oavEUTlvSa3FeA537A4y7Z2xJNatsGEzh5wgr2UEYTThuM53TOPGpPUn2b5k8/9LWzT/SpQXjy8VNCM/KOIJqdfzzx8YilQK4IpBiKsA/XxlAkOnDG46wX1x/wPsdmHved8qvNxg2gDRQSzp44lj9Mst53y3NtuvJ4OvFF+r0Ft8543ML9h6dRuIh2fDE/54rqS/jOdCWcrnCPoxZdbVykxsY0fUtnzK8Jc0sXwFZDSknCK1OV2xlfkgvYpG08daQFbNDyRGHealKYQBftRhPcfWaDXPIhDlQ5PE20+LWgKhq1j6a1cMc6sEWO+e6eIRVjwNwoarFjeKJPcCSoPCX4vsduvNjIwAV6ZbqSNHKCfuwpgeceh7JiLk1XHK4JX5DPPPi1EjL96kubNeHHiGIoPaTwv9beaFzKIybsek9gcC3xSAiz967JewXJYzTg6/gTAwoaH2GZGZSgUcu7t9IDdYV6/YtWyxKLW10/lNK2VemfqygdZYTjDwcXVP/bT6c8jSxxqHdF8iCMZguNxlnjsZa37UFYbQe0nkLCiOwhA6v8/OmVqpFl2NVMNZitsxGQZiAfnTTQ/zJp9yTGeGzyh3P1nLY2/JezcweFfAeylZmytKYoS0Qp4VBALf9188DNSkEpLD2k++cWbl7dA1qZugigihRyJqGQkoGyPqwrAahpwg4u46fBDmpIMXBKCd92UFbotb2Ca6IlkZRIZ/rE7VdqSxFMp4jWqLBrBfwgrdGwNbqqSAdXCqpHW9JusrYkRh1t3cjUk/xlQQmECtqeLfDCYldTNjLjL9Nr14caZPZQhNWUR+koI6ymHNw0q6lUeRrN2Z9pFVeHFVxOcGev69OXzFVLcEJ5GkjjV7IspNYa+u+xrdVGZlqrTgB6X4OWVUqrZqcFQGipIizhROLji3uu7w83UnoF8FWRxmupy/F9JA+yM9UQ+D8Q86fWVP96I80S5FxFGilWAJQ+UFcGoYl0bO0fiCI7gIY1i6afp5+70mPq7w3t922fS3+ZlM2clP8bPXbwF6Rn+5vvQsACquokgXh6ekMAk2z/w2TS4M9uc4R1GncpfTQf5fM1oc/qP14YTjrxclxuUI6YNnxmEQFagkgqO1K6SX34mtBl+NQvPSwYi13Zui+nOjHKLkIbpSN/YqkQ4YPWmmia8hhllOJ8zpxxlhbfWFfJRapVSIpfijU8XtnWVfJ1ctnSWikF/KJWlSzc2tMrHG1pz9QsViMohHoZvSbhTKYoSgdproT0svwTMi+lR0d0D4vv4h5wsRyC817emKjNUJXklirwEVKAh8eRnK+uTdoUMBskfph3YM4X1+bESvBSv/cJoCX0knXlKXyeq47aAaNpP1xhduoUA1iNL1egWG3d82chijvUQNgNWeCWfngoH1sc4WZwwokbR1rt0/gTL9LYPR34IjxicNlM9C4slQE2JDdoPC23uAQ6vYtmcVcDnv7TEGyqfnGKIjSo/JVep3yvNFtgWuUbNLHyzSBhvpxW+a4GQuCJarD1L+Mlx3LqUojxsQvP4FFUG38sn4aRHJGsVUAZeWFF3HnyFnjA6oFJQTUSLlulze4/HZdid+Ckbb1UIMbg5O3pKLHAURjvS+SlvroDnLzf6PExFIWNTZAMB23frtuahAxRSg0luWwkGJOOIcraIABH1ayZEik1686EODZhfdVJsWwKRe2jcugU+ytFiu2jHph0cCXGTjP61Vzzj63ryAmFASZNHwxHyftEFm2Ip5TgM6MhMiglb4eEZWg8Ln1kdHhdtyatcl0JGvXe+7fKzVmmEd5QE6y1qYwEL8jzP4F80kWlD+rv7Y62B9qj/BJa+4bE4R4K5zcAWSICtocF9MWF1TV56JjeIcQYI7rQGwZ2fbpVjkZgkaAoGXdYTVFCbejCPOa5GcRhnSnGpdz9o1hBPE3YS0kfwOeq0ttleKtJGQJd2FKwmErbonKUQZvDbxFoA4irZ7b9ULdiPWpXA95FANB3yk2HOJM+wCM2aDTpI67ozRISPJlYrddzPn2b11WAzicoC+o4JpJTps3pgslvPAAUcvp3zFlJcuiOECs0aUErsfZxfvICcISXfo6vvtc9MKZ+b3gujJiqrCFIshIGEXsAww4bkETGGnDqX/mvb8o2Hsv65JasnFm452ra8rnMzClBGxKUnDZNws8BeKEhFZvtf1/IdlafylGCzgCj1Dg9dolM7qlB08O9FrgM0HXbcTIcJqD2VJAOVyGoC85mJ6pZpUcqn1iDG8f9+K/iZ/jo4T4CYn9iclFfQ0n/yiOI55evbAja2mQ/RhD3Suv+sG/ucCdyVll6BQLbJI+E+HLRyT+bGpAwFPqq8wiCAiyeRI4ni0eDsDT3x3194UY6t1BEFgxL9aF5W8XNKFzTzi22EEm6CmTed6zNVJt92FHnk2K7GPFEkHgd/LpW/mLduo0rj8BIq0QBNmy1mcVcNhIPW4PbhYw/lZ74KlK+TkjVsLcrkxX+LjCM/BWbi9cY+YtAVda4Og2x+47lM1FNqFcsdXP5sAf/0n1lGc5tE7kLHPUhEL3OhsN2eMzT7dfnY955h9BFESLsXaCVRcP3wSXovDQaiFzuxWhPpYg8UWMoJpE0k45veiSeqO/Aif9upe5ShV3MUusC0F3s3uawfwteq022MCmTLPr/0VPS/Nmze/Z5a5iE2lFqxPHjwkWBbU0GA3DMysVC+K6kw+Nh8GQL3Wqw2YdEhfNtaKw4Mg+DdwVdcx4QFkatPap3KKNINPERf8saAjnqU4c7bEacNpozmPNVmYr0MPhDeMgCDH24DaLbLEsWG5LT45xiDIHoxQtsapi1L62vXq5f8jlkFgK/EhvDO/TjQqUri2VbdTi0PHpl5DYl62AzPTyEMFzg/SMBdFdhfjhQjsnVQdp3KG0m+NJ35OPIhQbSAacNhHvFJZzDyF2tH7pLKYLS1KAW7JzbzWqBnoH7MZsC+Os0rf5kqNJF+3nNg0nDQpAOPTmObRyXuqVJkuo/seHQ+RCi9ysyDCW/rnb8QXj4un3Ybg1nRU8VXOFjBpxNSG6IH3GrR3gRlwlfBuTScKhctTUTk6vfQ6IH8gcGqKaMcGOT5KMsLGwU9KX4kX+GDXAkH4sd9R1uCDkZIr7772f+rZ7LO2U5WB6WZSoht63XyOMznwFktYSeLlcLCAYujk7G3SkH4x3YaMPgopYksXdGXBILgnbqwWAlFmn9ocm8HnNv2FQeCL1C2ClGCifX9BkiC4C2DWDg9qmOWMnZRotjCR4AAvYZ4z7rF5mFjuHQCMp3sAyKhO8Q4mjTV6N5tndaAYzx5+ZM74HQnrpq5PLkOqWRx1IcVCN7EfNClsBfsGS6ZDVa6xZVz+bIdUkHgiW6e6MLt+oFwY8zBFwUbQMBgtROubWz1G7kiRSt5GMIIQWTR1OMiq3S3ovmKIw8uoczyEUWV6/vo+d6uI3Ab2UAtPSLibrsnevhWhx9Z4sh9Cc8j1BPKD23A8jrlAUYOwh5dI++Ke7iybaU69FKGt2jFYBHQ+F6tAMhE/F7NjQiDsESfeygrg6tD7tA4ZNIdEN+q3X1isV1qta5Kcm0PN6tecQw9th7GkPij7zZlDkMxI/Q5PgbW/ta+rko6RRzbVjtwtmJSoCVItCipP1dS3Szq+BRtPzN0Q2X5PERTS7eAsxq3P4Zhc3mAUhOZn7ymXQycwncST6sf1QQiXWWP1fXT4RmD4PtIU+qEY8u9chqF1uKzAURVnbqhJ3yZQ4GPbZxtHsJvnayFEwOAu2VG002R+1htVkuV8PRGJwtchyInZDaZAEMPZhq6Mp2D1RxBRkvqsdpAdFz9qVitKOfJ3gmutc/JWXwxxwtcILqFx5qlEoZtNL9dRieVEG/H9cpRPChcLGjshfqBvrGR2S1Hl7pN/J5nqpn1w84q2N4qh5d/1A/TfpUPbkxN+q35MGlfTXdc1t/1PpCjLnxEat4Ne3w5Ghc9DpwqhZJh8IS+Mu36v2zTIXasGRy79MIxv0OJI/qb4fns94rXiaVZoxrQ2jBveNl0nfbbxtZIf7meRoUV6CFFIisoIvwyt30BRBamhWAa526APynRgVYgTdG1c2h5gUQWtAFYEls9WtStyC8GWY9mZ7tzcZl0IpIFxTEGyqiCYl7Qn6eDGw5Qk2kI2QBtxvkxYZFIDZHQ770nmkLTcmFjgbkIlfSdORCB/4w3QDhkTUr9nWpKb9Sg2+Cy2+vr8PduHINUpFD67HfzTLnT9GRPorEfzuDtyCMcbNwWc0pVC2rC8MvAqGe5NHfatmbSHdJms6FoKm+dCtHxMg41zJVmD6iah00ZRlh1/F8pxPeJczVsATRjoEN3PZKIRnJW3fegCVYdD/zmeqAMUdqcBTmTx0Ngy7sIwy1unWbp9ZAErfbLuFEw0qumOSOA0mepjZ7F7ynF2nGYaIJtUTmaHU+8iLsDxPq8u/B6udaWSwt60IXJ+OxWrqeC/u6p9oBkdYzDLbS7vdsPvMsV4bPAMmcrW5/3IjTAEmT5WoJsw9vQcr+kQE7ZLRhpHho34YmVgplw0ziOx2Bsb90ExR4V7ewDAJLcjhaiaxUWgAsGzlb1V1m6oZkHEohq+sLr2DtZoCNbKeutlBYprOfSplBYZzKhk0IG9vRH1/QdjTA47Sjw/Kt2NFh/Dbs6BCS7Rgfs00WTOSY3ciGwRo3yzGdBdXNPTzfVPaj05Gtdwg67N73XGKuZXwNJnR437s/7NgkZzIkNqIBldjUUKgEAk3F3k2ygS2IXOvwv1CGI7BaYPpGszde6lTqWDlLqgGkBZI/0Z7K8DRYayoa+/lgDI3/PnCG5oDBeoOJrLAf5xiYKFo5exmFIxZ2yvaNzf57tdv/kERBSA2AI69MdjdVjeUagAXAR/Eq3LqOgDYXTBI0TBx/yMcHMuUweTajn+QnsR/xku6cy8VeeDMnThVDkmwEw/+oXK1MyHXORhaA5OVrtaF8XVZOiNpTn5fajvILOi4ITcgmjRb4YNUZXW7SELK0+0byBW4zvOVGchvRiKp1q5AueiwVQ5D208wn02JXq602aO5R1ZA5GNKQ6i+tc0Nqgx07Gx8Y7HKxWapgQAQLFycNrRplbi7nhlYHQvuim9v2VJT9IiWOJjkC1DpcTF5dWJIhjhkKKYwmYLfL1/vb2+E++XyOyUORxjsBthpDbryzAISmLSrDvquabtq2PGmUsyvuhZQbUss22scEzuu44uk2LyqQLkMy1Y4FydFokxnuIyKn97X7iEZ2CRzdKfXTWSc4SkhRTWUjEtMUlrK3YThLCcSxWUqrP35Laapjt5RmIlsquok8mzWUBjSyU+6TbO3TmUklV8YwTWUlChHZSLENuHmHOrcBb2Si9Pc8Rb+2yuqBIJrKQASexvaxl4sY+wj5Y7KPVn7c9tFEx2wfzUO2j+fyeT5nGibayCrplY/SO51B1OWENMdUtsBRkM1Q4xwzeQ4RzrFGZlGBtDj905knvQbxuaYyE42q0dIgcC/mlgYW4BiWBq7241wauEzHuDRwichGirhmT2NMxMQbGSgzTlu6pzNPEDxWyzOVcfA0ZNO4Dm3z5GC9Q7uRQdKDtVQ7nS1OYSimMgOKgWyBtN/fvO+K9/s3stDryY+roZnOYvVxDQnKqSzYiLHRnBQcp+TmJAtwDHOSq/045ySX6RjnJJeIbKTao6hUVF3kKOopR9XFGY4rqi7OdkxRdXGyRnEg9pFeztktZI/B2a0VH6ezW5Mco7NbczRyoYbnnzkXqo04Bheqp/44Xage1TG6UD2mqSxljo+xlmKIY7SUVP9tWEpSfQuWkkyNok1jp+/nc7ZyMI2slRm7fYLp7JX2dwRkU1mMyNXIt+qHMOR8q1MGBacXR08xFji9l356IcAEnkYOCC/2I+eA0OLH4ICwdR+nA8LmOUYHhE3TzDRuEEvWNEr8OExj6T5W01g8x2kai4ZsmiD0x6TuSIb+NDLLXPI7jObpjJJe0RuWqUyCJSEbpD5UyjxgiAuVamSi+iD/GorpbJXeJEfopjIama2RWyiIOsu5hSzAMbiFXO3H6RZymY7RLeQS0Vdya6tsi9WH5AnwGo+baCZC6EhTeFjaDTsshv8ZM6IHIArr54ECqRm1To4jKfzirrbR4qQByEWnBDAKM8svYgW4OMTpFUGIou4MZCoQfSk90Z4caeqxtUA6n5Y+d3EA1D2qiXYwX5YJLXAQFL778nzFMD2XPYuhcojbgX4CgfyZT5O8Aaw1Wv5rQmsMUdT+57lgrac3KJ5b6hezFiNXPs7XpluMi6DwmSwKX4YzbDZ1gp5L77P8FG9DLiPzcF8Yvs3VWYLouO37y1CdzlM1tdqNID74fLk/6XWG8P4lPG4jqztykUzqt0Tx5Ye3ZUblrnXKFcmIZskk6/yv9ZH0oDvZrlQDiRxJWxo3pCxOM9vQQKZteJJcTTlhdcSUGxjpbsZaMYL0U9dXFmvTUdSQaSA+T+TaKuT9kmvKiJFtIwhRtGorIexvQ1vkc8Hq/HlsKlzfgcdNrHypkftYQqMjiy7rp+/0h92O9MDy5Md2Itg6rjgIT+qUVS+MavaCkc/TEPJe0FJhHi8MpqwoJfXtQrZgNfj0IiNC2GAI3xevLnKOj1TLE3+XyaXzr7SKwiQF1Y8kysccxU+4gWN/3kou+gMrV6qrS0gZlbkcqQ8E4Fo5ngyl8ucyyoUsnsJ53lFPhUoz5VnHO1vw4Jwc5U1qXk8TkzHqMhmUdZpOp/VGKkAq9+TxlXC0DMWCl+SKXTUN1pMYUbz+/RKyjsosvX4zEz9lGuy/05pYuuYV2RZOBtUslQkhdOZ4IX5VRRb/RVotyKHzKDOE1vuDlF6C1oNNWIy0S1ULP6xVK8Wweu8rgC7xsznVhFIfCgyilpUcVvN+uxq2s21CCKFLK8TzpdVy6DbBEPk2IaXwWiebla6Eeq1CCqv1SMrr4v4oo5jSijlEa65txUoMbbkSfhybuqi1nJbDan6gEbrU1tM4NcoJJT+SoHxtG0F0Hykh12m2jwghfE1z8Xwf0XLo1swQ+T4ipdB10IWNeSE3YrV1IITQOuEpnE62XoUQul6FeL5etRy6XhkiX69SiqJ1OM6OPVIK3RukfL43GEH02MMh+bFHiRFqAhZOiJrgUoSa4PKYmlCChJoACKYmhBi6XwBKr1Bq+4UQwj9VxcXz/ULL4d+oAkS+X0gpdB3s9ms3V+In3Av0+6MBexSjri6lKiGE/uLxrbLsqecRwi+WSqUUujWpd2mkgcJdhNSr5AhbiJZVCfWKhZR9Epjd+wgI7L/l3ufZjHImiVf/RIBEknVDEtnFOSRGnrCVXbdt+qNaBilGqaRHEuO4New3UaIMgU8jR3N/pSefAFP+0h8I14mr3pIihWu01JM4ag0QU26ESFE613v6wR2p/Ycx7bYYRf890SCk6hNR1UKCdGpsXJefewNU3m/5f3XZ4MAKHgiT7S4coIQqKYQdSm6rB1T+UKPPeSYlMyzBOwfWsBSOdkKjkiKp7fe6Mm15Si2TQqu9JZ/ASqtVUg3H5sjwIPQqMcrwcKBe7croVmIU3eGY4HZbobnhkPABPIAzHIMDdnAFOtFWpTqYfBHPoQhESb5a7uQVA+fvo8rZz6QRR0D4439yQHYHS1uxkJpqsHwmpvxpjZWxkj+VofIPMcX0gfIIold64vKbMKE3WpqfM47MP9fe4s3uRE0UQQ+31DExvNMKTrFGW/AAuvSVpxRrWaz2O51hcQtRYiaG1mkKm9RJKeftrfoR2VaJH5HvjtqFXtOmdHI5vFYWUo/RyuTQm8WL0GBsV35klWbpNtL4Efnxgmo6Ns/ZJI8HISzPF6E54b/HSFNOP7xPSVMYaTzF4XJ3z2Z4Ps2ghAmzZIs1PZtiNklhiVNIWEskkBhxwoZpXSuwj73mkkw+hrCzWeJ7e/d5xOedWcPicYVJ0VMtrsw7/T6pjtzlsa0nhD5i/9gDrkP55Xpc5+CNU3DJkOeoUw6GJbwDU5qH/px1k6tl46wcxNNkG9a6Lxc6U2yBve1Xzr7vj5GnLBG0D3+z3II1gK03OKw9ZctgFX/S5o+p8RDhxWoEmts7anVjPXouGaLCWKpHsPWBB8zl0zxq7RdwuFLo+QNgEiP3mjHFUgKtdKcYZZQaCfRqp99bhJd0h30x2wf7xFP6d7RTrN9bhcNHUcbfRfTxX9EfPcrWpJFAL5jg2Ec8cPxFoI39hNXzpe6TUACopEkblsaOdycccE8lMITVg2rwDlvo0TvlyREYop0wwlDb//IrIFUT9lWC79uzhqks+q2BRxprXR9wfD5GO/mmwENn6A83SUY1+50UhAwbY2ce/Z2j1/oVo/Vxr7hZbfNwlstV78bom5k/+3IRHl87MXtiCaYYeNK26J4Q88uJpdbq16/ujMeD0aunT29X453J5imIk2VxVzv93rujWRbDOdsB9OlSYWdFsWbL0S48kbzFbvgD1U+hTN/M/Otfzd1bg6AMCCf91fnDK8VuCW2kXf7qwp2l3mT31+fmDt4uhhXzZPz6pfMH6qtun527cHeBfcrtuRdfOlxR7e32i2fn7ltd5s7ZM3PnD5jhyuF4787cmfMX9lfL8U6/c/fc3MsvXTjkSyZ4FnO4P/fS3Nnz5w/m29BqR/3hvbkzr7x89sW5Q2aa+W5VjO6dP/vK+XNnzh/CJ5RQce1SFfw7ptzf5cX+ni70CV3kN0R5//aXprTQ9u3CfvWdGV3Ur747Iwv61fdmTCm/+uWMLuGfZr47M2OKx81ryvanmTdmZvZHcL7a3oH3fQ+2Jt0uK+Uf73bhje7xP3kwEi/dSYPPPGIbdviWtWE5gLeYvz4Bz1iOZtljzpZZu9Xm6WJQzbLf/gE='; \ No newline at end of file +globalThis.dmtComponentDataBCMP = 'vX1Zk1zHlV6LliNkP03YYT84wmOIkEYUycZOEuTMkGz0QjSFBlqoBulQOKLjdtXt7iKq65ZqAdh60k8Yj7exPbZDQqMX7NxFUkvE+HWop3lhxAR/y5zc15t5zi00H0iCqPOdL2+eXE+ePPnNzL846rar/pVu/+bom5lnDkbl8Fa3Xf6Xb2b+2UFnZ7xajLc/ZwKj0/KX053uqF0NO6cG/a274+64Vz5YEH9zYn67GN+ZDHu/3R6PB6PXTp8e7w62q/57o1PdSsFOW4p/4yre6o63JxtG7/23uuPLk40T18tBxdR+Pav0Ssl2taMpZjdvjcezve6G/huL6BOXqD/YsViurq6cWC3aN4utkrNcUCy3b98+BaJQfEY0ECKn33QYTw8n/XF3p9ybgPK/OhqAxHK/U77/zcx3jra75bAYtrd3H+k/ndoe7/Qe71SdSa9cHknW//+4X9zqbhXjbtWX4GcOd4rhzU51u/9X+6NqMuQGeWZvXL4/PjwpKQ/b291eZ1j2/0b9dLdd9aqh/vv//M3MP+d/v8//vrM3gKr4+lnBPjq9LvWs81/Fvzu8gHs3u/3OM3fbvWI0+oeZGa3wH2f+rVJ5MOhNtrr9kdD5fFLnupRN6oY/6+LOW8X9MZesLa4QNZr//pdp1XZNzG5O+m1W6XXKxX9mzxr1b6a1wz9lX2p/IaddCGN1H22V46VquFOMhfpTOfVaHl36YdHvVDvI0gthrO7DK8UGN5UsfLc/LoebRbvWrkreEHz1nZkMRXubRiHlCRT/cfcXJAolT6CY6+9aFD+GwaZWuxI12v84c2Imrf/o8qhXWATPpwi0LIXhEFDYL1CixC+4RfgCKUv8glv4LxCitC+4vYH/AiVL+4LbdndLf4EUJX0BdE/0F2hZGkN7G8+gZCkM+6t8VhLqf5RSLwRJpb++ha8fLUuyMKCwFlaipC+AoQv9BVoWxyAWK3udYlzoH2B5Iz8M1lqDYTmSK4uTwcqCwYBYCGWWKz9TWh/OjXb77XlH9dlgZeGqdiDoFcZjDlso3c84j+EyIDTbAwnc7BXjUlCdwVFxBJrnPke9Nen/ojsQNKcxNAJA/JrlPvVrJALN8wFH3WBlc8hewpDZMGL9ARQ2KIT6EwBi2/tZd+A0CFTbMyA025EA6i+aRfFQvufQ7bAvZgjIffUe63Gd8sba0kW5osswGHkah/0VGA7idxw49n4hS0Cz873FPq2WjDx+X2YPLc9n9BNHlQOnj+dqh9qz7/LxoG6v6urmovjRMBygcqNho7HpCUetgsDa9rCabG0LrgsYLguFt7U9DOZsTRwB78A4Jld0GcUgiO8B/pCa6wENRtNHgAlscC7P08QCe2bQfi7HQBqv3ZHuTMSH4GpXf8C7WB4oSAsmE1lJaBqGwRLd63jjdp7GIPDf88iAzBddIFBRvumgYzfi0wgWLo7/mvsSYT7lLJaE8h37W9ZsEXOEuQxCGv8V9wTAfES+IRsE2hZde2DP20KKE2whERRbWBC0X3I0Hi4Nq50bcnGQ/xINQFcVINYqRRDz2gYETByr/q7VmPLKiW3pyGtK+eoht6R9QOjxPN8bhDShNwgApTcYBJbkjrZAzPHsaifV/4FT+3nzEut+z9T8i3ndpHo/dGs9b1hqnX9kewKuDbhuwfVazLFd70WQWLyT+0PLOeAQv4okdqB43icC7LO+gmVtwilqWa7JG9Wyi8UzC2/AWjnc6faLjZ6caV5GshocntHyqzhfehHJaSOprUlsFBq1JgdKrV9Ygjuk2Po1ODyj8GICcmDseQHPx1HU3sI2AI16iwXEcz6KDUcv5RmbjkT3lhhscThUfu6zeS4DIVguMtghLNdwnPtI4FrjYVnsUMecCBbPfD8YXM8hGJt846PYkIpoKU1H048lMFKpf45mbVirwhMknI+ynZ7Pc9ogPNdnNmweijkeTtpj1T1ep9FaeHwJjriGpa4a4c4gORmC0CM1BmxToXukg6Ja0Gk1WAuSW8shhw1KGYdyGskDAFrt+RMDrvaazAofCVyz8SyCJXwnTJtz4/GwuzEZl/jvdFCEVgK45f5gMjaNH9FKbBBh5vMXLoiZr8ma5dBdriBaI32lcj9YpCBmnUbrE3HmxSYsuaFEHE+fNBhxMv5m5ux9b0vrfw6jn4sjVZuihzF7EdVMfPYsUvkhK4jZsb6ILTuH4Cg+5XXJV2ALw6LbvwxRaD01J170YhQii9IASYmJ+MyoEMOJw/4qkt2BUujF7kr1DmuIyBPbIArlQ17i+aLX24BQVdmDk3QOgEL1YV29XsjzNa5SuVBeKXc2yqHD+lKSNQIj0UKBu/2tyMemaSMwkjX5PE+xpgOgUD3W6yT4B0ZiOcXkyQyEQieOMBnWqc1zOL4GVclmaq8bnkqSNe2Bj8xucx5W1LJL3CqGXaYNsUdlKEN4IhmStb/JA4b1T/9Vu5g3ilH58oXknCSw60IyE5f1b/R8VIwrFRBT5+B0FTMA+rCQCa9Wvd3Nbq8nvRd4FgVE+4I3xlVB+hYGQH8LE270LTaQ8i0T6rdMAu1wiArtsQ1tsRM9uWDHmKpR155OuTwCgo/I57EoJAYBQR/wCPEb15czZ7cxEkChD4rFdYFLExgc9b2LV5FkDhTd4gRMTDqkFmcDsWxPBOgGLNwvzg2Hxa70rVAYDRhdq5vsJNLjRNaqC8Wf+47eKXpduTmvDSpwqSQGbblx5X8T0nI2ED1WTKhjOANQxwrdz67ImsPOQicNELfHuMcMe8ma8M6jqSwkcss0rmyms2gmjcPx7DssdcsHl0dA8msH2a5vlcMRWF5aB0chMWiOdxavt5avXc2sglwOibEPXiVLpsXdfW9U9V+S0WRJw3DB5JLnr7XSt1vXrkql9Y5NRy9HEI5txLjb3dx1z6Viy1OHx8dRlqkHO6MtdkFSxkEma0uKZpaI/7omqCzd76Vu3P0Avbx9IuNe5mAK6ZvPWMyMZgGZrwZ9Eu8DL6muennaIoAm9FzI5AHoRDrOUwvgKsFyf+DC9PcvTUdP+HqIobaOV2ruhngtODhcyUUii8hoEoeE4OOR2aViyVBzx8Bj4AD8TQYuLnwQyVsTMRYBw9eXaMOk+pIQNAc4RTjA/qJXKEzEb3pQdDqLbLVqJsuLuEZ+ykaiowDbvbIYtvgVctxKULFZQPRuy97P5Za2imeKDR2WgrajA91qBqgNdfMIKIP9A4jV7neWelUxPn+O1gBsJCE60HwPtsIEBj1xCPGVCWwvB8od9hqJSmHRozXy5NEjo8f4LF25Nrd2/tz6tdU1WES2ZBcq+5OdDJUHNJTfSxL+ev6sdCdmVreKZz5c19ao/rI7ugo5Jm6Vc+12Cf5Onm9ikYd4yd3oW0jOhCL0Un7Sh5wcqiOnF4xSFLfAfrI1LAbb5U65DE0C3Hhy8viLTHNUHD4a2yAfKmBr0OvKFA05P4LPyaF5QumrFYEV+iedH+Ruu2hvm+QgOgnI0c8n3fbN2d5Q+vVq9ppC7TpXss4h6wDB1f3hT5n8les35BAQn0ZrGBQWvzpww9Ji+5saKtIGR95W3i5G22Gl3i2Mi6XmvFOWgeHXuXSyLv+7SRIAAMuB83KyMi3tGodfAmnIjXFX+pbTtovRMSz+pipkJwGX1qRkNwF+UspvfL2uw4S0Hh7tZdTFdSO4Eo0n9q0Ndsh39FdGD4pCMuerEBf2QX6pW/Y6ak5EswgUpTPsj2Bp2I50hz1wIcghvSYyQpZAKFhn4snu8Le6o/18Ug5lBdb440LV0OUBhBu7Hq8BoMWxPzVU88luEFJ5StD94VMP6LTOywlTZovQoKneMyrk+hRbCxY55ZorFPB62Zm01c44PfjYfDYWzfjhsimmwztfu46MUIdKCMvK6PD3l6Quc9LXgfMEm3EovQAI6PAU/lD0CplIopE+dGaIq+ZwHNdbeFNlKFIIjrG500P/ksDpwCnknwQNbgFoRAHmyAWwVFAK8UWg4Xo5KsemJEtNS6L1NCxOa7IxakPIpRsCQi+Or4e0SoRlvZkWtX/5aKs3C78Mu++LQv0g6BAMt77VY/8FKaxrfG+lGEsXQph6wFPJRPFORCYtN4XhDf2IZnwGPlbm8/gynycpll5jjGLLMZxT/NOJSrqXVcxE8bXMpKX9srXMZfFlfqdsY1sGEyUpxpqPiZIUY83HRNGK4YoPOMysndSsNyR4yo04afnNe8GV7k05C72YJtHSpJxfDGUoXshTNGE4T2HgwlSGCxQGLkyyBO8paEtoadJXMBT6K5QwiYH1SjSDEqYy4G2thKkMeFsrYQoD5DiABfugMueVfxafWi255OSq09DtwcyfyAkQKGXi6OPeZQNckrrlOjK2AQm4InDC/a4I+moBCYyFmzRmoww3Q5NiBQbbu6NuWy6dw3TEnFPKJI2l3Q5P1t5uvVP2qnZ3vLs21KcdYeIzR7UPwk9VE+Um+0O88Ox3XOTBPRjhtq9beXdr1gFco5HFLzHgxx2VEamuHXPlXBCdm6BTbq1V1wu1RExqVrJo5cOis1YtlDLmMK1cyaLd5iIXddiGDnaKPuTiltuGcIUucMDMpZLW/X/6S8pbZX+8MZFNPXSJuUrXlXhS+//StgVJdSctdInVqF7nINwY6BX/9cjpUJol/J70odAjoW7RoV0g07pasOQP4Kre2KW+RKa2dWCJD13S0NFf10pCopyjXyFWh9X7KsCWTMfB+LxmCtYq25OhmmbIpAJNZ+X/VZdFvcktxymwJP+QW9xrG+/F/UO4rwU4aeHL0cYT498lSpJSHS+i0a4Ucm7xnW5JLkCR7tpwkJtQhELXwNX22AZem8jdv39KhGEFMKkBiVzTy/1b1c2S68ENCjJHtYVDd5WPbGhrMhhUQ0kauv0TpBKJH4sEeMWedcN0h1FCicGfMJSjdjEo14ohuMzlfBlZVHhcNggdBSAD9SHvwWZXrl9iF0I8KgeF5fqNqAxZ70GmhjdjW4lodYYaCBl/HBXLOwN5fBxNvZNiZ1BCMg42XEHXEiqcGBY/DsAjjQEpHfQjV4E1u/gB1kli8szifvH1cqe61eSLJZA0/Aqk3aT9S6NRw/qtGXHuKIBmBvM9dVEe6sz12DKBofKvikapGs2UHzuDVjJmJTXaNYhZORyxZQRsb+3djtwGtXtd+JZIlBDsLgcA2pTLw9PBxkIpXRcq1jUAd85+tHBtZdUiiF3wqqfQYOwoGdARvkdD7bsj3034IT4YFf3uuPuL8l14n+qdbqeUeWWuNftGoA0U4sPDbpVwi9reNcofCl6ScLd3AFSwr1bOurCeuMJ1AV+Xwkmb/7e46pditRFVHpBkMlWyWwDVyCQbicXVxpkMEv9aEtzo1knY0EQChY7eFuJLVVvtDmMxhSkmDkUvX8bV1lavXCjHRbenQqPQhA4YS3lHe77CK1YujeP2irS2/6GbQdG7XeyOLvUmKoNE9hOYboNCxz0XUMO7rfaw6vXGldwJ5dscJ3OQ6OYgYONdqCZsXzJsHIZ2whVwSdNUYSxwPMIjMejBuTvi7VOtZGKr8pBFg9B2gptBMIZe22Dv/+lkMSguFzkdIaJ9uzjstHN/MoCwBsi6AlGu9demEGyWHsLlXxUyGuaFcCmzXnG9RnjY2e0XO932nHU0kreXcDbbSOxHfLxgo5KRoRHKGJh0HuLMjqHnWVEiZlzdJB5KaXuDkhoG3QnX354gRqUuXKPVtqpvCUYyE+Pyr/Q82yu3inb9ajRQvC4AOBf3JyLIZ6MYjub8r1gMvBH1ZFE1aAfF5wbOnmwMSrLcqCSeKnRpPmlx5dGSUOokqgZdig8EPChBGBsaaVsBFk17BKeCC92iV8mtbuiSitBpDJrmiVW21lh3/r+IuU0ihD4a7zl5+FY5FrVj9r5RZ02E1YESMrUK0PWSDZq31PUwJKeLJXyntgn9Ox0owSnlW8Uw180iCZOS3RorcDkQMhmAntZ2qVIE+U6pCLGHI3G2wFnIulky00DMqi6OwvmIY28su3l/kZQaRmH8TTCaONxvILhrFJCcY36v9ZOp1fJSW9KHbp+z+g+W0YaSnKu6512ajMeV5Qn0j+5SvdZgadHVCr9SdYqeY2I/KibFbqMp/CyGRWhIughT1A1Yv9BgCIGBi+VB6/YDy1P8gQqKs/KIu2D6UafkHjwcn/NLaTj8yT4oTkVQOLOwGTTD0+k4h4/Gr7AWdwbj3Tj5HJI8qgJ/6AdGi/O/geSPKMAfyAGY7+HfhZuvdWeNtbQaSeJ7i/2+WvSVaxDPp5HNVnemal9Htl0fnfED6M3Mvr3bm4933DwV/WzqLkSEDFTITFNaroPE2upV6mMbs3IdpGki0XXnkfaNqmhkZP9mII1vOku/NRX3VOaejpps8/rBcg5p8YiCRvb2bzNR2Kaz9uIUzFPZehpisqUjE9NreBNrZCPb1uwj0jTTGfX1JpRTWbMRYyMzevM9wYwaebxmtGm+JTPalN+OGW1Gshn3y2KkU8+erDOgEMIl1XgIsVyLXJ5dXsgeOknVDgh9BmQgxnkZJi8MP+KkBxR1lbsE/aGLMjc6/MhMlzBE0cIkOfx6uVnCDyrBWI1jwmHUEJILRKgwpjsTic922QwCG40tSa50RzJUEEvCEFiSva2Rml++X9ckmAguN4a805A5e2H6ZIQR7gzp7kbVV2EHpxBa17l8UrfzUhgg2Yv91UhlDKnbkvGasMTxMaadYbG1xWzH0PVJwG0eB4JOXwlDBJP3x5bE8TwnC2Do6BP7aDRp8lP+UWhkJtPXkT6Hp1HM10svDvecysVYwoNuk9WqoYR4RnQkvem5ApB8oAy33C+H427hvimZ5w6hJD8gg6/dLkvXD1fjB/R5bSDpDNrpiWE6Npsu6IWptdEhK5Xx455JfIbSqxC0h1wAtFpFHJipxmIzemDSvMRr3oou94NJ6zj94HLEEy6xES1pLQeAjSg5qJwqpAyZQCHB2LHsU3cIdJcvNYdJekqYbgHDm010EeM/qhTnbbSMsSb/5+rXFmJ+cOagzOU5JuxPQLE87D5BbPZBU5l1Ep6KslLah638QIVQ1e4BhBDyViNc+YXbFr9Qz/bUN26pVcmjw1DhTmq3ulS9r4L0YllkXQqDQIdqjiDzZtu9FZXYyUgeB4QNJb47YjN3uJkyoZvhpXtJy5HZyE1jGkj9ZK02wvTVgVoFwGcDuVnuQvrN28UwH3NoaAwIa5/HqmRuotr4qBJ+T4NZaG/z1lh2xdpQWkHEBJEG6YAbZkffQjuT1wtfIRBJgr/RuwB2eOhw1B6+xTgsNP7wzQLNQ/wtdAi9kl5qSG704POoL8LjcZ0OBF6sypeD3kgsrmP8lgL8svo3bIrsmHJ7t8auEMtQpw1foN9Gq9HpNT9J9RqETRp0pq+fjWq6wQNkncL9dMrCOSpJWxRLHebIPlOiJoExFjxSMzWnNJlyNK4PuO00huetttSkixirFAIXLfCY+TOhvbccnjcRQ4bm8TSQjuuvQEBNSL9ApPe14AMjbyxD/x7DjQVBHE1Vk+DWcPzQcN8qaDIMKMZnYUkuTQtntq01/u4MLznwysISe3SMvmGPVi1jHp61IPdou6lFFTUuzQRYdiAvgpmsG5bGVkQpze/rlCxVPf2my8r0ZRLqKCX7wFJ1Y9m02jcbFUZooPAfbbFGZ6KYz9fvBK0FqAZht4KH4DfhLppMJJjgUMKZewZ/Yq9ElQ+o7hWYOIEFxHum+ZUsly/hZvEYHTD6spV209S/AxOn00D0Eydz/B4JYPXi9s+z04Wms8GETAQa9hY8kzLQxNE8CBlipYHw6JqyBm/RhCW9JvcV4Lkf8LhL9qZEk9q2wQROnrCCPZDRhNMG4zmdM4/ak1TfpvnTD33t7BN9ahCefPyE0Iy8I4hm5x9PfDxiKZArAimGIuzDtTEUiQ6c8TjrxfUHvM+xmcd9n/xas3EDaAOFhLMnjuUPkqxVbnmuT1ceTye+SL+34NYZj1u4//Q0ChfRji/m51xRfQnfna6E0xXucdSiK42L1NiYpm/pZPw1YW7pAthqSClJeGWqcjvjS3IBm7SNp460gA1anijM200KE+ii3WiCu89skEs+wIEqh6eJFr8WVEWj9tG0FvasA1vkmO/uGVIxBsyNohY7hif69EaCylOC73vsxouNDFygV6crSSMn6MeeEnjmcSgr5vJ0xeGa8AX5zINfLyHTr760WRN+jCiG0kPaVvobFmRT1LBmp91z9H0R/cx7v7U7Gpfy+Ay7lhUYXC+7J4TZG97kfZDkMRrw7ecTAwo6FmEJHZSgUa86WO6DukK9aEarZYnF7RweSmnbqvTPVZSOMsLRjoMLqv+dp1OeRpY40js+echHs4VG46zxWMvb9iDsJAJaTyFhtvGQgVV+9vRK1cgy7NqpGqjX2OhOM5CPThrof5uUghJjBvf8wWM9p60N/+XsTEUh34VMbKYsrSnKElFKOPBQWxvdPHAzblAKSw/pbr2Fm1N3nJanLgKoIoXTSSikm6CsfetKAGqasIM7/GmwgxpSfJ9SwrdUlN1Hba/gmmgJMiXSmT5xe7HaUgTTKaI1KuxqAT9IazRsja4q0qGcgurRlrRTri2JUUe6EsO9iCRfYFACoYK2Hw08zNjVlI3MrMf12vWhBpn9IWE15VE6ygirKQc3zWoqVZ5Gc/ZnWsW1YRcuXriz143pS+aqJTjYPA2k8StZFlJrDc8msK3VRmZaq05uel+DllS6rmYnIUBoqSIs4URS50u7rl8TN1J6BfBVkcZrqcvx6yQP6TPVEPh2EPOn1lT/IiXNEuQ8TBopVgCUPlBXBqGJdJ9jaL9r+3y6+UvZzEn5v9f9i78cPVttvAcBCyjXjCQQT06vC2CS7X+aTBr8uW2OsE7jLqeP5qN8vib0Wf3H88NJJ16OKw3KEdOGzywiQIsQSWVHSjepD18Tugyf+qWHRVWxI9ckV1INHWUXoY3S2D+xVIjwQWvdME15jDJKcT5nDitLi2+sa+Qi1SokxS/FGh6vbOsq+Rq5bGmtlAJ+UatKFm716RWOtvxlaha6IyiEehG9JuFMpihKB2k+gfSy/BMyL6RHR3QPi+/iHnChHILzXt6YqM1QleSWKvARUoCHh4Kcr65N2hQwGyR+mHdgzhfX5sRK8FK/9wmgJfSydeUpfJ6rjtoBo2k/XGZ26hQDWLEudUGx2t7mzwsUd6iBsGOwwC398FA+tjjCzeCEEzeOtNqn8bldorF7OvBFeMTgspnonUoqA2xIbtB4Wm5xCXR6F83irgY8/ach2FT9whRFaFD5y/1O+X5ptom0yjdoYuWbQcJ8Oa3yXQ2EwBPVYOtfiUuO5dSlEONjF57B66Y2x1g+DSM561irgDLywoq48+Qt8IDVA5OCaiRctkqb3X/+L8XuwElbX6lAjMHJ29NRYoGjMN6XyMuVugOcvN/o8TEUhY1NkAwHbd+u25qEDFFKDSW5NSQYk44hytogAEfVrJkSKTXrzoQ4NmF91UmxbApF7aNy6BT7K0WK7aMemHS4I8ZOM/rVXPOPrevICYUBJk0fDEfJ+0QWbYinlOAzoyEyKCVvh4RlaDwufWR0eF23Jq1yXQka9d77t8uNWaYR3lATrLWpjAQvyPM/gXzSRaUPsw92RlsD7XV9Ga19XeJwD4XzG4AsEQHbwwL60vzKqjyYS+8QYowRXegNA7s+3SpHI7BIUJSMO6ymKKE2dGEe89wM4kDLFONy7v5RrCCeJuylpA/gc1Xp7TK83aQMgS5sKVhMpW1ROcqgzeG3CLQBxNUz236oW7EetasB7yIA6LvlhkOcSR/gERs0mvQRV/RWCQmeTDzTG7mYQZvXVYDOJygL6jgmklOmzemCyW88ABRy+nfMIWNy6I4QKzRpQSux9pF38gJwhJd+1q2+1z1UpX5veHaKmKqsIUiyEgYRewDDDhuQRMYacOpf+a9vyjYey/rktqycWbjnatry+czMKUHrEpScNk3CzwF4oSEVm+1/n892Vp/KUYLOAKPUOD12kUzuqUHTw70WuAzQc9txMmQkoPZUkIK3IfAJzi8nqlmlRyqfWIMbx8b4L8Rn+OghMQJif2JyUV9DSf/KexDPL1/ZELS1yX6MIO6V1v1hZe5wJ3JWWXoFAtsk7wnxpaKTfzY1IGEo9FXnERycWzyJHE8WjwZhae6PK33hRjq3UEQWDEv1oXlbxc0oXNPOLbYQSboKZN53rM1Um33YUeeTYrsY8USQeB38hlb+Ut26jSuPwEirRAE2bLWZxVw2Eg9bg9uFjD+VnvgqUnwHpGrY3ZHJCn8XGEb+is3Fa4z8RaAqa1wdq+G+Y/lsVBPqFUvdXD7sw790X1mCc9tE7gJHfQhEr7PhsB0e83T79YWYd94hdFGEKHQXaGXR8H1wCTovjQYil3sx2lUpIk/UGIpJJM2k7089Ek/Ud+DEf6er7huFXcxS6wLQXexgY1jdhtdqky1MyiSL/n/0lDR39uyufd4aJqF2lBpx/LhwSWBbk8EAHLNysRC+K+nweBg82XyvO9ioIFHhXBsaK47Mw+BdQdedB4SFUWuP6h3KKBJNfI+/ZQ2BHPWpwx02I04bzRnM+apMRXoY/CE8ZAGGPtwG0S2WJYsNyelxTjGGQPTiBTY1zNqX11au1C/5HDILgV+JjeEd+nGh0pXFsq06HFoevTJym5J1sJkeHkIYLjj9kQC6qzA/HCjH5Oog7TuUNhN86TvyceRCA+mA0wbCveISzmHkrtYPb6UUQWlqUAt2zu1mtUDPwP2YTQH8dZpWNRmqdNF+XvNg0rAQpENPjmMbx8VeaZKk+k9sOHQ+hOj9igxDya+rHX8QHr5eBdut4azoqYIrfMyAswnJdfEjbvX4AJ7iBOErHFm3y4got2H4+cKgFodD5ReumQXr+DiyCWU5hL4UP/LPfCDgSD4WO+o73BByMkR89z/O/KmeyztlOVgalmUqIbet18jjM58BZKWEni5XCwgGLo5Oxt0pB+Nt2GjD4KKWJLF3RlwSC4J26sFgJRZp1dBkXo+5N2wqD4ReIWwXI4WTa/oMkQVA2wYwcENTR6zkbKPFsQQPAAH7jHHF+kVmoWM4NILyHSyDIuE7hDja9N3RHNs7LQPG+HNzpvdAaE9dd+Ty5DqlkcdSHHZH9iLmxSyBv2DJdMnuaLVXdPs2R65LOhAs0d2bPbh5Lgh+nCHgomgbCBCkdsqtnaV2I0+kaCUfQwgpmDyaYlRslvZeNEdh5NE9nEEusbh6fWc718NtBH4rA6DFn0/UhehcD9fiWIIDhtCf8AJCPaH03A4gr6/1Y+wg5NE9+pa4rybbUq5HK2l0j1YAHg2F69EOhEzE79nQiDgES/Sxg7o2tD7sIoVPItEN+e3WtasW16la56Yk0/J4t+Y9hrHH3tMYEn/kzaaVYSB+hCbH39ja19LPRUmnmKvD7g6cnagEWCkCLUra37VEN7sGHkXL3xzdcEkeH9HkcirArMbtn1HYbB6A5GTmJ59JJzOXwJ3kw/pHBZFYZ/nn6vqJ0OxhsD3kSXfEo0s9strFliJzQYSVnTphp3yZg0GPbRztXhSvnSwFk4NAe+VGk41Re9jdKJe6w9EYnC1yHIidkNpkAQw9mGro8lYfVHEFGS+qx2kB0XP25WK0rZ8neDa63T8lZfDHHC1wguoXHmqUShm00v01GJ5UQb8f1ylEECrFw1BHJ0fjot+Bg4NIVgSWo1w+x+0f1yjUuiWTe4JDMO53IIdMtRUeQXkPFZmMejGudaEF91SRyVBsP99iRTGbFzhQXIEWUqylgi7AQ17TF0BoaVYArnXqAvCfGhVgGZ5RVJcjmhdAaEEXgOXp1A/m3IYITujYMkvTW43LoBWRYrDFMxGiCYmrEH4qAGw5Qk2kUzIBtxvkpYZFIDZHQ774vmkLTcmFjgbkImXKdORCB/680ADhHSkrvG+xKb9Sg2+CS++srcH1n3IVsi1D67GfBjJe7+hIH0Xiv53BWxCptVG4rMa3X8vqwvAh31BP8nRjpexP5I4wTedC0FRfupUjwgCcm2cqEhlRtQ6adEXLqqy5Tie8LpWrYQminXQZuL3xRjKSdye8AUuw6H7mM9UZSo7U4CjMnzoaBj3YExtqdbEwT62BJG63XYLT1sqxluSOA0mb6TZ7+rivF2lmT6gJtUTm9Ggu8ujlDxPq8k9e6hcpWbgg60KXJuOxWrqeD/u6p9oBkdYzDLbcrvo2n3l5KMNngGTOVq8aN+I0QNJkuVLC7MNbkLJ/ZMAOGW0YKeTTt6EJB0HZMJP9TR8y7y/eAgXe7RQsg8CSfCpWrh518xnLRk7Ic5eZuiEZh1LI6vrCq1i7GWAj26nofQrLdPZTWQEojFPZsAlhYzv64wvajgZ4nHZ0WL4VOzqM34YdHUKyHeNjtkn0hxyzG9kwWONmOaazoLqchOebyn50OrL1Hq7BDYCV+UU7tPlUYr4F158lj55oj6Codid/PkmhZEnrBngpuRp2bJIzGRIb0YBK7J0oVAKBpmIv0NjAFsQAdfhfqPZBYLXA9P1sf7zY6aoDuiypBpDWYf58nm6FtjyZxn6IFUPjv7SaoTlksP5gIivsxzkGJopWzt5h4Ij57bJ9c6N6v9bLEJIoCKkBcOTVCbwhr4K7MFQCgCZ6oHBrOpbUhOonaJg4/riEj5fKL/NcRj/JHWM/hyS9RleK3fCOQ5wqhiTZCGaZUbnSNfGkORtZAJIzsdWG8vVYOSH+SX1eatfLrzq4INKk0QJXrwoNyE0aQpZ2c0O+ZWyGt9xIbiMaUbVuF/IkAEvFEKRtO3P9tNglVasNmhspNWQOhjSk+iv43JDawDHAxgcGu1JslCqsCsHCxUlDq0aZO6C5odWB0L7o1pY9FWW/SInj7z8BSi7YZLBYhkIKownYPd21amsr3I5fyDF5KNJ4J8BWY8iNdxag8Zr1xZQbUss22scEzuu44uk2LypWKEMy1Y4FydFokxku8COn97UL/EZ2CRzdKfXTWSc4SkhRTWUjEtMUlrL3RzhLCcSxWUqrP35Laapjt5RmIlsqurs7mzWUBjSyU+6TbO3TmUnlj8UwTWUlClED/0y4MzZP7eZ2xo1MlP6ep+jXVokLEERTGYjA09g+9joOYx8hf0z20cqP2z6a6Jjto3nI9vF8MS/kTMNEG1klvfJReqcziIq/TnNMZQscBdkMNV4rk8oN4bVqZBaV9ginfzrzpNcgPtdUZqJRNVoaBH6/3NLAAhzD0sDVfpxLA5fpGJcGLhHZSBGf6WmMiZh4IwNlxmlL93TmCYLHanmmMg6ehmwa19NsXlWr9zQ3Mkh6sJZqp7PFKQzFVGZAMZAtkHbIm2ce8Q75RhZ6I/lxNTTTWaw+riFBOZUFGzE2mpOCc47cnGQBjmFOcrUf55zkMh3jnOQSkY1Ue0aUiqqLnBE95ai6OMNxRdXF2Y4pqi5ORjacf9aWc3YL2WNwdmvFx+ns1iTH6OzWHI1cqOHBZM6FaiOOwYXqqT9OF6pHdYwuVI9pKkuZc12spRjiGC0l1X8blpJU34KlJFOjaNPYsfiFnK0cTCNrZcZun2A6e6X9HQHZVBYjcjXyrfqxBTnf6pRBwenF0VOMBU7vpZ9eCDCBp5EDwgvKyDkgtPgxOCBs3cfpgLB5jtEBYdM0M40bXZI1jRI/DtNYuo/VNBbPcZrGoiGbJojJkVktczE5jcxyLvkdRvN0Rkmv6A3LVCbBkpANUh/DZN5ow8UwNTJRfZB/DcV0tkpvkiN0UxmNzNbILRSEg+XcQhbgGNxCrvbjdAu5TMfoFnKJ6Cu51RW2xaogeQI8OCI9DPWEjjSFh6XdsMNi+J8xI3oAorB+HiiQmlHr5DiSwi/uahstThqAXHRKAKMws/wiVoCLQ5xeEYQo6s5ApgLRl9IT7cmRph5bC6TzaelzFwdA3aOaaAfzZZnQAgdB4bsvz1cM0/PZsxgqh7gd6CcQyJ/5NMkbwFqj5b8mtMYQRe1/ngs2fDYd5bmlfjFrMXLl43xtusW4CAqfyaLwZTjDZlMn6Ln0/hJ8sPNexo/C+G2uzhLEX0lYqib9zhAe4YMXNmSFRO5gSf2WKJrhPsuv8Q7kYjJvq9XpN4J47fB8xqjcsU65IhnRLJlknf+1PpIe9CZbXdVAIkfSlsZ1KYvTzDY0kEwYXl1WU05YGTHlBka6NLFajCD91I3lhdp0FDVkGohPhbe6Anm/5Joy0oRsIwhRtGor5+VvQ1vk013q/HlsKlzbhvcbrJSQkYtSQqMjiy7rp+9Ww15HemB5flc712UdVxyEJ3XKqhdGNXvByOdpCHkvaKkw77MFU1aUkvo8G1uwGnx6kREhbDCE74uH5TjHR6rlib/L5NL5d1pFYV600e/AyffqxE+4gWN/znoZ5wdW3l9Xl5AyKnPJfh8IwPVyPBlK5c9nlAtZPIXzgp2eCpVmyst1e5vwppYc5U32UU8TkzHqMkli9WNvTuuNVIBU7snjK+HeEhQLHssqdtQkW09iRPH690t4u04mIvWbmfgp02D/g9bEMtIuy7ZwMqhmqUwIoZNjC/FrKrL4z9JqQQ6dKpYhtN4fpPQStB5uwFKnXapa+GGtWimG1XtfAXSJn8upJpT6SGAQtazksJr3291hO9smhBC6tEI8X1oth24TDJFvE1IKr3Wy0dWVUK9VSGG13pPyurg/yiimtGIO0ZprW7ESQ1uuhB/Hpi5qLaflsJofaIQutfX6R41yQsnvSVC+to0guo+UkOs020eEEL6muXi+j2g5dGtmiHwfkVLoOujBxryQG7HaOhBCaJ3w2kcnW69CCF2vQjxfr1oOXa8Mka9XKUXROhxnxx4phe4NUj7fG4wgeuzhkPzYo8QINQELJ0RNcClCTXB5TE0oQUJNAARTE0IM3S8ApVcotf1CCOFf4+Hi+X6h5fDP8AAi3y+kFLoOdqrazZX4Kbnq/VtTlwOW97+uLqUqIYT+4vHtsuyrtzzDL5ZKpRS6NamnN6SBwl2E1KvkCFuIllUJ9YqFlH0SmN37CAjsv+Xe57mMciaJV/9EgESSdUMS2cU5JEaesJVds236o1oGKUappEcS47g1XswxBD6NHM395b585Uj5S38gXCeuekuKFK7RUq9+qDVATLkRIkXp3OjrN0Wk9h/GtNtiFP0HokFI1SeiqoUE6dTYuC4/9waovN/y/+qywYEVvIEk2104QAlVUgg7lNxRr/z+oUaf84ZvZliCdw6sYSkc7YRGJUVSW/V7Mm15Si2TQqu9LV/5SatVUg3H5sjwIPQqMcrwcKgeJsroVmIU3eGY4HZbobnhkPABvGQ8hOfUq8FV6ESbXdXB5KNfDkUgSvLVcievGDh/H1XOfiaNOALC3zeTA7I7WNqKhdRUg+WzMeVPa6yMlfypDJV/iCmmD5T3IHqlLy6/CRN6o6X5OePI/BPtLd7oTdREEfRwSx0Twzut4BRrtAlvPEtfeUqxlsVq3+sMi9uIEjMxtE5T2KROSjnvbNaPyLZK/Ih8d9Qu9Jo2pZPL4bWykHqMViaH3ixeggZju/IjqzRLt5HGj8iP51XTsXnOJnk8CGF5vgDNCf89Rppy+uF9SprCSOMpjpZ6uzbDC2kGJUyYJVus6dkUs0kKS5xCwloigcSIEzZM8EC6VGAfe51LMvkYws5mke/tl2T/k+ZxZg2LxxUmRU+1uDLv9PukOnKXx7aeEPqI/QMPuH5WDqpp/evWOiz3DJoHXYMakit+nX43TsIlQ5578Br+sISXZkrzlKDd1opNsLf9ytn3/THylCWC9uFvlJuwBrD1Boe1p2wZrOJP2vwxNR4ivNAdgeb2tlrdWO86S4aoMJbqEXvcX4Sawf+ptV/A4Uqh5w+ASYzca8YUSwm0Unj6PqPUSKBXO1V/AR4LHVZitg/2iaf072inWNVfgcNHUcbfRfTxX9EfPcrWpJFAL5jg2Ee84fpFoI39hNXzpe6eUACopEkblsaOdycccE8lMITVg2rwDlvo0TvlyREYop0wwlDb//IrIFUT9lWC79uzhqks+q2BRxprXR9wfD5GO/mmwENnYA43SUY1+50UhAwbY2ce/Z2j1/oVo/XR9XKTXbsH8Z+A4Dczf/qrcwerECkBEaS/unB0tdgpwXDt8lcX9xb7k51fnz93+E4x7DL3wq9fvnCoqO6cPXfx7jzTf+fcSy8fLatGcOels+fuW+147+yZcxcOWW2Ww/Hu3rkzFy7ur5Tj7apz9/y5V16+eMTXMfBW5XD/3Mvnzl64cDjXhqY0qoYH5868+srZl84dsfqa63WL0cGFs69eOH/mwhF8Qglf0y4PLp6/ePHlMxcP1QOg6kueMR/yXf4d39NfcUJ/w5viA/7+l6b40ELt0n/1zIwu+1ffnZEl/+p7M6bYX/1yRhf5jzPfnZkx5eVGMIX948ybYApV0j/O/HJm5uEIzkR1V4SneQ83J70eK/rf3e2xN9D/5aPRdnV7he+KWRj73z0YiUfrrnT7NwHwnS8X4OG8E7MnFmGlAM8PF70TYplwYrG18vVr2+PxYPTa6dNb3fH2ZOMUxDizmLntqv/eaJZF3852AH0ayi6ws6JJzZajnUdsTw8VuTosB2W/8/UJeOlyNPumi+51N04Xg+4s++2fAA=='; \ No newline at end of file diff --git a/docs/assets/dmt/dmt-components.css b/docs/assets/dmt/dmt-components.css index 13983508..97a62960 100644 --- a/docs/assets/dmt/dmt-components.css +++ b/docs/assets/dmt/dmt-components.css @@ -1,12 +1,18 @@ -a.svelte-8p5j4n{width:fit-content}span.svelte-8p5j4n,svg.svelte-8p5j4n{pointer-events:none}.indent-icon.svelte-8p5j4n{margin-left:var(--dmt-nav-entry-indent-icon,28px)}.indent-no-icon.svelte-8p5j4n{margin-left:var(--dmt-nav-entry-indent-no-icon,18px)} +section.svelte-20evnz{display:flex;flex-direction:column;gap:.5rem;margin-top:.75rem} +a.svelte-14yttr0{width:fit-content}a.svelte-14yttr0,span.svelte-14yttr0{margin-right:.25rem}span.svelte-14yttr0,svg.svelte-14yttr0{pointer-events:none}.indent-icon.svelte-14yttr0{margin-left:var(--dmt-nav-entry-indent-icon,28px)}.indent-no-icon.svelte-14yttr0{margin-left:var(--dmt-nav-entry-indent-no-icon,18px)}.indent-none.svelte-14yttr0{margin-left:.25rem} details.svelte-9arcsc.svelte-9arcsc{margin-left:var(--tjs-folder-details-margin-left,-.4em);padding-left:var(--tjs-folder-details-padding-left,.4em)}summary.svelte-9arcsc.svelte-9arcsc{align-items:center;background:var(--tjs-folder-summary-background,none);background-blend-mode:var(--tjs-folder-summary-background-blend-mode,initial);border:var(--tjs-folder-summary-border,none);border-radius:var(--tjs-folder-summary-border-radius,0);border-width:var(--tjs-folder-summary-border-width,initial);cursor:var(--tjs-folder-summary-cursor,pointer);display:flex;font-family:var(--tjs-folder-summary-font-family,inherit);font-size:var(--tjs-folder-summary-font-size,inherit);font-weight:var(--tjs-folder-summary-font-weight,bold);gap:var(--tjs-folder-summary-gap,.125em);list-style:none;margin:var(--tjs-folder-summary-margin,0 0 0 -.4em);padding:var(--tjs-folder-summary-padding,.25em) 0;position:relative;transition:var(--tjs-folder-summary-transition,background .1s);-webkit-user-select:none;user-select:none;width:var(--tjs-folder-summary-width,fit-content)}summary.svelte-9arcsc.svelte-9arcsc::-webkit-details-marker{display:none}.default-cursor.svelte-9arcsc.svelte-9arcsc{cursor:default}summary.svelte-9arcsc svg.svelte-9arcsc{border-radius:var(--tjs-folder-summary-chevron-border-radius,0);color:var(--tjs-folder-summary-chevron-color,currentColor);cursor:var(--tjs-folder-summary-cursor,pointer);flex-shrink:0;height:var(--tjs-folder-summary-chevron-size,var(--tjs-folder-summary-font-size,1.25em));margin:var(--tjs-folder-summary-chevron-margin,0);opacity:var(--tjs-folder-summary-chevron-opacity,.2);transform:var(--tjs-folder-summary-chevron-rotate-closed,rotate(-90deg));transition:var(--tjs-folder-summary-chevron-transition,opacity .2s,transform .1s);width:var(--tjs-folder-summary-chevron-size,var(--tjs-folder-summary-font-size,1.25em))}summary.svelte-9arcsc.svelte-9arcsc:focus-visible{box-shadow:var(--tjs-folder-summary-box-shadow-focus-visible,var(--tjs-default-box-shadow-focus-visible));outline:var(--tjs-folder-summary-outline-focus-visible,var(--tjs-default-outline-focus-visible,revert));transition:var(--tjs-folder-summary-transition-focus-visible,var(--tjs-default-transition-focus-visible))}summary.svelte-9arcsc:focus-visible .label.svelte-9arcsc{text-shadow:var(--tjs-folder-summary-label-text-shadow-focus-visible,var(--tjs-default-text-shadow-focus-hover,revert))}summary.svelte-9arcsc:focus-visible .tjs-folder-focus-indicator.svelte-9arcsc{background:var(--tjs-folder-summary-focus-indicator-background,var(--tjs-default-focus-indicator-background,#fff))}summary.svelte-9arcsc:focus-visible svg.svelte-9arcsc{opacity:var(--tjs-folder-summary-chevron-opacity-focus-visible,1)}summary.svelte-9arcsc:focus-visible svg.focus-chevron.svelte-9arcsc{outline:var(--tjs-folder-summary-outline-focus-visible,var(--tjs-default-outline-focus-visible,revert))}summary:focus-visible.remove-focus-visible.svelte-9arcsc.svelte-9arcsc{outline:none}summary.svelte-9arcsc:hover svg.svelte-9arcsc{opacity:var(--tjs-folder-summary-chevron-opacity-hover,1)}.tjs-folder-focus-indicator.svelte-9arcsc.svelte-9arcsc{align-self:var(--tjs-folder-summary-focus-indicator-align-self,var(--tjs-default-focus-indicator-align-self,stretch));border:var(--tjs-folder-summary-focus-indicator-border,var(--tjs-default-focus-indicator-border));border-radius:var(--tjs-folder-summary-focus-indicator-border-radius,var(--tjs-default-focus-indicator-border-radius,.1em));flex:0 0 var(--tjs-folder-summary-focus-indicator-width,var(--tjs-default-focus-indicator-width,0.25em));height:var(--tjs-folder-summary-focus-indicator-height,var(--tjs-default-focus-indicator-height));pointer-events:none;transition:var(--tjs-folder-summary-focus-indicator-transition,var(--tjs-default-focus-indicator-transition))}details[open].svelte-9arcsc>summary.svelte-9arcsc{background:var(--tjs-folder-summary-background-open,var(--tjs-folder-summary-background,inherit))}[open].svelte-9arcsc:not(details[data-closing=true])>summary svg.svelte-9arcsc{transform:rotate(var(--tjs-folder-summary-chevron-rotate-open,0))}.contents.svelte-9arcsc.svelte-9arcsc{background:var(--tjs-folder-contents-background,none);background-blend-mode:var(--tjs-folder-contents-background-blend-mode,initial);border:var(--tjs-folder-contents-border,none);border-left:var(--tjs-folder-contents-border-left,none);display:var(--tjs-folder-contents-display,flex);flex-direction:var(--tjs-folder-contents-flex-direction,column);gap:var(--tjs-folder-contents-gap);margin:var(--tjs-folder-contents-margin,0 0 0 -.4em);padding:var(--tjs-folder-contents-padding,0 0 0 calc(var(--tjs-folder-summary-font-size, 1em)*.8));position:relative}.contents.svelte-9arcsc.svelte-9arcsc:before{content:"";height:calc(100% + .65em);left:0;position:absolute;top:-.65em;width:0}.label.svelte-9arcsc.svelte-9arcsc{overflow:var(--tjs-folder-summary-label-overflow,hidden);text-overflow:var(--tjs-folder-summary-label-text-overflow,ellipsis);white-space:var(--tjs-folder-summary-label-white-space,nowrap);width:var(--tjs-folder-summary-label-width,fit-content)}summary.svelte-9arcsc:focus-visible+.contents.svelte-9arcsc:before{height:100%;top:0} +.dmt-navigation-content.svelte-cugiyd{display:flex;flex-direction:column;--tjs-folder-summary-font-weight:normal;--tjs-folder-summary-font-size:1em;--tjs-folder-summary-margin:0;--tjs-folder-summary-padding:0;--tjs-folder-summary-width:100%;--tjs-folder-contents-margin:var(--dmt-nav-folder-contents-margin,0 0 0 7px);--tjs-folder-contents-border-left:var(--dmt-nav-folder-contents-border-left,2px solid var(--dmt-nav-folder-contents-border-color,#0003));--tjs-folder-contents-padding:var(--dmt-nav-folder-contents-padding,0 0 0 9px);outline:#0000;overflow-x:auto;padding-left:var(--dmt-nav-tree-padding-left,3px);padding-top:var(--dmt-nav-tree-padding-top,.25rem);touch-action:pan-x pan-y}.dmt-navigation-content.svelte-cugiyd>:last-child{margin-bottom:var(--dmt-nav-tree-bottom-margin,.25rem)} +hr.svelte-o6ftwg{border:unset;border-bottom:var(--dmt-container-border);margin:.25rem .5rem 0 0}section.svelte-o6ftwg{--tjs-folder-summary-margin:0 0.25rem;--tjs-folder-summary-width:100%;background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow);margin:0 1rem 0 0} +a.svelte-ietkuq{display:block;overflow:var(--dmt-sidebarlinks-overflow,unset);text-overflow:var(--dmt-sidebarlinks-text-overflow,ellipsis);white-space:var(--dmt-sidebarlinks-white-space,normal)}section.svelte-ietkuq{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow);display:flex;flex-direction:column;gap:.25em;margin:0 1rem 0 0;padding:.25rem} div.svelte-1uxeem0{background:var(--dmt-overlay-panel-background);border-bottom:1px solid #0003;border-left:1px solid #0003;border-radius:0 0 .25rem .25rem;border-right:1px solid #0003;box-shadow:-.25rem 0 .25rem -.25rem var(--dmt-box-shadow-color),.25rem 0 .25rem -.25rem var(--dmt-box-shadow-color),0 .75rem .75rem -.75rem var(--dmt-box-shadow-color);display:flex;flex-direction:column;gap:.25rem;height:fit-content;padding:.5rem;position:absolute;top:2.6rem;width:calc(100% - 1.5rem)}span.svelte-1uxeem0{align-items:center;display:flex;gap:.5rem}svg.svelte-1uxeem0{margin:0}.key.svelte-1uxeem0{background:#ffffff40;border:1px solid #999;border-radius:.25rem;box-shadow:1px 1px var(--dmt-help-panel-key-box-shadow-color);min-width:52px;padding:0 3px;text-align:center}.reflection-kinds.svelte-1uxeem0{display:grid;grid-template-columns:1fr 1fr;grid-row-gap:.1rem}.title.svelte-1uxeem0{-webkit-text-decoration:underline;text-decoration:underline}:root[data-theme=dark]{--dmt-help-panel-key-box-shadow-color:#aaa}:root[data-theme=light]{--dmt-help-panel-key-box-shadow-color:#444}@media(prefers-color-scheme:dark){:root{--dmt-help-panel-key-box-shadow-color:#aaa}}@media(prefers-color-scheme:light){:root{--dmt-help-panel-key-box-shadow-color:#444}} -a.svelte-1b99m8i:not(:first-child){margin-left:.5rem;white-space:nowrap;width:fit-content}button.svelte-1b99m8i{background:#0000;border-radius:50%;cursor:pointer;height:2rem;line-height:0;width:2rem}section.svelte-1b99m8i{align-items:center;background:var(--color-background);border-bottom:var(--dmt-container-border);display:flex;gap:.5em;height:fit-content;padding:.25rem;position:sticky;top:0;width:inherit;z-index:10}svg.svelte-1b99m8i{height:1rem;width:1rem;fill:currentColor;overflow:hidden}.flipped-vertical.svelte-1b99m8i{transform:scaleY(-1)} -section.svelte-820e2{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow);display:flex;flex-direction:column;gap:.25em;margin:.5rem 1rem .25rem 0;padding:.25rem}a.svelte-820e2{display:block;overflow:var(--dmt-sidebarlinks-overflow,unset);text-overflow:var(--dmt-sidebarlinks-text-overflow,ellipsis);white-space:var(--dmt-sidebarlinks-white-space,normal)} -.dmt-navigation-content.svelte-ru8laz{display:flex;flex-direction:column;--tjs-folder-summary-font-weight:normal;--tjs-folder-summary-font-size:1em;--tjs-folder-summary-margin:0;--tjs-folder-summary-padding:0;--tjs-folder-summary-width:100%;--tjs-folder-contents-margin:var(--dmt-nav-folder-contents-margin,0 0 0 7px);--tjs-folder-contents-border-left:var(--dmt-nav-folder-contents-border-left,2px solid var(--dmt-nav-folder-contents-border-color,#0003));--tjs-folder-contents-padding:var(--dmt-nav-folder-contents-padding,0 0 0 9px);outline:#0000;overflow-x:auto;padding-left:3px;padding-top:.25rem;touch-action:pan-x pan-y}.dmt-navigation-content.svelte-ru8laz>:last-child{margin-bottom:1rem} -section.svelte-20evnz{display:flex;flex-direction:column;gap:.5rem;margin-top:.75rem} -a.svelte-1iuo1zb.svelte-1iuo1zb{align-items:center;display:flex;flex-shrink:0;margin:4px}a.svelte-1iuo1zb:focus-visible img.svelte-1iuo1zb{filter:brightness(1.5)}img.svelte-1iuo1zb.svelte-1iuo1zb{height:24px;width:auto}img.svelte-1iuo1zb.svelte-1iuo1zb:hover{filter:brightness(1.5)}section.svelte-1iuo1zb.svelte-1iuo1zb{align-items:center;display:flex;flex-wrap:nowrap;gap:.35rem;margin-left:auto;margin-right:.5rem;min-width:0;overflow:hidden;padding-left:.5rem} +button.svelte-1xrvgp2{background:#0000;border-radius:50%;cursor:pointer;height:2rem;line-height:0;width:2rem}section.svelte-1xrvgp2{align-items:center;background:var(--color-background);border-bottom:var(--dmt-container-border);display:flex;gap:.5rem;height:fit-content;padding:.25rem 1rem .25rem 0;position:sticky;top:0;width:inherit;z-index:10}svg.svelte-1xrvgp2{height:1rem;width:1rem;fill:currentColor;stroke:currentColor;overflow:hidden}.flipped-vertical.svelte-1xrvgp2{transform:scaleY(-1)} +section.svelte-13h1skr{--dmt-nav-tree-bottom-margin:1rem} button.svelte-10arjs8{background:#0000;border-radius:50%;cursor:pointer;height:33px;line-height:0;margin:0 3px 3px;width:33px} li.svelte-5rxzhp{align-items:center;background-color:var(--color-background);cursor:pointer;display:flex;gap:.25rem;overflow:hidden;padding:0 10px;text-overflow:ellipsis;transition:background .15s ease-in-out}li.selected.svelte-5rxzhp{background:var(--dmt-menu-item-background-selected)}li.svelte-5rxzhp:hover{background:var(--dmt-menu-item-background-hover)}li.svelte-5rxzhp:not(:last-child){border-bottom:var(--dmt-container-separator-border)}li.svelte-5rxzhp:nth-child(2n):not(:hover):not(.selected){background-color:var(--color-background-secondary)}ul.svelte-5rxzhp{border:var(--dmt-container-floating-border);border-bottom-left-radius:.5rem;border-bottom-right-radius:.5rem;box-shadow:var(--dmt-container-floating-box-shadow);list-style:none;margin:0 0 0 -4px;overflow:hidden;padding:0;position:absolute;top:calc(var(--dmt-header-height) - 2px);width:calc(100% - 4px)} #dmt-search-field.svelte-tuln0o,#tsd-search .field input{background:revert;border:1px solid var(--color-accent);border-radius:.5em;box-sizing:border-box;color:var(--color-text);font-size:16px;height:35px;opacity:1;outline:2px solid #0000;padding:revert;position:relative;right:4px;top:0;width:100%;z-index:10} -div.svelte-wmon9h{box-sizing:border-box;line-height:0;padding:4px 0;position:absolute;right:-40px;width:40px}.dmt-widget.svelte-wmon9h{display:inline-block;height:40px;opacity:.8;overflow:hidden;transition:opacity .1s,background-color .2s;vertical-align:bottom} \ No newline at end of file +div.svelte-wmon9h{box-sizing:border-box;line-height:0;padding:4px 0;position:absolute;right:-40px;width:40px}.dmt-widget.svelte-wmon9h{display:inline-block;height:40px;opacity:.8;overflow:hidden;transition:opacity .1s,background-color .2s;vertical-align:bottom} +div.svelte-kjcljd{flex:0;height:0;width:0}div.svelte-kjcljd:focus{outline:none} +section.svelte-1pcybcf.svelte-1pcybcf{background:var(--color-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:0 0 6px #000;height:max-content;left:50%;overflow:hidden;padding:.25rem;position:absolute;top:calc(100% + 10px);transform:translateX(-50%);width:max-content;z-index:1}div.svelte-1pcybcf.svelte-1pcybcf{align-items:center;display:flex;flex-direction:column;flex-wrap:nowrap;gap:.5rem}section.svelte-1pcybcf.svelte-1pcybcf:focus-visible{outline:2px solid #0000}a.svelte-1pcybcf.svelte-1pcybcf{align-items:center;display:flex;flex-shrink:0}a.svelte-1pcybcf:focus-visible img.svelte-1pcybcf{filter:brightness(1.5)}img.svelte-1pcybcf.svelte-1pcybcf{max-height:24px;width:auto}img.svelte-1pcybcf.svelte-1pcybcf:hover{filter:brightness(1.5)} +button.svelte-1ebh1s9{background:#0000;border-radius:50%;cursor:pointer;height:33px;line-height:0;margin:1px 3px 0;width:33px}section.svelte-1ebh1s9{display:flex;margin-left:auto;min-width:fit-content;position:relative}svg.svelte-1ebh1s9{fill:var(--color-text)} +a.svelte-1f93d1m.svelte-1f93d1m{align-items:center;display:flex;flex-shrink:0;margin:4px}a.svelte-1f93d1m:focus-visible img.svelte-1f93d1m{filter:brightness(1.5)}img.svelte-1f93d1m.svelte-1f93d1m{height:24px;width:auto}img.svelte-1f93d1m.svelte-1f93d1m:hover{filter:brightness(1.5)}section.svelte-1f93d1m.svelte-1f93d1m{align-items:center;display:flex;flex-wrap:nowrap;gap:.35rem;margin-left:auto;min-width:0;overflow:hidden} +section.svelte-j9157o{align-items:center;display:flex;flex-wrap:nowrap;height:100%;margin-right:.5rem;width:100%} \ No newline at end of file diff --git a/docs/assets/dmt/dmt-components.js b/docs/assets/dmt/dmt-components.js index 50f9754a..586303f2 100644 --- a/docs/assets/dmt/dmt-components.js +++ b/docs/assets/dmt/dmt-components.js @@ -3,65 +3,17796 @@ * @license MPL-2.0 * @see https://github.com/typhonjs-typedoc/typedoc-theme-dmt */ -import"./dmt-component-data.js";var e,t,n;try{e=new TextDecoder}catch(e){}var r,o,s,i,a,l=0,c={},u=0,f=0,d=[],h={useRecords:!1,mapsAsObjects:!0};class p{}const g=new p;g.name="MessagePack 0xC1";var m=!1,y=2;try{new Function("")}catch(e){y=1/0}class v{constructor(e){e&&(!1===e.useRecords&&void 0===e.mapsAsObjects&&(e.mapsAsObjects=!0),e.sequential&&!1!==e.trusted&&(e.trusted=!0,e.structures||0==e.useRecords||(e.structures=[],e.maxSharedStructures||(e.maxSharedStructures=0))),e.structures?e.structures.sharedLength=e.structures.length:e.getStructures&&((e.structures=[]).uninitialized=!0,e.structures.sharedLength=0),e.int64AsNumber&&(e.int64AsType="number")),Object.assign(this,e)}unpack(e,i){if(t)return W((()=>(K(),this?this.unpack(e,i):v.prototype.unpack.call(h,e,i))));e.buffer||e.constructor!==ArrayBuffer||(e="undefined"!=typeof Buffer?Buffer.from(e):new Uint8Array(e)),"object"==typeof i?(n=i.end||e.length,l=i.start||0):(l=0,n=i>-1?i:e.length),f=0,o=null,s=null,t=e;try{a=e.dataView||(e.dataView=new DataView(e.buffer,e.byteOffset,e.byteLength))}catch(n){if(t=null,e instanceof Uint8Array)throw n;throw new Error("Source must be a Uint8Array or Buffer but was a "+(e&&"object"==typeof e?e.constructor.name:typeof e))}if(this instanceof v){if(c=this,this.structures)return r=this.structures,b(i);(!r||r.length>0)&&(r=[])}else c=h,(!r||r.length>0)&&(r=[]);return b(i)}unpackMultiple(e,t){let n,r=0;try{m=!0;let o=e.length,s=this?this.unpack(e,o):G.unpack(e,o);if(!t){for(n=[s];le.slice(0))));for(let t=0,n=e.length;t=32&&(n.highByte=t-32>>5))}e.sharedLength=e.length;for(let n in t||[])if(n>=0){let r=e[n],o=t[n];o&&(r&&((e.restoreStructures||(e.restoreStructures=[]))[n]=r),e[n]=o)}return this.structures=e}decode(e,t){return this.unpack(e,t)}}function b(e){try{if(!c.trusted&&!m){let e=r.sharedLength||0;en)throw new Error("Unexpected end of MessagePack data");if(!m){let t;try{t=JSON.stringify(e,((e,t)=>"bigint"==typeof t?`${t}n`:t)).slice(0,100)}catch(e){t="(JSON view not available "+e+")"}throw new Error("Data read, but end of buffer not reached "+t)}}return e}catch(e){throw r&&r.restoreStructures&&w(),K(),(e instanceof RangeError||e.message.startsWith("Unexpected end of buffer")||l>n)&&(e.incomplete=!0),e}}function w(){for(let e in r.restoreStructures)r[e]=r.restoreStructures[e];r.restoreStructures=null}function x(){let e=t[l++];if(e<160){if(e<128){if(e<64)return e;{let t=r[63&e]||c.getStructures&&E()[63&e];return t?(t.read||(t.read=S(t,63&e)),t.read()):e}}if(e<144){if(e-=128,c.mapsAsObjects){let t={};for(let n=0;n=l)return o.slice(l-u,(l+=t)-u);if(0==f&&n<140){let e=t<16?R(t):F(t);if(null!=e)return e}return T(t)}{let n;switch(e){case 192:return null;case 193:return s?(n=x(),n>0?s[1].slice(s.position1,s.position1+=n):s[0].slice(s.position0,s.position0-=n)):g;case 194:return!1;case 195:return!0;case 196:if(n=t[l++],void 0===n)throw new Error("Unexpected end of buffer");return N(n);case 197:return n=a.getUint16(l),l+=2,N(n);case 198:return n=a.getUint32(l),l+=4,N(n);case 199:return _(t[l++]);case 200:return n=a.getUint16(l),l+=2,_(n);case 201:return n=a.getUint32(l),l+=4,_(n);case 202:if(n=a.getFloat32(l),c.useFloat32>2){let e=J[(127&t[l])<<1|t[l+1]>>7];return l+=4,(e*n+(n>0?.5:-.5)|0)/e}return l+=4,n;case 203:return n=a.getFloat64(l),l+=8,n;case 204:return t[l++];case 205:return n=a.getUint16(l),l+=2,n;case 206:return n=a.getUint32(l),l+=4,n;case 207:return"number"===c.int64AsType?(n=4294967296*a.getUint32(l),n+=a.getUint32(l+4)):"string"===c.int64AsType?n=a.getBigUint64(l).toString():"auto"===c.int64AsType?(n=a.getBigUint64(l),n<=BigInt(2)<=BigInt(-2)<=l?o.slice(l-u,(l+=n)-u):L(n);case 218:return n=a.getUint16(l),f>=(l+=2)?o.slice(l-u,(l+=n)-u):A(n);case 219:return n=a.getUint32(l),f>=(l+=4)?o.slice(l-u,(l+=n)-u):C(n);case 220:return n=a.getUint16(l),l+=2,P(n);case 221:return n=a.getUint32(l),l+=4,P(n);case 222:return n=a.getUint16(l),l+=2,O(n);case 223:return n=a.getUint32(l),l+=4,O(n);default:if(e>=224)return e-256;if(void 0===e){let e=new Error("Unexpected end of MessagePack data");throw e.incomplete=!0,e}throw new Error("Unknown MessagePack token "+e)}}}const $=/^[a-zA-Z_$][a-zA-Z\d_$]*$/;function S(e,t){function n(){if(n.count++>y){let n=e.read=new Function("r","return function(){return "+(c.freezeData?"Object.freeze":"")+"({"+e.map((e=>"__proto__"===e?"__proto_:r()":$.test(e)?e+":r()":"["+JSON.stringify(e)+"]:r()")).join(",")+"})}")(x);return 0===e.highByte&&(e.read=k(t,e.read)),n()}let r={};for(let t=0,n=e.length;tfunction(){let o=t[l++];if(0===o)return n();let s=e<32?-(e+(o<<5)):e+(o<<5),i=r[s]||E()[s];if(!i)throw new Error("Record id is not defined for "+s);return i.read||(i.read=S(i,e)),i.read()};function E(){let e=W((()=>(t=null,c.getStructures())));return r=c._mergeStructures(e,r)}var T=I,L=I,A=I,C=I;function I(n){let r;if(n<16&&(r=R(n)))return r;if(n>64&&e)return e.decode(t.subarray(l,l+=n));const o=l+n,s=[];for(r="";l65535&&(n-=65536,s.push(n>>>10&1023|55296),n=56320|1023&n),s.push(n)}else s.push(e);else s.push(e);s.length>=4096&&(r+=D.apply(String,s),s.length=0)}return s.length>0&&(r+=D.apply(String,s)),r}function P(e){let t=new Array(e);for(let n=0;n0)return void(l=n);r[o]=e}return D.apply(String,r)}function R(e){if(e<4){if(e<2){if(0===e)return"";{let e=t[l++];return(128&e)>1?void(l-=1):D(e)}}{let n=t[l++],r=t[l++];if((128&n)>0||(128&r)>0)return void(l-=2);if(e<3)return D(n,r);let o=t[l++];return(128&o)>0?void(l-=3):D(n,r,o)}}{let n=t[l++],r=t[l++],o=t[l++],s=t[l++];if((128&n)>0||(128&r)>0||(128&o)>0||(128&s)>0)return void(l-=4);if(e<6){if(4===e)return D(n,r,o,s);{let e=t[l++];return(128&e)>0?void(l-=5):D(n,r,o,s,e)}}if(e<8){let i=t[l++],a=t[l++];if((128&i)>0||(128&a)>0)return void(l-=6);if(e<7)return D(n,r,o,s,i,a);let c=t[l++];return(128&c)>0?void(l-=7):D(n,r,o,s,i,a,c)}{let i=t[l++],a=t[l++],c=t[l++],u=t[l++];if((128&i)>0||(128&a)>0||(128&c)>0||(128&u)>0)return void(l-=8);if(e<10){if(8===e)return D(n,r,o,s,i,a,c,u);{let e=t[l++];return(128&e)>0?void(l-=9):D(n,r,o,s,i,a,c,u,e)}}if(e<12){let f=t[l++],d=t[l++];if((128&f)>0||(128&d)>0)return void(l-=10);if(e<11)return D(n,r,o,s,i,a,c,u,f,d);let h=t[l++];return(128&h)>0?void(l-=11):D(n,r,o,s,i,a,c,u,f,d,h)}{let f=t[l++],d=t[l++],h=t[l++],p=t[l++];if((128&f)>0||(128&d)>0||(128&h)>0||(128&p)>0)return void(l-=12);if(e<14){if(12===e)return D(n,r,o,s,i,a,c,u,f,d,h,p);{let e=t[l++];return(128&e)>0?void(l-=13):D(n,r,o,s,i,a,c,u,f,d,h,p,e)}}{let g=t[l++],m=t[l++];if((128&g)>0||(128&m)>0)return void(l-=14);if(e<15)return D(n,r,o,s,i,a,c,u,f,d,h,p,g,m);let y=t[l++];return(128&y)>0?void(l-=15):D(n,r,o,s,i,a,c,u,f,d,h,p,g,m,y)}}}}}function M(){let e,n=t[l++];if(n<192)e=n-160;else switch(n){case 217:e=t[l++];break;case 218:e=a.getUint16(l),l+=2;break;case 219:e=a.getUint32(l),l+=4;break;default:throw new Error("Expected string")}return I(e)}function N(e){return c.copyBuffers?Uint8Array.prototype.slice.call(t,l,l+=e):t.subarray(l,l+=e)}function _(e){let n=t[l++];if(d[n]){let r;return d[n](t.subarray(l,r=l+=e),(e=>{l=e;try{return x()}finally{l=r}}))}throw new Error("Unknown extension type "+n)}var Q=new Array(4096);function U(){let e=t[l++];if(!(e>=160&&e<192))return l--,j(x());if(e-=160,f>=l)return o.slice(l-u,(l+=e)-u);if(!(0==f&&n<180))return T(e);let r,s=4095&(e<<5^(e>1?a.getUint16(l):e>0?t[l]:0)),i=Q[s],c=l,d=l+e-3,h=0;if(i&&i.bytes==e){for(;c{let n=x().map(j),o=e;void 0!==t&&(e=e<32?-((t<<5)+e):(t<<5)+e,n.highByte=t);let s=r[e];return s&&(s.isShared||m)&&((r.restoreStructures||(r.restoreStructures=[]))[e]=s),r[e]=n,n.read=S(n,o),n.read()};d[0]=()=>{},d[0].noBuffer=!0,d[66]=e=>{let t=e.length,n=BigInt(128&e[0]?e[0]-256:e[0]);for(let r=1;r{let e=x();return(z[e[0]]||Error)(e[1])},d[105]=e=>{if(!1===c.structuredClone)throw new Error("Structured clone extension is disabled");let n=a.getUint32(l-4);i||(i=new Map);let r,o=t[l];r=o>=144&&o<160||220==o||221==o?[]:{};let s={target:r};i.set(n,s);let u=x();return s.used?Object.assign(r,u):(s.target=u,u)},d[112]=e=>{if(!1===c.structuredClone)throw new Error("Structured clone extension is disabled");let t=a.getUint32(l-4),n=i.get(t);return n.used=!0,n.target},d[115]=()=>new Set(x());const H=["Int8","Uint8","Uint8Clamped","Int16","Uint16","Int32","Uint32","Float32","Float64","BigInt64","BigUint64"].map((e=>e+"Array"));let V="object"==typeof globalThis?globalThis:window;d[116]=e=>{let t=e[0],n=H[t];if(!n)throw new Error("Could not find typed array for code "+t);return new V[n](Uint8Array.prototype.slice.call(e,1).buffer)},d[120]=()=>{let e=x();return new RegExp(e[0],e[1])};const q=[];function W(e){let d=n,h=l,p=u,g=f,y=o,v=i,b=s,w=new Uint8Array(t.slice(0,n)),x=r,$=r.slice(0,r.length),S=c,k=m,E=e();return n=d,l=h,u=p,f=g,o=y,i=v,s=b,t=w,m=k,(r=x).splice(0,r.length,...$),c=S,a=new DataView(t.buffer,t.byteOffset,t.byteLength),E}function K(){t=null,i=null,r=null}d[98]=e=>{let t=(e[0]<<24)+(e[1]<<16)+(e[2]<<8)+e[3],n=l;return l+=t-e.length,s=q,(s=[M(),M()]).position0=0,s.position1=0,s.postBundlePosition=l,l=n,x()},d[255]=e=>4==e.length?new Date(1e3*(16777216*e[0]+(e[1]<<16)+(e[2]<<8)+e[3])):8==e.length?new Date(((e[0]<<22)+(e[1]<<14)+(e[2]<<6)+(e[3]>>2))/1e6+1e3*(4294967296*(3&e[3])+16777216*e[4]+(e[5]<<16)+(e[6]<<8)+e[7])):12==e.length?new Date(((e[0]<<24)+(e[1]<<16)+(e[2]<<8)+e[3])/1e6+1e3*((128&e[4]?-281474976710656:0)+1099511627776*e[6]+4294967296*e[7]+16777216*e[8]+(e[9]<<16)+(e[10]<<8)+e[11])):new Date("invalid");const J=new Array(147);for(let e=0;e<256;e++)J[e]=+("1e"+Math.floor(45.15-.30103*e));var G=new v({useRecords:!1});const Z=G.unpack;G.unpackMultiple,G.unpack;let Y,X,ee,te=new Float32Array(1);new Uint8Array(te.buffer,0,4);try{Y=new TextEncoder}catch(e){}const ne="undefined"!=typeof Buffer,re=ne?function(e){return Buffer.allocUnsafeSlow(e)}:Uint8Array,oe=ne?Buffer:Uint8Array,se=ne?4294967296:2144337920;let ie,ae,le,ce,ue=0,fe=null;const de=/[\u0080-\uFFFF]/,he=Symbol("record-id");function pe(e,t,n,r){let o=e.byteLength;if(o+1<256){var{target:s,position:i}=n(4+o);s[i++]=199,s[i++]=o+1}else if(o+1<65536){var{target:s,position:i}=n(5+o);s[i++]=200,s[i++]=o+1>>8,s[i++]=o+1&255}else{var{target:s,position:i,targetView:a}=n(7+o);s[i++]=201,a.setUint32(i,o+1),i+=4}s[i++]=116,s[i++]=t,s.set(new Uint8Array(e.buffer,e.byteOffset,e.byteLength),i)}function ge(e,t){let n=e.byteLength;var r,o;if(n<256){var{target:r,position:o}=t(n+2);r[o++]=196,r[o++]=n}else if(n<65536){var{target:r,position:o}=t(n+3);r[o++]=197,r[o++]=n>>8,r[o++]=255&n}else{var{target:r,position:o,targetView:s}=t(n+5);r[o++]=198,s.setUint32(o,n),o+=4}r.set(e,o)}function me(e,t,n,r){let o=e.length;switch(o){case 1:t[n++]=212;break;case 2:t[n++]=213;break;case 4:t[n++]=214;break;case 8:t[n++]=215;break;case 16:t[n++]=216;break;default:o<256?(t[n++]=199,t[n++]=o):o<65536?(t[n++]=200,t[n++]=o>>8,t[n++]=255&o):(t[n++]=201,t[n++]=o>>24,t[n++]=o>>16&255,t[n++]=o>>8&255,t[n++]=255&o)}return t[n++]=r,t.set(e,n),n+=o}function ye(e,t,n){if(fe.length>0){le.setUint32(fe.position+e,ue+n-fe.position-e),fe.stringsPosition=ue-e;let r=fe;fe=null,t(r[0]),t(r[1])}}ee=[Date,Set,Error,RegExp,ArrayBuffer,Object.getPrototypeOf(Uint8Array.prototype).constructor,p],X=[{pack(e,t,n){let r=e.getTime()/1e3;if((this.useTimestamp32||0===e.getMilliseconds())&&r>=0&&r<4294967296){let{target:e,targetView:n,position:o}=t(6);e[o++]=214,e[o++]=255,n.setUint32(o,r)}else if(r>0&&r<4294967296){let{target:n,targetView:o,position:s}=t(10);n[s++]=215,n[s++]=255,o.setUint32(s,4e6*e.getMilliseconds()+(r/1e3/4294967296|0)),o.setUint32(s+4,r)}else if(isNaN(r)){if(this.onInvalidDate)return t(0),n(this.onInvalidDate());let{target:e,targetView:r,position:o}=t(3);e[o++]=212,e[o++]=255,e[o++]=255}else{let{target:n,targetView:o,position:s}=t(15);n[s++]=199,n[s++]=12,n[s++]=255,o.setUint32(s,1e6*e.getMilliseconds()),o.setBigInt64(s+4,BigInt(Math.floor(r)))}}},{pack(e,t,n){if(this.setAsEmptyObject)return t(0),n({});let r=Array.from(e),{target:o,position:s}=t(this.moreTypes?3:0);this.moreTypes&&(o[s++]=212,o[s++]=115,o[s++]=0),n(r)}},{pack(e,t,n){let{target:r,position:o}=t(this.moreTypes?3:0);this.moreTypes&&(r[o++]=212,r[o++]=101,r[o++]=0),n([e.name,e.message])}},{pack(e,t,n){let{target:r,position:o}=t(this.moreTypes?3:0);this.moreTypes&&(r[o++]=212,r[o++]=120,r[o++]=0),n([e.source,e.flags])}},{pack(e,t){this.moreTypes?pe(e,16,t):ge(ne?Buffer.from(e):new Uint8Array(e),t)}},{pack(e,t){let n=e.constructor;n!==oe&&this.moreTypes?pe(e,H.indexOf(n.name),t):ge(e,t)}},{pack(e,t){let{target:n,position:r}=t(1);n[r]=193}}];let ve=new class extends v{constructor(e){let t,n,r,o;super(e),this.offset=0;let s=oe.prototype.utf8Write?function(e,t){return ie.utf8Write(e,t,4294967295)}:!(!Y||!Y.encodeInto)&&function(e,t){return Y.encodeInto(e,ie.subarray(t)).written},i=this;e||(e={});let a=e&&e.sequential,l=e.structures||e.saveStructures,c=e.maxSharedStructures;if(null==c&&(c=l?32:0),c>8160)throw new Error("Maximum maxSharedStructure is 8160");e.structuredClone&&null==e.moreTypes&&(this.moreTypes=!0);let u=e.maxOwnStructures;null==u&&(u=l?32:64),this.structures||0==e.useRecords||(this.structures=[]);let f=c>32||u+c>64,d=c+64,h=c+u+64;if(h>8256)throw new Error("Maximum maxSharedStructure + maxOwnStructure is 8192");let p=[],g=0,m=0;this.pack=this.encode=function(e,s){if(ie||(ie=new re(8192),le=ie.dataView||(ie.dataView=new DataView(ie.buffer,0,8192)),ue=0),ce=ie.length-10,ce-ue<2048?(ie=new re(ie.length),le=ie.dataView||(ie.dataView=new DataView(ie.buffer,0,ie.length)),ce=ie.length-10,ue=0):ue=ue+7&2147483640,t=ue,s&xe&&(ue+=255&s),o=i.structuredClone?new Map:null,i.bundleStrings&&"string"!=typeof e?(fe=[],fe.size=1/0):fe=null,r=i.structures,r){r.uninitialized&&(r=i._mergeStructures(i.getStructures()));let e=r.sharedLength||0;if(e>c)throw new Error("Shared structures is larger than maximum shared structures, try increasing maxSharedStructures to "+r.sharedLength);if(!r.transitions){r.transitions=Object.create(null);for(let t=0;te.offset>t.offset?1:-1)),r=e.length,s=-1;for(;n&&r>0;){let o=e[--r].offset+t;on.position+t?s>=0&&(s+=6):(s>=0&&(le.setUint32(n.position+t,le.getUint32(n.position+t)+s),s=-1),n=n.previous,r++)}s>=0&&n&&le.setUint32(n.position+t,le.getUint32(n.position+t)+s),ue+=6*e.length,ue>ce&&k(ue),i.offset=ue;let a=function(e,t){let n,r=6*t.length,o=e.length-r;for(;n=t.pop();){let t=n.offset,s=n.id;e.copyWithin(t+r,t,o),r-=6;let i=t+r;e[i++]=214,e[i++]=105,e[i++]=s>>24,e[i++]=s>>16&255,e[i++]=s>>8&255,e[i++]=255&s,o=t}return e}(ie.subarray(t,ue),e);return o=null,a}return i.offset=ue,s&be?(ie.start=t,ie.end=ue,ie):ie.subarray(t,ue)}catch(e){throw l=e,e}finally{if(r&&(y(),n&&i.saveStructures)){let n=r.sharedLength||0,o=ie.subarray(t,ue),a=function(e,t){return e.isCompatible=e=>{let n=!e||(t.lastNamedStructuresLength||0)===e.length;return n||t._mergeStructures(e),n},e}(r,i);if(!l)return!1===i.saveStructures(a,a.isCompatible)?i.pack(e,s):(i.lastNamedStructuresLength=n,o)}s&we&&(ue=t)}};const y=()=>{m<10&&m++;let e=r.sharedLength||0;if(r.length>e&&!a&&(r.length=e),g>1e4)r.transitions=null,m=0,g=0,p.length>0&&(p=[]);else if(p.length>0&&!a){for(let e=0,t=p.length;e{var t=e.length;t<16?ie[ue++]=144|t:t<65536?(ie[ue++]=220,ie[ue++]=t>>8,ie[ue++]=255&t):(ie[ue++]=221,le.setUint32(ue,t),ue+=4);for(let n=0;n{ue>ce&&(ie=k(ue));var n,r=typeof e;if("string"===r){let r,o=e.length;if(fe&&o>=4&&o<4096){if((fe.size+=o)>21760){let e,n,r=(fe[0]?3*fe[0].length+fe[1].length:0)+10;ue+r>ce&&(ie=k(ue+r)),fe.position?(n=fe,ie[ue]=200,ue+=3,ie[ue++]=98,e=ue-t,ue+=4,ye(t,b,0),le.setUint16(e+t-3,ue-t-e)):(ie[ue++]=214,ie[ue++]=98,e=ue-t,ue+=4),fe=["",""],fe.previous=n,fe.size=0,fe.position=e}let n=de.test(e);return fe[n?0:1]+=e,ie[ue++]=193,void b(n?-o:o)}r=o<32?1:o<256?2:o<65536?3:5;let i=3*o;if(ue+i>ce&&(ie=k(ue+i)),o<64||!s){let t,s,i,a=ue+r;for(t=0;t>6|192,ie[a++]=63&s|128):55296==(64512&s)&&56320==(64512&(i=e.charCodeAt(t+1)))?(s=65536+((1023&s)<<10)+(1023&i),t++,ie[a++]=s>>18|240,ie[a++]=s>>12&63|128,ie[a++]=s>>6&63|128,ie[a++]=63&s|128):(ie[a++]=s>>12|224,ie[a++]=s>>6&63|128,ie[a++]=63&s|128);n=a-ue-r}else n=s(e,ue+r);n<32?ie[ue++]=160|n:n<256?(r<2&&ie.copyWithin(ue+2,ue+1,ue+1+n),ie[ue++]=217,ie[ue++]=n):n<65536?(r<3&&ie.copyWithin(ue+3,ue+2,ue+2+n),ie[ue++]=218,ie[ue++]=n>>8,ie[ue++]=255&n):(r<5&&ie.copyWithin(ue+5,ue+3,ue+3+n),ie[ue++]=219,le.setUint32(ue,n),ue+=4),ue+=n}else if("number"===r)if(e>>>0===e)e<32||e<128&&!1===this.useRecords||e<64&&!this.randomAccessStructure?ie[ue++]=e:e<256?(ie[ue++]=204,ie[ue++]=e):e<65536?(ie[ue++]=205,ie[ue++]=e>>8,ie[ue++]=255&e):(ie[ue++]=206,le.setUint32(ue,e),ue+=4);else if((e|0)===e)e>=-32?ie[ue++]=256+e:e>=-128?(ie[ue++]=208,ie[ue++]=e+256):e>=-32768?(ie[ue++]=209,le.setInt16(ue,e),ue+=2):(ie[ue++]=210,le.setInt32(ue,e),ue+=4);else{let t;if((t=this.useFloat32)>0&&e<4294967296&&e>=-2147483648){let n;if(ie[ue++]=202,le.setFloat32(ue,e),t<4||((n=e*J[(127&ie[ue])<<1|ie[ue+1]>>7])|0)===n)return void(ue+=4);ue--}ie[ue++]=203,le.setFloat64(ue,e),ue+=8}else if("object"===r||"function"===r)if(e){if(o){let n=o.get(e);if(n){if(!n.id){let e=o.idsToInsert||(o.idsToInsert=[]);n.id=e.push(n)}return ie[ue++]=214,ie[ue++]=112,le.setUint32(ue,n.id),void(ue+=4)}o.set(e,{offset:ue-t})}let s=e.constructor;if(s===Object)S(e,!0);else if(s===Array)v(e);else if(s===Map)if(this.mapAsEmptyObject)ie[ue++]=128;else{(n=e.size)<16?ie[ue++]=128|n:n<65536?(ie[ue++]=222,ie[ue++]=n>>8,ie[ue++]=255&n):(ie[ue++]=223,le.setUint32(ue,n),ue+=4);for(let[t,n]of e)b(t),b(n)}else{for(let t=0,n=X.length;t(ie=o,o=null,ue+=e,ue>ce&&k(ue),{target:ie,targetView:le,position:ue-e})),b)}finally{o&&(ie=o,le=s,ue=i,ce=ie.length-10)}return void(r&&(r.length+ue>ce&&k(r.length+ue),ue=me(r,ie,ue,n.type)))}}if(Array.isArray(e))v(e);else{if(e.toJSON){const t=e.toJSON();if(t!==e)return b(t)}if("function"===r)return b(this.writeFunction&&this.writeFunction(e));S(e,!e.hasOwnProperty)}}}else ie[ue++]=192;else if("boolean"===r)ie[ue++]=e?195:194;else if("bigint"===r){if(e=-(BigInt(1)<0)ie[ue++]=207,le.setBigUint64(ue,e);else{if(!this.largeBigIntToFloat){if(this.useBigIntExtension&&e<2n**1023n&&e>-(2n**1023n)){ie[ue++]=199,ue++,ie[ue++]=66;let t,n=[];do{let r=0xffn&e;t=(0x80n&r)===(e<0n?0x80n:0n),n.push(r),e>>=8n}while(0n!==e&&-1n!==e||!t);ie[ue-2]=n.length;for(let e=n.length;e>0;)ie[ue++]=Number(n[--e]);return}throw new RangeError(e+" was too large to fit in MessagePack 64-bit integer format, use useBigIntExtension or set largeBigIntToFloat to convert to float-64")}ie[ue++]=203,le.setFloat64(ue,Number(e))}ue+=8}else{if("undefined"!==r)throw new Error("Unknown type: "+r);this.encodeUndefinedAsNil?ie[ue++]=192:(ie[ue++]=212,ie[ue++]=0,ie[ue++]=0)}},w=this.variableMapSize||this.coercibleKeyAsNumber?e=>{let t,n=Object.keys(e),r=n.length;if(r<16?ie[ue++]=128|r:r<65536?(ie[ue++]=222,ie[ue++]=r>>8,ie[ue++]=255&r):(ie[ue++]=223,le.setUint32(ue,r),ue+=4),this.coercibleKeyAsNumber)for(let o=0;o{ie[ue++]=222;let r=ue-t;ue+=2;let o=0;for(let t in e)(n||e.hasOwnProperty(t))&&(b(t),b(e[t]),o++);ie[r+++t]=o>>8,ie[r+t]=255&o},x=!1===this.useRecords?w:e.progressiveRecords&&!f?(e,n)=>{let o,s,i=r.transitions||(r.transitions=Object.create(null)),a=ue++-t;for(let l in e)if(n||e.hasOwnProperty(l)){if(o=i[l],o)i=o;else{let n=Object.keys(e),c=i;i=r.transitions;let u=0;for(let e=0,t=n.length;e{let n,o=r.transitions||(r.transitions=Object.create(null)),s=0;for(let r in e)(t||e.hasOwnProperty(r))&&(n=o[r],n||(n=o[r]=Object.create(null),s++),o=n);let i=o[he];i?i>=96&&f?(ie[ue++]=96+(31&(i-=96)),ie[ue++]=i>>5):ie[ue++]=i:E(o,o.__keys__||Object.keys(e),s);for(let n in e)(t||e.hasOwnProperty(n))&&b(e[n])},$="function"==typeof this.useRecords&&this.useRecords,S=$?(e,t)=>{$(e)?x(e,t):w(e,t)}:x,k=e=>{let n;if(e>16777216){if(e-t>se)throw new Error("Packed buffer would be larger than maximum buffer size");n=Math.min(se,4096*Math.round(Math.max((e-t)*(e>67108864?1.25:2),4194304)/4096))}else n=1+(Math.max(e-t<<2,ie.length-1)>>12)<<12;let r=new re(n);return le=r.dataView||(r.dataView=new DataView(r.buffer,0,n)),e=Math.min(e,ie.length),ie.copy?ie.copy(r,0,t,e):r.set(ie.slice(t,e)),ue-=t,t=0,ce=r.length-10,ie=r},E=(e,t,o)=>{let s=r.nextId;s||(s=64),s=h&&(s=d),r.nextId=s+1);let i=t.highByte=s>=96&&f?s-96>>5:-1;e[he]=s,e.__keys__=t,r[s-64]=t,s=0?(ie[ue++]=96+(31&s),ie[ue++]=i):ie[ue++]=s):(i>=0?(ie[ue++]=213,ie[ue++]=114,ie[ue++]=96+(31&s),ie[ue++]=i):(ie[ue++]=212,ie[ue++]=114,ie[ue++]=s),o&&(g+=m*o),p.length>=u&&(p.shift()[he]=0),p.push(e),b(t))},T=(e,n,r,o)=>{let s=ie,i=ue,a=ce,l=t;ie=ae,ue=0,t=0,ie||(ae=ie=new re(8192)),ce=ie.length-10,E(e,n,o),ae=ie;let c=ue;if(ie=s,ue=i,ce=a,t=l,c>1){let e=ue+c-1;e>ce&&k(e);let n=r+t;ie.copyWithin(n+c,n+1,ue),ie.set(ae.slice(0,c),n),ue=e}else ie[r+t]=ae[0]},L=(e,o)=>{let s=undefined(e,ie,t,ue,r,k,((e,t,r)=>{if(r)return n=!0;ue=t;let o=ie;return b(e),y(),o!==ie?{position:ue,targetView:le,target:ie}:ue}),this);if(0===s)return S(e,!0);ue=s}}useBuffer(e){ie=e,le=new DataView(ie.buffer,ie.byteOffset,ie.byteLength),ue=0}clearSharedData(){this.structures&&(this.structures=[]),this.typedStructs&&(this.typedStructs=[])}}({useRecords:!1});ve.pack,ve.pack;const be=512,we=1024,xe=2048;var $e=Uint8Array,Se=Uint16Array,ke=Int32Array,Ee=new $e([0,0,0,0,0,0,0,0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,0,0,0,0]),Te=new $e([0,0,0,0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9,9,10,10,11,11,12,12,13,13,0,0]),Le=new $e([16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15]),Ae=function(e,t){for(var n=new Se(31),r=0;r<31;++r)n[r]=t+=1<>1|(21845&Fe)<<1;Re=(61680&(Re=(52428&Re)>>2|(13107&Re)<<2))>>4|(3855&Re)<<4,De[Fe]=((65280&Re)>>8|(255&Re)<<8)>>1}var Me=function(e,t,n){for(var r=e.length,o=0,s=new Se(t);o>l]=c}else for(i=new Se(r),o=0;o>15-e[o]);return i},Ne=new $e(288);for(Fe=0;Fe<144;++Fe)Ne[Fe]=8;for(Fe=144;Fe<256;++Fe)Ne[Fe]=9;for(Fe=256;Fe<280;++Fe)Ne[Fe]=7;for(Fe=280;Fe<288;++Fe)Ne[Fe]=8;var _e=new $e(32);for(Fe=0;Fe<32;++Fe)_e[Fe]=5;var Qe=Me(Ne,9,1),Ue=Me(_e,5,1),je=function(e){for(var t=e[0],n=1;nt&&(t=e[n]);return t},Be=function(e,t,n){var r=t/8|0;return(e[r]|e[r+1]<<8)>>(7&t)&n},ze=function(e,t){var n=t/8|0;return(e[n]|e[n+1]<<8|e[n+2]<<16)>>(7&t)},He=["unexpected EOF","invalid block type","invalid length/literal","invalid distance","stream finished","no stream handler",,"no callback","invalid UTF-8 data","extra field too long","date not in range 1980-2099","filename too long","stream finishing","invalid zip data"],Ve=function(e,t,n){var r=new Error(t||He[e]);if(r.code=e,Error.captureStackTrace&&Error.captureStackTrace(r,Ve),!n)throw r;return r},qe=function(e,t,n,r){var o=e.length,s=r?r.length:0;if(!o||t.f&&!t.l)return n||new $e(0);var i=!n,a=i||2!=t.i,l=t.i;i&&(n=new $e(3*o));var c=function(e){var t=n.length;if(e>t){var r=new $e(Math.max(2*t,e));r.set(n),n=r}},u=t.f||0,f=t.p||0,d=t.b||0,h=t.l,p=t.d,g=t.m,m=t.n,y=8*o;do{if(!h){u=Be(e,f,1);var v=Be(e,f+1,3);if(f+=3,!v){var b=e[(I=4+((f+7)/8|0))-4]|e[I-3]<<8,w=I+b;if(w>o){l&&Ve(0);break}a&&c(d+b),n.set(e.subarray(I,w),d),t.b=d+=b,t.p=f=8*w,t.f=u;continue}if(1==v)h=Qe,p=Ue,g=9,m=5;else if(2==v){var x=Be(e,f,31)+257,$=Be(e,f+10,15)+4,S=x+Be(e,f+5,31)+1;f+=14;for(var k=new $e(S),E=new $e(19),T=0;T<$;++T)E[Le[T]]=Be(e,f+3*T,7);f+=3*$;var L=je(E),A=(1<>4)<16)k[T++]=I;else{var O=0,D=0;for(16==I?(D=3+Be(e,f,3),f+=2,O=k[T-1]):17==I?(D=3+Be(e,f,7),f+=3):18==I&&(D=11+Be(e,f,127),f+=7);D--;)k[T++]=O}}var F=k.subarray(0,x),R=k.subarray(x);g=je(F),m=je(R),h=Me(F,g,1),p=Me(R,m,1)}else Ve(1);if(f>y){l&&Ve(0);break}}a&&c(d+131072);for(var M=(1<>4;if((f+=15&O)>y){l&&Ve(0);break}if(O||Ve(2),Q<256)n[d++]=Q;else{if(256==Q){_=f,h=null;break}var U=Q-254;if(Q>264){var j=Ee[T=Q-257];U=Be(e,f,(1<>4;B||Ve(3),f+=15&B;R=Oe[z];if(z>3){j=Te[z];R+=ze(e,f)&(1<y){l&&Ve(0);break}a&&c(d+131072);var H=d+U;if(de.length)&&(n=e.length),new $e(e.subarray(t,n))}(n,0,d):n.subarray(0,d)},We=new $e(0);function Ke(e,t){return qe(e,{i:2},t&&t.out,t&&t.dictionary)}var Je="undefined"!=typeof TextDecoder&&new TextDecoder;try{Je.decode(We,{stream:!0}),1}catch(e){}const Ge="function"==typeof atob,Ze="function"==typeof Buffer;"function"==typeof TextDecoder&&new TextDecoder,"function"==typeof TextEncoder&&new TextEncoder;const Ye=Array.prototype.slice.call("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/="),Xe=(e=>{let t={};return Ye.forEach(((e,n)=>t[e]=n)),t})(),et=/^(?:[A-Za-z\d+\/]{4})*?(?:[A-Za-z\d+\/]{2}(?:==)?|[A-Za-z\d+\/]{3}=?)?$/,tt=String.fromCharCode.bind(String),nt="function"==typeof Uint8Array.from?Uint8Array.from.bind(Uint8Array):e=>new Uint8Array(Array.prototype.slice.call(e,0)),rt=e=>e.replace(/[^A-Za-z0-9\+\/]/g,""),ot=Ge?e=>atob(rt(e)):Ze?e=>Buffer.from(e,"base64").toString("binary"):e=>{if(e=e.replace(/\s+/g,""),!et.test(e))throw new TypeError("malformed base64.");e+="==".slice(2-(3&e.length));let t,n,r,o="";for(let s=0;s>16&255):64===r?tt(t>>16&255,t>>8&255):tt(t>>16&255,t>>8&255,255&t);return o},st=Ze?e=>nt(Buffer.from(e,"base64")):e=>nt(ot(e).split("").map((e=>e.charCodeAt(0)))),it=e=>rt(e.replace(/[-_]/g,(e=>"-"==e?"+":"/")));function at(){}const lt=e=>e;function ct(e,t){for(const n in t)e[n]=t[n];return e}function ut(e){return e()}function ft(){return Object.create(null)}function dt(e){e.forEach(ut)}function ht(e){return"function"==typeof e}function pt(e,t){return e!=e?t==t:e!==t||e&&"object"==typeof e||"function"==typeof e}let gt;function mt(e,t){return e===t||(gt||(gt=document.createElement("a")),gt.href=t,e===gt.href)}function yt(e,...t){if(null==e){for(const e of t)e(void 0);return at}const n=e.subscribe(...t);return n.unsubscribe?()=>n.unsubscribe():n}function vt(e){let t;return yt(e,(e=>t=e))(),t}function bt(e,t,n){e.$$.on_destroy.push(yt(t,n))}function wt(e,t,n,r){if(e){const o=xt(e,t,n,r);return e[0](o)}}function xt(e,t,n,r){return e[1]&&r?ct(n.ctx.slice(),e[1](r(t))):n.ctx}function $t(e,t,n,r){if(e[2]&&r){const o=e[2](r(n));if(void 0===t.dirty)return o;if("object"==typeof o){const e=[],n=Math.max(t.dirty.length,o.length);for(let r=0;r32){const t=[],n=e.ctx.length/32;for(let e=0;ewindow.performance.now():()=>Date.now(),It=At?e=>requestAnimationFrame(e):at;const Pt=new Set;function Ot(e){Pt.forEach((t=>{t.c(e)||(Pt.delete(t),t.f())})),0!==Pt.size&&It(Ot)}const Dt="undefined"!=typeof window?window:"undefined"!=typeof globalThis?globalThis:global;function Ft(e,t){e.appendChild(t)}function Rt(e){if(!e)return document;const t=e.getRootNode?e.getRootNode():e.ownerDocument;return t&&t.host?t:e.ownerDocument}function Mt(e){const t=Qt("style");return t.textContent="/* empty */",function(e,t){Ft(e.head||e,t),t.sheet}(Rt(e),t),t.sheet}function Nt(e,t,n){e.insertBefore(t,n||null)}function _t(e){e.parentNode&&e.parentNode.removeChild(e)}function Qt(e){return document.createElement(e)}function Ut(e){return document.createElementNS("http://www.w3.org/2000/svg",e)}function jt(e){return document.createTextNode(e)}function Bt(){return jt(" ")}function zt(){return jt("")}function Ht(e,t,n,r){return e.addEventListener(t,n,r),()=>e.removeEventListener(t,n,r)}function Vt(e){return function(t){return t.stopPropagation(),e.call(this,t)}}function qt(e,t,n){null==n?e.removeAttribute(t):e.getAttribute(t)!==n&&e.setAttribute(t,n)}function Wt(e,t){t=""+t,e.data!==t&&(e.data=t)}function Kt(e,t){e.value=null==t?"":t}function Jt(e,t,n,r){null==n?e.style.removeProperty(t):e.style.setProperty(t,n,r?"important":"")}function Gt(e,t,n){e.classList.toggle(t,!!n)}function Zt(e,t){return new e(t)}const Yt=new Map;let Xt,en=0;function tn(e,t,n,r,o,s,i,a=0){const l=16.666/r;let c="{\n";for(let e=0;e<=1;e+=l){const r=t+(n-t)*s(e);c+=100*e+`%{${i(r,1-r)}}\n`}const u=c+`100% {${i(n,1-n)}}\n}`,f=`__svelte_${function(e){let t=5381,n=e.length;for(;n--;)t=(t<<5)-t^e.charCodeAt(n);return t>>>0}(u)}_${a}`,d=Rt(e),{stylesheet:h,rules:p}=Yt.get(d)||function(e,t){const n={stylesheet:Mt(t),rules:{}};return Yt.set(e,n),n}(d,e);p[f]||(p[f]=!0,h.insertRule(`@keyframes ${f} ${u}`,h.cssRules.length));const g=e.style.animation||"";return e.style.animation=`${g?`${g}, `:""}${f} ${r}ms linear ${o}ms 1 both`,en+=1,f}function nn(e,t){const n=(e.style.animation||"").split(", "),r=n.filter(t?e=>e.indexOf(t)<0:e=>-1===e.indexOf("__svelte")),o=n.length-r.length;o&&(e.style.animation=r.join(", "),en-=o,en||It((()=>{en||(Yt.forEach((e=>{const{ownerNode:t}=e.stylesheet;t&&_t(t)})),Yt.clear())})))}function rn(e){Xt=e}function on(){if(!Xt)throw new Error("Function called outside component initialization");return Xt}function sn(e,t){return on().$$.context.set(e,t),t}function an(e){return on().$$.context.get(e)}function ln(e,t){const n=e.$$.callbacks[t.type];n&&n.slice().forEach((e=>e.call(this,t)))}const cn=[],un=[];let fn=[];const dn=[],hn=Promise.resolve();let pn=!1;function gn(){pn||(pn=!0,hn.then(xn))}function mn(){return gn(),hn}function yn(e){fn.push(e)}const vn=new Set;let bn,wn=0;function xn(){if(0!==wn)return;const e=Xt;do{try{for(;wn{kn.delete(e),r&&(n&&e.d(1),r())})),e.o(t)}else r&&r()}const In={duration:0};function Pn(e,t,n,r){let o,s=t(e,n,{direction:"both"}),i=r?0:1,a=null,l=null,c=null;function u(){c&&nn(e,c)}function f(e,t){const n=e.b-i;return t*=Math.abs(n),{a:i,b:e.b,d:n,duration:t,start:e.start,end:e.start+t,group:e.group}}function d(t){const{delay:n=0,duration:r=300,easing:d=lt,tick:h=at,css:p}=s||In,g={start:Ct()+n,b:t};t||(g.group=En,En.r+=1),"inert"in e&&(t?void 0!==o&&(e.inert=o):(o=e.inert,e.inert=!0)),a||l?l=g:(p&&(u(),c=tn(e,i,t,r,n,d,p)),t&&h(0,1),a=f(g,r),yn((()=>Sn(e,t,"start"))),function(e){let t;0===Pt.size&&It(Ot),new Promise((n=>{Pt.add(t={c:e,f:n})}))}((t=>{if(l&&t>l.start&&(a=f(l,r),l=null,Sn(e,a.b,"start"),p&&(u(),c=tn(e,i,a.b,a.duration,0,d,s.css))),a)if(t>=a.end)h(i=a.b,1-i),Sn(e,a.b,"end"),l||(a.b?u():--a.group.r||dt(a.group.c)),a=null;else if(t>=a.start){const e=t-a.start;i=a.a+a.d*d(e/a.duration),h(i,1-i)}return!(!a&&!l)})))}return{run(e){ht(s)?(bn||(bn=Promise.resolve(),bn.then((()=>{bn=null}))),bn).then((()=>{s=s({direction:e?"in":"out"}),d(e)})):d(e)},end(){u(),a=l=null}}}function On(e){return void 0!==e?.length?e:Array.from(e)}function Dn(e,t){e.d(1),t.delete(e.key)}function Fn(e,t){Cn(e,1,1,(()=>{t.delete(e.key)}))}function Rn(e,t,n,r,o,s,i,a,l,c,u,f){let d=e.length,h=s.length,p=d;const g={};for(;p--;)g[e[p].key]=p;const m=[],y=new Map,v=new Map,b=[];for(p=h;p--;){const e=f(o,s,p),a=n(e);let l=i.get(a);l?r&&b.push((()=>l.p(e,t))):(l=c(a,e),l.c()),y.set(a,m[p]=l),a in g&&v.set(a,Math.abs(p-g[a]))}const w=new Set,x=new Set;function $(e){An(e,1),e.m(a,u),i.set(e.key,e),u=e.first,h--}for(;d&&h;){const t=m[h-1],n=e[d-1],r=t.key,o=n.key;t===n?(u=t.first,d--,h--):y.has(o)?!i.has(r)||w.has(r)?$(t):x.has(o)?d--:v.get(r)>v.get(o)?(x.add(r),$(t)):(w.add(o),d--):(l(n,i),d--)}for(;d--;){const t=e[d];y.has(t.key)||l(t,i)}for(;h;)$(m[h-1]);return dt(b),m}function Mn(e,t){const n={},r={},o={$$scope:1};let s=e.length;for(;s--;){const i=e[s],a=t[s];if(a){for(const e in i)e in a||(r[e]=1);for(const e in a)o[e]||(n[e]=a[e],o[e]=1);e[s]=a}else for(const e in i)o[e]=1}for(const e in r)e in n||(n[e]=void 0);return n}function Nn(e){return"object"==typeof e&&null!==e?e:{}}function _n(e){e&&e.c()}function Qn(e,t,n){const{fragment:r,after_update:o}=e.$$;r&&r.m(t,n),yn((()=>{const t=e.$$.on_mount.map(ut).filter(ht);e.$$.on_destroy?e.$$.on_destroy.push(...t):dt(t),e.$$.on_mount=[]})),o.forEach(yn)}function Un(e,t){const n=e.$$;null!==n.fragment&&(!function(e){const t=[],n=[];fn.forEach((r=>-1===e.indexOf(r)?t.push(r):n.push(r))),n.forEach((e=>e())),fn=t}(n.after_update),dt(n.on_destroy),n.fragment&&n.fragment.d(t),n.on_destroy=n.fragment=null,n.ctx=[])}function jn(e,t,n,r,o,s,i=null,a=[-1]){const l=Xt;rn(e);const c=e.$$={fragment:null,ctx:[],props:s,update:at,not_equal:o,bound:ft(),on_mount:[],on_destroy:[],on_disconnect:[],before_update:[],after_update:[],context:new Map(t.context||(l?l.$$.context:[])),callbacks:ft(),dirty:a,skip_bound:!1,root:t.target||l.$$.root};i&&i(c.root);let u=!1;if(c.ctx=n?n(e,t.props||{},((t,n,...r)=>{const s=r.length?r[0]:n;return c.ctx&&o(c.ctx[t],c.ctx[t]=s)&&(!c.skip_bound&&c.bound[t]&&c.bound[t](s),u&&function(e,t){-1===e.$$.dirty[0]&&(cn.push(e),gn(),e.$$.dirty.fill(0)),e.$$.dirty[t/31|0]|=1<{const e=n.indexOf(t);-1!==e&&n.splice(e,1)}}$set(e){var t;this.$$set&&(t=e,0!==Object.keys(t).length)&&(this.$$.skip_bound=!0,this.$$set(e),this.$$.skip_bound=!1)}}const zn=[];function Hn(e,t=at){let n;const r=new Set;function o(t){if(pt(e,t)&&(e=t,n)){const t=!zn.length;for(const t of r)t[1](),zn.push(t,e);if(t){for(let e=0;e{r.delete(l),0===r.size&&n&&(n(),n=null)}}}}function Vn(e,t,n){const r=!Array.isArray(e),o=r?[e]:e;if(!o.every(Boolean))throw new Error("derived() expects stores as input, got a falsy value");const s=t.length<2;return i=(e,n)=>{let i=!1;const a=[];let l=0,c=at;const u=()=>{if(l)return;c();const o=t(r?a[0]:a,e,n);s?e(o):c=ht(o)?o:at},f=o.map(((e,t)=>yt(e,(e=>{a[t]=e,l&=~(1<{l|=1<{let n=!1;const r=[];let o,i=0;const c=()=>{if(i)return;o?.();const n=a?r[0]:r;if(s.length<2)e(s(n));else{const r=s(n,e,t);"function"==typeof r&&(o=r)}},u=l.map(((e,t)=>e.subscribe((e=>{r[t]=e,i&=~(1<{i|=1<e())),o?.()}}))},storage:e,serialize:t,deserialize:n}}const Wn=qn({storage:globalThis?.localStorage}),Kn=qn({storage:globalThis?.sessionStorage});class Jn{#e;#t=new Map;constructor(e){this.#e=e}#n(e,t=void 0,n){try{const r=this.#e.storage.getItem(e);if(null!==r){t=(n?.deserialize??this.#e.deserialize)(r)}}catch(e){}return(n?.writable??this.#e.writable)(e,t)}#r(e){return this.#t.get(e)?.deserialize??this.#e.deserialize}#o(e){return this.#t.get(e)?.serialize??this.#e.serialize}#s(e,t=void 0,n){const r=this.#t.get(e);if(r)return r.store;const o=this.#n(e,t,n);return this.#t.set(e,{store:o,deserialize:n?.deserialize,serialize:n?.serialize}),o}getItem(e,t){let n=t;const r=this.#e.storage.getItem(e);if(null!==r)try{n=this.#r(e)(r)}catch(e){n=t}else if(void 0!==t)try{const n=this.#o(e)(t);this.#e.storage.setItem(e,n)}catch(e){}return n}getStore(e,t,n){return this.#s(e,t,n)}setItem(e,t){this.#s(e).set(t)}swapItemBoolean(e,t){const n=this.#s(e,t);let r=!1;try{r=!!this.#r(e)(this.#e.storage.getItem(e))}catch(e){}const o="boolean"==typeof r&&!r;return n.set(o),o}*entries(e=void 0){if(void 0!==e&&!(e instanceof RegExp))throw new TypeError("'regex' is not a RegExp");if(this.#t.size)if(e)for(const t of this.#t.keys())e.test(t)&&(yield[t,this.getStore(t)]);else for(const e of this.#t.keys())yield[e,this.getStore(e)]}*keys(e=void 0){if(void 0!==e&&!(e instanceof RegExp))throw new TypeError("'regex' is not a RegExp");if(this.#t.size)if(e)for(const t of this.#t.keys())e.test(t)&&(yield t);else for(const e of this.#t.keys())yield e}*stores(e=void 0){if(void 0!==e&&!(e instanceof RegExp))throw new TypeError("'regex' is not a RegExp");if(this.#t.size)if(e)for(const t of this.#t.keys())e.test(t)&&(yield this.getStore(t));else for(const e of this.#t.keys())yield this.getStore(e)}}class Gn extends Jn{constructor(){super(Kn)}}function Zn(e){return null!=e&&"object"==typeof e&&Symbol.iterator in e}function Yn(e){return null!==e&&"object"==typeof e&&!Array.isArray(e)}class Xn{static#i=new Set(["KeyboardEvent","MouseEvent","PointerEvent"]);static#a=new Set(["MouseEvent","PointerEvent"]);static#l=!1;static get debug(){return this.#l}static set debug(e){if("boolean"!=typeof e)throw new TypeError("'debug' is not a boolean.");this.#l=e}static get prefersReducedMotion(){return globalThis?.matchMedia("(prefers-reduced-motion: reduce)")?.matches??!1}static applyFocusSource(e){if(!Yn(e))return;const t=Yn(e?.focusSource)?e.focusSource:e;setTimeout((()=>{const e="boolean"==typeof t.debug?this.debug||t.debug:this.debug;if(Zn(t.focusEl)){e&&console.debug("A11yHelper.applyFocusSource debug - Attempting to apply focus target: ",t.focusEl);for(const n of t.focusEl){if(n?.nodeType===Node.ELEMENT_NODE&&n?.isConnected){n?.focus(),e&&console.debug("A11yHelper.applyFocusSource debug - Applied focus to target: ",n);break}if("string"==typeof n){const t=document.querySelector(n);if(t?.nodeType===Node.ELEMENT_NODE&&t?.isConnected){t?.focus(),e&&console.debug("A11yHelper.applyFocusSource debug - Applied focus to target: ",t);break}e&&console.debug("A11yHelper.applyFocusSource debug - Could not query selector: ",n)}}}else e&&console.debug("A11yHelper.applyFocusSource debug - No focus targets defined.")}),0)}static getFirstFocusableElement(e=document,t){const n=this.getFocusableElements(e,t);return n.length>0?n[0]:void 0}static getFocusableElements(e=document,{anchorHref:t=!0,ignoreClasses:n,ignoreElements:r,selectors:o}={}){if(e?.nodeType!==Node.ELEMENT_NODE&&e?.nodeType!==Node.DOCUMENT_NODE)throw new TypeError("'element' is not a HTMLElement, SVGElement, or Document instance.");if("boolean"!=typeof t)throw new TypeError("'anchorHref' is not a boolean.");if(void 0!==n&&!Zn(n))throw new TypeError("'ignoreClasses' is not an iterable list.");if(void 0!==r&&!(r instanceof Set))throw new TypeError("'ignoreElements' is not a Set.");if(void 0!==o&&"string"!=typeof o)throw new TypeError("'selectors' is not a string.");const s=o??this.#c(t),i=[...e.querySelectorAll(s)];return r&&n?i.filter((e=>{let t=!1;for(const r of n)if(e.classList.contains(r)){t=!0;break}return!(t||r.has(e)||"none"===e.style.display||"hidden"===e.style.visibility||e.hasAttribute("disabled")||e.hasAttribute("inert")||"true"===e.getAttribute("aria-hidden"))})):n?i.filter((e=>{let t=!1;for(const r of n)if(e.classList.contains(r)){t=!0;break}return!t&&"none"!==e.style.display&&"hidden"!==e.style.visibility&&!e.hasAttribute("disabled")&&!e.hasAttribute("inert")&&"true"!==e.getAttribute("aria-hidden")})):r?i.filter((e=>!r.has(e)&&"none"!==e.style.display&&"hidden"!==e.style.visibility&&!e.hasAttribute("disabled")&&!e.hasAttribute("inert")&&"true"!==e.getAttribute("aria-hidden"))):i.filter((e=>"none"!==e.style.display&&"hidden"!==e.style.visibility&&!e.hasAttribute("disabled")&&!e.hasAttribute("inert")&&"true"!==e.getAttribute("aria-hidden")))}static#c(e=!0){return`button, [contenteditable=""], [contenteditable="true"], details summary:not([tabindex="-1"]), embed, a${e?"[href]":""}, iframe, object, input:not([type=hidden]), select, textarea, [tabindex]:not([tabindex="-1"])`}static getFocusSource({event:e,x:t,y:n,focusEl:r,debug:o=!1}){if(void 0!==r&&!this.isFocusSource(r))throw new TypeError("A11yHelper.getFocusSource error: 'focusEl' is not a HTMLElement, SVGElement, or string.");if(void 0!==o&&"boolean"!=typeof o)throw new TypeError("A11yHelper.getFocusSource error: 'debug' is not a boolean.");const s="boolean"==typeof o?this.debug||o:this.debug;if(void 0===e){if("number"!=typeof t)throw new TypeError("A11yHelper.getFocusSource error: 'event' not defined and 'x' is not a number.");if("number"!=typeof n)throw new TypeError("A11yHelper.getFocusSource error: 'event' not defined and 'y' is not a number.");const e={debug:o,focusEl:void 0!==r?[r]:void 0,x:t,y:n};return s&&console.debug("A11yHelper.getFocusSource debug: generated 'focusSource' without event: ",e),e}if(!Xn.#i.has(e?.constructor?.name))throw new TypeError("A11yHelper.getFocusSource error: 'event' is not a KeyboardEvent, MouseEvent, or PointerEvent.");if(void 0!==t&&!Number.isInteger(t))throw new TypeError("A11yHelper.getFocusSource error: 'x' is not a number.");if(void 0!==n&&!Number.isInteger(n))throw new TypeError("A11yHelper.getFocusSource error: 'y' is not a number.");let i;if(e&&(Xn.isFocusable(e.target)?(i=e.target,s&&console.debug("A11yHelper.getFocusSource debug: 'targetEl' set to event.target: ",i)):Xn.isFocusable(e.currentTarget)?(i=e.currentTarget,s&&console.debug("A11yHelper.getFocusSource debug: 'targetEl' set to event.currentTarget: ",i)):s&&(console.debug("A11yHelper.getFocusSource debug: 'event.target' / 'event.currentTarget' are not focusable."),console.debug("A11yHelper.getFocusSource debug: 'event.target': ",e.target),console.debug("A11yHelper.getFocusSource debug: 'event.currentTarget': ",e.currentTarget)),i&&i?.nodeType!==Node.ELEMENT_NODE&&"function"!=typeof i?.focus))throw new TypeError("A11yHelper.getFocusSource error: 'targetEl' is not an HTMLElement or SVGElement.");const a={debug:o};if(Xn.#a.has(e?.constructor?.name))if(2!==e?.button&&"contextmenu"===e.type){const o=(i??e.target).getBoundingClientRect();a.source="keyboard",a.x=t??o.left+o.width/2,a.y=n??o.top+o.height/2,a.focusEl=i?[i]:[],r&&a.focusEl.push(r)}else a.source="pointer",a.x=t??e.pageX,a.y=n??e.pageY,a.focusEl=i?[i]:[],r&&a.focusEl.push(r);else{const o=(i??e.target).getBoundingClientRect();a.source="keyboard",a.x=t??o.left+o.width/2,a.y=n??o.top+o.height/2,a.focusEl=i?[i]:[],r&&a.focusEl.push(r)}return s&&console.debug("A11yHelper.getFocusSource debug: generated 'focusSource' with event: ",a),a}static getLastFocusableElement(e=document,t){const n=this.getFocusableElements(e,t);return n.length>0?n[n.length-1]:void 0}static isFocusable(e,{anchorHref:t=!0,ignoreClasses:n}={}){if(null==e||e?.hidden||!e?.isConnected||e?.nodeType!==Node.ELEMENT_NODE||"function"!=typeof e?.focus)return!1;if("boolean"!=typeof t)throw new TypeError("'anchorHref' is not a boolean.");if(void 0!==n&&!Zn(n))throw new TypeError("'ignoreClasses' is not an iterable list.");const r=e.getAttribute("contenteditable"),o="string"==typeof r&&(""===r||"true"===r),s=globalThis.parseInt(e.getAttribute("tabindex")),i=Number.isInteger(s)&&s>=0,a=e instanceof HTMLAnchorElement;return!!(o||i||a||e instanceof HTMLButtonElement||e instanceof HTMLDetailsElement||e instanceof HTMLEmbedElement||e instanceof HTMLIFrameElement||e instanceof HTMLInputElement||e instanceof HTMLObjectElement||e instanceof HTMLSelectElement||e instanceof HTMLTextAreaElement)&&(!(a&&!i&&t&&"string"!=typeof e.getAttribute("href"))&&("none"!==e.style.display&&"hidden"!==e.style.visibility&&!e.hasAttribute("disabled")&&!e.hasAttribute("inert")&&"true"!==e.getAttribute("aria-hidden")))}static isFocusSource(e){return"string"==typeof e||e?.nodeType===Node.ELEMENT_NODE&&"function"==typeof e?.focus}static isFocusTarget(e){return null!=e&&e?.nodeType===Node.ELEMENT_NODE&&"function"==typeof e?.focus}static isFocusWithin(e,t=globalThis){if(null==e||e?.hidden||!e?.isConnected)return!1;if("[object Window]"!==Object.prototype.toString.call(t))return!1;let n=t.document.activeElement;for(;n;){if(n===e)return!0;n=n.parentElement}return!1}}async function er(e=1){if(!Number.isInteger(e)||e<1)throw new TypeError("nextAnimationFrame error: 'cntr' must be a positive integer greater than 0.");let t=performance.now();for(;--e>=0;)t=await new Promise((e=>requestAnimationFrame(e)));return t}function tr(e){let t,n,r=e[0].text+"";return{c(){t=Qt("span"),n=jt(r),qt(t,"class","svelte-8p5j4n"),Gt(t,"indent-icon","indent-icon"===e[1]),Gt(t,"indent-no-icon","indent-no-icon"===e[1])},m(e,r){Nt(e,t,r),Ft(t,n)},p(e,o){1&o&&r!==(r=e[0].text+"")&&Wt(n,r),2&o&&Gt(t,"indent-icon","indent-icon"===e[1]),2&o&&Gt(t,"indent-no-icon","indent-no-icon"===e[1])},d(e){e&&_t(t)}}}function nr(e){let t,n,r,o,s,i,a=e[0].text+"",l=e[5]&&function(e){let t,n;return{c(){t=Ut("svg"),n=Ut("use"),qt(n,"href",`#icon-${e[5]}`),qt(t,"class","tsd-kind-icon svelte-8p5j4n"),qt(t,"viewBox","0 0 24 24")},m(e,r){Nt(e,t,r),Ft(t,n)},p:at,d(e){e&&_t(t)}}}(e);return{c(){t=Qt("a"),l&&l.c(),n=Bt(),r=Qt("span"),o=jt(a),qt(r,"class","svelte-8p5j4n"),qt(t,"href",e[6]),qt(t,"data-storage-key",e[2]),qt(t,"class","svelte-8p5j4n"),Gt(t,"current",e[3]),Gt(t,"indent-icon","indent-icon"===e[1]),Gt(t,"indent-no-icon","indent-no-icon"===e[1])},m(a,c){var u;Nt(a,t,c),l&&l.m(t,null),Ft(t,n),Ft(t,r),Ft(r,o),s||(i=Ht(t,"click",Vt((u=e[7],function(e){return e.preventDefault(),u.call(this,e)}))),s=!0)},p(e,n){e[5]&&l.p(e,n),1&n&&a!==(a=e[0].text+"")&&Wt(o,a),4&n&&qt(t,"data-storage-key",e[2]),8&n&&Gt(t,"current",e[3]),2&n&&Gt(t,"indent-icon","indent-icon"===e[1]),2&n&&Gt(t,"indent-no-icon","indent-no-icon"===e[1])},d(e){e&&_t(t),l&&l.d(),s=!1,i()}}}function rr(e){let t;let n=function(e,t){return e[6]?nr:tr}(e),r=n(e);return{c(){r.c(),t=zt()},m(e,n){r.m(e,n),Nt(e,t,n)},p(e,[t]){r.p(e,t)},i:at,o:at,d(e){e&&_t(t),r.d(e)}}}function or(e,t,n){let r,o,{entry:s}=t,{removeIcon:i=!1}=t,{indentIcon:a}=t,{storageKey:l=null}=t;const{basePath:c,storeCurrentPathURL:u}=an("#navigationData");bt(e,u,(e=>n(9,o=e)));const f=!i&&s.kind?s.kind:void 0,d=s.path?`${c}${s.path}`:void 0;return e.$$set=e=>{"entry"in e&&n(0,s=e.entry),"removeIcon"in e&&n(8,i=e.removeIcon),"indentIcon"in e&&n(1,a=e.indentIcon),"storageKey"in e&&n(2,l=e.storageKey)},e.$$.update=()=>{513&e.$$.dirty&&n(3,r=!!s.path&&s.path===o)},[s,a,l,r,u,f,d,function(){globalThis.location.href=d},i,o]}"undefined"!=typeof window&&(window.__svelte||(window.__svelte={v:new Set})).v.add("4");const sr=class extends Bn{constructor(e){super(),jn(this,e,or,rr,pt,{entry:0,removeIcon:8,indentIcon:1,storageKey:2})}};function ir(e){if(null==e)return!1;switch(typeof e){case"function":case"object":return"function"==typeof e.subscribe&&"function"==typeof e.set}return!1}function ar(e,t,n){let r=!1;return e.subscribe((e=>{r?n(e):(r=!0,t(e))}))}function lr(e,{store:t,animate:n=!0,clickActive:r=!0}={}){e.dataset.closing="false";const o=e.querySelector("summary");let s,i=null;for(const t of e.children)if("SUMMARY"!==t.tagName){i=t;break}let a=e.open,l=ar(t,(t=>{a=t,e.open=a}),(async e=>{a=e,await mn(),u()}));function c(t,r,o){const a=Math.max(0,30*Math.log(Math.abs(r-t)+Number.EPSILON));n?(e.style.overflow="hidden",i&&(i.style.overflow="hidden"),s=e.animate({height:[`${t}px`,`${r}px`]},{duration:a,easing:"ease-out"}),s.onfinish=()=>{e.open=o,e.dataset.closing="false",e.style.overflow=null,i&&(i.style.overflow=null)}):(e.open=o,e.dataset.closing="false",e.style.overflow=null,i&&(i.style.overflow=null))}function u(){if(a){const t=e.offsetHeight;s&&s.cancel(),e.open=!0;c(t,e.offsetHeight,!0)}else{const t=e.offsetHeight;s&&s.cancel();const n=o.offsetHeight;e.dataset.closing="true",c(t,n,!1)}}function f(e){r&&(e.preventDefault(),t.set(!a))}return o.addEventListener("click",f),{update(o){ir(o.store)&&o.store!==t&&("function"==typeof l&&l(),t=o.store,l=ar(t,(t=>{a=t,e.open=a}),(async e=>{a=e,await mn(),u()}))),"boolean"==typeof o.animate&&(n=o.animate),"boolean"==typeof o.clickActive&&(r=o.clickActive)},destroy(){l(),o.removeEventListener("click",f)}}}const cr=new Map,ur=1,fr=2,dr=3,hr=4,pr=5,gr=6,mr=7;function yr(e,t,n){const r=e.styles;e.contentWidth=t,e.contentHeight=n;const o=Number.isFinite(t)?t+r.additionalWidth:void 0,s=Number.isFinite(n)?n+r.additionalHeight:void 0,i=e.target;switch(e.updateType){case ur:i.contentWidth=t,i.contentHeight=n,i.offsetWidth=o,i.offsetHeight=s;break;case fr:i?.(o,s,t,n);break;case dr:i.resizeObserved?.(o,s,t,n);break;case hr:i.setContentBounds?.(t,n);break;case pr:i.setDimension?.(o,s);break;case gr:i.resizeObserved.update((e=>(e.contentHeight=n,e.contentWidth=t,e.offsetHeight=s,e.offsetWidth=o,e)));break;case mr:i.stores.resizeObserved.update((e=>(e.contentHeight=n,e.contentWidth=t,e.offsetHeight=s,e.offsetWidth=o,e)))}}function vr(e,t){function n(){if(Yn(t))for(const n of Object.keys(t))e.style.setProperty(`${n}`,t[n])}return n(),{update:e=>{t=e,n()}}}function br(e){if(null==e||"function"!=typeof e)return!1;const t=e?.prototype?.constructor?.name;return!("string"!=typeof t||!t.startsWith("Proxy<")&&"ProxyComponent"!==t)||("undefined"!=typeof window?"function"==typeof e.prototype.$destroy&&"function"==typeof e.prototype.$on:"function"==typeof e.render)}new ResizeObserver((e=>{for(const t of e){const e=cr.get(t?.target);if(Array.isArray(e)){const n=t.contentRect.width,r=t.contentRect.height;for(const t of e)yr(t,n,r)}}}));const wr=e=>({}),xr=e=>({}),$r=e=>({}),Sr=e=>({});function kr(e){let t;return{c(){t=Qt("div"),qt(t,"class","tjs-folder-focus-indicator svelte-9arcsc")},m(e,n){Nt(e,t,n)},d(e){e&&_t(t)}}}function Er(e){let t,n;return{c(){t=Qt("div"),n=jt(e[2]),qt(t,"class","label svelte-9arcsc")},m(r,o){Nt(r,t,o),Ft(t,n),e[36](t)},p(e,t){4&t[0]&&Wt(n,e[2])},i:at,o:at,d(n){n&&_t(t),e[36](null)}}}function Tr(e){let t,n,r;const o=[Yn(e[5]?.slotLabel?.props)?e[5].slotLabel.props:{}];var s=e[5].slotLabel.class;function i(e,t){let n={};for(let e=0;e{Un(e,1)})),Ln()}s?(t=Zt(s,i(e,r)),_n(t.$$.fragment),An(t.$$.fragment,1),Qn(t,n.parentNode,n)):t=null}else if(s){const n=32&r[0]?Mn(o,[Nn(Yn(e[5]?.slotLabel?.props)?e[5].slotLabel.props:{})]):{};t.$set(n)}},i(e){r||(t&&An(t.$$.fragment,e),r=!0)},o(e){t&&Cn(t.$$.fragment,e),r=!1},d(e){e&&_t(n),t&&Un(t,e)}}}function Lr(e){let t,n,r;const o=[Yn(e[5]?.slotSummaryEnd?.props)?e[5].slotSummaryEnd.props:{}];var s=e[5].slotSummaryEnd.class;function i(e,t){let n={};for(let e=0;e{Un(e,1)})),Ln()}s?(t=Zt(s,i(e,r)),_n(t.$$.fragment),An(t.$$.fragment,1),Qn(t,n.parentNode,n)):t=null}else if(s){const n=32&r[0]?Mn(o,[Nn(Yn(e[5]?.slotSummaryEnd?.props)?e[5].slotSummaryEnd.props:{})]):{};t.$set(n)}},i(e){r||(t&&An(t.$$.fragment,e),r=!0)},o(e){t&&Cn(t.$$.fragment,e),r=!1},d(e){e&&_t(n),t&&Un(t,e)}}}function Ar(e){let t;const n=e[27].default,r=wt(n,e,e[26],null),o=r||function(e){let t,n,r=br(e[5]?.slotDefault?.class),o=r&&Cr(e);return{c(){o&&o.c(),t=zt()},m(e,r){o&&o.m(e,r),Nt(e,t,r),n=!0},p(e,n){32&n[0]&&(r=br(e[5]?.slotDefault?.class)),r?o?(o.p(e,n),32&n[0]&&An(o,1)):(o=Cr(e),o.c(),An(o,1),o.m(t.parentNode,t)):o&&(Tn(),Cn(o,1,1,(()=>{o=null})),Ln())},i(e){n||(An(o),n=!0)},o(e){Cn(o),n=!1},d(e){e&&_t(t),o&&o.d(e)}}}(e);return{c(){o&&o.c()},m(e,n){o&&o.m(e,n),t=!0},p(e,s){r?r.p&&(!t||67108864&s[0])&&St(r,n,e,e[26],t?$t(n,e[26],s,null):kt(e[26]),null):o&&o.p&&(!t||32&s[0])&&o.p(e,t?s:[-1,-1])},i(e){t||(An(o,e),t=!0)},o(e){Cn(o,e),t=!1},d(e){o&&o.d(e)}}}function Cr(e){let t,n,r;const o=[Yn(e[5]?.slotDefault?.props)?e[5].slotDefault.props:{}];var s=e[5].slotDefault.class;function i(e,t){let n={};for(let e=0;e{Un(e,1)})),Ln()}s?(t=Zt(s,i(e,r)),_n(t.$$.fragment),An(t.$$.fragment,1),Qn(t,n.parentNode,n)):t=null}else if(s){const n=32&r[0]?Mn(o,[Nn(Yn(e[5]?.slotDefault?.props)?e[5].slotDefault.props:{})]):{};t.$set(n)}},i(e){r||(t&&An(t.$$.fragment,e),r=!0)},o(e){t&&Cn(t.$$.fragment,e),r=!1},d(e){e&&_t(n),t&&Un(t,e)}}}function Ir(e){let t,n,r,o,s,i,a,l,c,u,f,d,h,p,g=e[8].focusIndicator&&kr();const m=e[27].label,y=wt(m,e,e[26],Sr),v=y||function(e){let t,n,r,o,s;const i=[Tr,Er],a=[];function l(e,n){return 32&n[0]&&(t=null),null==t&&(t=!!br(e[5]?.slotLabel?.class)),t?0:1}return n=l(e,[-1,-1]),r=a[n]=i[n](e),{c(){r.c(),o=zt()},m(e,t){a[n].m(e,t),Nt(e,o,t),s=!0},p(e,t){let s=n;n=l(e,t),n===s?a[n].p(e,t):(Tn(),Cn(a[s],1,1,(()=>{a[s]=null})),Ln(),r=a[n],r?r.p(e,t):(r=a[n]=i[n](e),r.c()),An(r,1),r.m(o.parentNode,o))},i(e){s||(An(r),s=!0)},o(e){Cn(r),s=!1},d(e){e&&_t(o),a[n].d(e)}}}(e),b=e[27]["summary-end"],w=wt(b,e,e[26],xr),x=w||function(e){let t,n,r=br(e[5]?.slotSummaryEnd?.class),o=r&&Lr(e);return{c(){o&&o.c(),t=zt()},m(e,r){o&&o.m(e,r),Nt(e,t,r),n=!0},p(e,n){32&n[0]&&(r=br(e[5]?.slotSummaryEnd?.class)),r?o?(o.p(e,n),32&n[0]&&An(o,1)):(o=Lr(e),o.c(),An(o,1),o.m(t.parentNode,t)):o&&(Tn(),Cn(o,1,1,(()=>{o=null})),Ln())},i(e){n||(An(o),n=!0)},o(e){Cn(o),n=!1},d(e){e&&_t(t),o&&o.d(e)}}}(e);let $=e[12]&&Ar(e);return{c(){t=Qt("details"),n=Qt("summary"),r=Ut("svg"),o=Ut("path"),s=Bt(),g&&g.c(),i=Bt(),v&&v.c(),a=Bt(),x&&x.c(),l=Bt(),c=Qt("div"),$&&$.c(),qt(o,"fill","currentColor"),qt(o,"stroke","currentColor"),Jt(o,"stroke-linejoin","round"),Jt(o,"stroke-width","3"),qt(o,"d","M5,8L19,8L12,15Z"),qt(r,"viewBox","0 0 24 24"),qt(r,"class","svelte-9arcsc"),Gt(r,"focus-chevron",e[8].focusChevron),qt(n,"role","button"),qt(n,"tabindex","0"),qt(n,"class","svelte-9arcsc"),Gt(n,"default-cursor",e[8].chevronOnly),Gt(n,"remove-focus-visible",e[8].focusIndicator||e[8].focusChevron),qt(c,"class","contents svelte-9arcsc"),qt(t,"class","tjs-svg-folder svelte-9arcsc"),qt(t,"data-id",e[1]),qt(t,"data-label",e[2]),qt(t,"data-closing","false")},m(m,y){Nt(m,t,y),Ft(t,n),Ft(n,r),Ft(r,o),e[35](r),Ft(n,s),g&&g.m(n,null),Ft(n,i),v&&v.m(n,null),Ft(n,a),x&&x.m(n,null),e[37](n),Ft(t,l),Ft(t,c),$&&$.m(c,null),e[38](t),d=!0,h||(p=[Ht(n,"click",e[13]),Ht(n,"contextmenu",e[14]),Ht(n,"keydown",e[15],!0),Ht(n,"keyup",e[16],!0),Ht(t,"close",e[17]),Ht(t,"open",e[18]),Ht(t,"toggle",e[39]),Ht(t,"click",e[28]),Ht(t,"keydown",e[29]),Ht(t,"keyup",e[30]),Ht(t,"open",e[31]),Ht(t,"close",e[32]),Ht(t,"openAny",e[33]),Ht(t,"closeAny",e[34]),Lt(u=lr.call(null,t,{store:e[3],animate:e[0],clickActive:!1})),Lt(f=vr.call(null,t,e[4]))],h=!0)},p(e,o){(!d||256&o[0])&&Gt(r,"focus-chevron",e[8].focusChevron),e[8].focusIndicator?g||(g=kr(),g.c(),g.m(n,i)):g&&(g.d(1),g=null),y?y.p&&(!d||67108864&o[0])&&St(y,m,e,e[26],d?$t(m,e[26],o,$r):kt(e[26]),Sr):v&&v.p&&(!d||548&o[0])&&v.p(e,d?o:[-1,-1]),w?w.p&&(!d||67108864&o[0])&&St(w,b,e,e[26],d?$t(b,e[26],o,wr):kt(e[26]),xr):x&&x.p&&(!d||32&o[0])&&x.p(e,d?o:[-1,-1]),(!d||256&o[0])&&Gt(n,"default-cursor",e[8].chevronOnly),(!d||256&o[0])&&Gt(n,"remove-focus-visible",e[8].focusIndicator||e[8].focusChevron),e[12]?$?($.p(e,o),4096&o[0]&&An($,1)):($=Ar(e),$.c(),An($,1),$.m(c,null)):$&&(Tn(),Cn($,1,1,(()=>{$=null})),Ln()),(!d||2&o[0])&&qt(t,"data-id",e[1]),(!d||4&o[0])&&qt(t,"data-label",e[2]),u&&ht(u.update)&&9&o[0]&&u.update.call(null,{store:e[3],animate:e[0],clickActive:!1}),f&&ht(f.update)&&16&o[0]&&f.update.call(null,e[4])},i(e){d||(An(v,e),An(x,e),An($),d=!0)},o(e){Cn(v,e),Cn(x,e),Cn($),d=!1},d(n){n&&_t(t),e[35](null),g&&g.d(),v&&v.d(n),x&&x.d(n),e[37](null),$&&$.d(),e[38](null),h=!1,dt(p)}}}function Pr(e,t,n){let r,o=at,s=()=>(o(),o=yt(p,(e=>n(7,r=e))),p);e.$$.on_destroy.push((()=>o()));let{$$slots:i={},$$scope:a}=t,{folder:l}=t,{animate:c}=t,{id:u}=t,{label:f}=t,{keyCode:d}=t,{options:h}=t,{store:p}=t;s();let{styles:g}=t,{onClose:m}=t,{onOpen:y}=t,{onContextMenu:v}=t;const b=an("#external")?.application,w={chevronOnly:!1,focusChevron:!1,focusIndicator:!1};let x,$,S,k,E,T,L=r;var A;function C(e,t=!1){return new CustomEvent(e,{detail:{element:x,folder:l,id:u,label:f,store:p},bubbles:t})}function I(e,t=!1){const n=e.target,o=n===k||k.contains(n);if(n===S||n===$||o){if(!t&&w.chevronOnly&&!o)return e.preventDefault(),void e.stopPropagation();Tt(p,r=!r,r),r&&"function"==typeof y?y({event:e,element:x,folder:l,id:u,label:f,store:p}):r||"function"!=typeof m||m({event:e,element:x,folder:l,id:u,label:f,store:p})}e.preventDefault(),e.stopPropagation()}A=()=>E(),on().$$.on_destroy.push(A);return e.$$set=e=>{"folder"in e&&n(5,l=e.folder),"animate"in e&&n(0,c=e.animate),"id"in e&&n(1,u=e.id),"label"in e&&n(2,f=e.label),"keyCode"in e&&n(19,d=e.keyCode),"options"in e&&n(20,h=e.options),"store"in e&&s(n(3,p=e.store)),"styles"in e&&n(4,g=e.styles),"onClose"in e&&n(21,m=e.onClose),"onOpen"in e&&n(22,y=e.onOpen),"onContextMenu"in e&&n(23,v=e.onContextMenu),"$$scope"in e&&n(26,a=e.$$scope)},e.$$.update=()=>{33&e.$$.dirty[0]&&n(0,c=Yn(l)&&"boolean"==typeof l.animate?l.animate:"boolean"!=typeof c||c),34&e.$$.dirty[0]&&n(1,u=Yn(l)&&"string"==typeof l.id?l.id:"string"==typeof u?u:void 0),36&e.$$.dirty[0]&&n(2,f=Yn(l)&&"string"==typeof l.label?l.label:"string"==typeof f?f:""),524320&e.$$.dirty[0]&&n(19,d=Yn(l)&&"string"==typeof l.keyCode?l.keyCode:"string"==typeof d?d:"Enter"),1048608&e.$$.dirty[0]&&(n(20,h=Yn(l)&&Yn(l.options)?l.options:Yn(h)?h:{}),"boolean"==typeof h?.chevronOnly&&n(8,w.chevronOnly=h.chevronOnly,w),"boolean"==typeof h?.focusChevron&&n(8,w.focusChevron=h.focusChevron,w),"boolean"==typeof h?.focusIndicator&&n(8,w.focusIndicator=h.focusIndicator,w)),16777320&e.$$.dirty[0]&&(s(n(3,p=Yn(l)&&ir(l.store)?l.store:ir(p)?p:Hn(!1))),"function"==typeof E&&E(),n(24,E=function(e,t){let n=!1;return e.subscribe((e=>{n?t(e):n=!0}))}(p,(e=>{x&&(x.dispatchEvent(C(e?"open":"close")),x.dispatchEvent(C(e?"openAny":"closeAny",!0)))})))),48&e.$$.dirty[0]&&n(4,g=Yn(l)&&Yn(l.styles)?l.styles:Yn(g)?g:void 0),2097184&e.$$.dirty[0]&&n(21,m=Yn(l)&&"function"==typeof l.onClose?l.onClose:"function"==typeof m?m:void 0),4194336&e.$$.dirty[0]&&n(22,y=Yn(l)&&"function"==typeof l.onOpen?l.onOpen:"function"==typeof y?y:void 0),8388640&e.$$.dirty[0]&&n(23,v=Yn(l)&&"function"==typeof l.onContextMenu?l.onContextMenu:"function"==typeof v?v:void 0),33554560&e.$$.dirty[0]&&(r?(clearTimeout(T),n(12,L=!0)):n(25,T=setTimeout((()=>n(12,L=!1)),500)))},[c,u,f,p,g,l,x,r,w,$,S,k,L,function(e){if((b?.reactive?.activeWindow??globalThis).document.activeElement===S&&(-1===e?.pointerId||6===e?.mozInputSource))return e.preventDefault(),void e.stopPropagation();I(e)},function(e){"function"==typeof v&&v({event:e})},function(e){(b?.reactive?.activeWindow??globalThis).document.activeElement===S&&e.code===d&&(e.preventDefault(),e.stopPropagation())},function(e){(b?.reactive?.activeWindow??globalThis).document.activeElement===S&&e.code===d&&(I(e,!0),e.preventDefault(),e.stopPropagation())},function(e){e.preventDefault(),e.stopPropagation(),p.set(!1)},function(e){e.preventDefault(),e.stopPropagation(),p.set(!0)},d,h,m,y,v,E,T,a,i,function(t){ln.call(this,e,t)},function(t){ln.call(this,e,t)},function(t){ln.call(this,e,t)},function(t){ln.call(this,e,t)},function(t){ln.call(this,e,t)},function(t){ln.call(this,e,t)},function(t){ln.call(this,e,t)},function(e){un[e?"unshift":"push"]((()=>{k=e,n(11,k)}))},function(e){un[e?"unshift":"push"]((()=>{$=e,n(9,$)}))},function(e){un[e?"unshift":"push"]((()=>{S=e,n(10,S)}))},function(e){un[e?"unshift":"push"]((()=>{x=e,n(6,x)}))},()=>n(6,x.open=r,x)]}const Or=class extends Bn{constructor(e){super(),jn(this,e,Pr,Ir,pt,{folder:5,animate:0,id:1,label:2,keyCode:19,options:20,store:3,styles:4,onClose:21,onOpen:22,onContextMenu:23},null,[-1,-1])}};function Dr(e,t,n){const r=e.slice();return r[15]=t[n],r}function Fr(e){let t,n;return t=new sr({props:{entry:e[15],indentIcon:e[6],removeIcon:!e[2]&&2===e[15]?.kind}}),{c(){_n(t.$$.fragment)},m(e,r){Qn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[15]),1&n&&(r.removeIcon=!e[2]&&2===e[15]?.kind),t.$set(r)},i(e){n||(An(t.$$.fragment,e),n=!0)},o(e){Cn(t.$$.fragment,e),n=!1},d(e){Un(t,e)}}}function Rr(e){let t,n;return t=new jr({props:{entry:e[15],parentIcon:!e[5]}}),{c(){_n(t.$$.fragment)},m(e,r){Qn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[15]),t.$set(r)},i(e){n||(An(t.$$.fragment,e),n=!0)},o(e){Cn(t.$$.fragment,e),n=!1},d(e){Un(t,e)}}}function Mr(e,t){let n,r,o,s,i,a;const l=[Rr,Fr],c=[];function u(e,t){return 1&t&&(r=null),null==r&&(r=!!Array.isArray(e[15].children)),r?0:1}return o=u(t,-1),s=c[o]=l[o](t),{key:e,first:null,c(){n=zt(),s.c(),i=zt(),this.first=n},m(e,t){Nt(e,n,t),c[o].m(e,t),Nt(e,i,t),a=!0},p(e,n){let r=o;o=u(t=e,n),o===r?c[o].p(t,n):(Tn(),Cn(c[r],1,1,(()=>{c[r]=null})),Ln(),s=c[o],s?s.p(t,n):(s=c[o]=l[o](t),s.c()),An(s,1),s.m(i.parentNode,i))},i(e){a||(An(s),a=!0)},o(e){Cn(s),a=!1},d(e){e&&(_t(n),_t(i)),c[o].d(e)}}}function Nr(e){let t,n,r=[],o=new Map,s=On(e[0].children);const i=e=>e[15].path;for(let t=0;tn(11,o=e)));const f=s.storageKey,d=f?a.getStore(f,!1):void 0,h=!c&&(void 0===s.kind||2===s.kind),p=h?"indent-no-icon":"indent-icon",g={store:d,options:{focusChevron:!0},styles:i?{"--tjs-folder-details-margin-left":"3.5px"}:void 0};return e.$$set=e=>{"entry"in e&&n(0,s=e.entry),"parentIcon"in e&&n(10,i=e.parentIcon)},e.$$.update=()=>{2048&e.$$.dirty&&n(1,r=o)},[s,r,c,u,f,h,p,g,function(e){e?.event?.altKey&&l.setChildFolderState(s,!1)},function(e){e?.event?.altKey&&l.setChildFolderState(s,!0)},i,o]}class jr extends Bn{constructor(e){super(),jn(this,e,Ur,Qr,pt,{entry:0,parentIcon:10})}}const Br=jr;function zr(e){const t=e-1;return t*t*t+1}function Hr(e,t){const n=t.easingFade??t.easing??lt,r=t.easingSlide??t.easing??lt,o=function(e,{delay:t=0,duration:n=400,easing:r=lt}={}){const o=+getComputedStyle(e).opacity;return{delay:t,duration:n,easing:r,css:e=>"opacity: "+e*o}}(e),s=function(e,{delay:t=0,duration:n=400,easing:r=zr,axis:o="y"}={}){const s=getComputedStyle(e),i=+s.opacity,a="y"===o?"height":"width",l=parseFloat(s[a]),c="y"===o?["top","bottom"]:["left","right"],u=c.map((e=>`${e[0].toUpperCase()}${e.slice(1)}`)),f=parseFloat(s[`padding${u[0]}`]),d=parseFloat(s[`padding${u[1]}`]),h=parseFloat(s[`margin${u[0]}`]),p=parseFloat(s[`margin${u[1]}`]),g=parseFloat(s[`border${u[0]}Width`]),m=parseFloat(s[`border${u[1]}Width`]);return{delay:t,duration:n,easing:r,css:e=>`overflow: hidden;opacity: ${Math.min(20*e,1)*i};${a}: ${e*l}px;padding-${c[0]}: ${e*f}px;padding-${c[1]}: ${e*d}px;margin-${c[0]}: ${e*h}px;margin-${c[1]}: ${e*p}px;border-${c[0]}-width: ${e*g}px;border-${c[1]}-width: ${e*m}px;`}}(e,{axis:t.axis});return{delay:t.delay??0,duration:t.duration??500,easing:lt,css:e=>{const t=n(e),i=r(e);return`${s.css(i,1-i)}; ${o.css(t,1-t)}`}}}function Vr(e,t,n){const r=e.slice();return r[10]=t[n],r}function qr(e,t){let n,r,o,s,i,a,l=t[10].key+"";return{key:e,first:null,c(){n=Qt("span"),r=Ut("svg"),o=Ut("use"),s=Bt(),i=jt(l),a=Bt(),qt(o,"href",`#icon-${t[10].value}`),qt(r,"class","tsd-kind-icon svelte-1uxeem0"),qt(r,"viewBox","0 0 24 24"),qt(n,"class","svelte-1uxeem0"),this.first=n},m(e,t){Nt(e,n,t),Ft(n,r),Ft(r,o),Ft(n,s),Ft(n,i),Ft(n,a)},p(e,n){t=e},d(e){e&&_t(n)}}}function Wr(e){let t;return{c(){t=Qt("span"),t.innerHTML='Alt + E(Nav) open / close all',qt(t,"class","svelte-1uxeem0")},m(e,n){Nt(e,t,n)},d(e){e&&_t(t)}}}function Kr(e){let t,n,r,o,s;return{c(){t=Qt("span"),n=Qt("i"),n.textContent="Alt + M",r=jt("Go to "),o=jt(e[5]),s=jt(" page"),qt(n,"class","key svelte-1uxeem0"),qt(t,"class","svelte-1uxeem0")},m(e,i){Nt(e,t,i),Ft(t,n),Ft(t,r),Ft(t,o),Ft(t,s)},p:at,d(e){e&&_t(t)}}}function Jr(e){let t;return{c(){t=Qt("span"),t.innerHTML='AltPress when opening / closing folders to open / close all child folders.',qt(t,"class","svelte-1uxeem0")},m(e,n){Nt(e,t,n)},d(e){e&&_t(t)}}}function Gr(e){let t,n,r,o,s,i,a,l,c,u,f,d,h,p,g,m,y,v,b,w,x,$,S,k=[],E=new Map,T=On(e[6]);const L=e=>e[10].value;for(let t=0;t0&&Wr(),C=e[0]&&Kr(e),I=e[2]>0&&Jr();return{c(){t=Qt("div"),n=Qt("span"),n.textContent="Reflection Icon Reference:",r=Bt(),o=Qt("section");for(let e=0;eAlt + CFocus main content',c=Bt(),A&&A.c(),u=Bt(),f=Qt("span"),f.innerHTML='Alt + HOpen / close help',d=Bt(),h=Qt("span"),h.innerHTML='Alt + IGo to home / index page',p=Bt(),g=Qt("span"),g.innerHTML='Alt + N(Nav) focus selected',m=Bt(),C&&C.c(),y=Bt(),v=Qt("span"),v.innerHTML='Alt + OFocus "On This Page"',b=Bt(),w=Qt("span"),w.innerHTML='Alt + SActivate search',x=Bt(),I&&I.c(),qt(n,"class","title svelte-1uxeem0"),qt(o,"class","reflection-kinds svelte-1uxeem0"),qt(i,"class","title svelte-1uxeem0"),qt(l,"class","svelte-1uxeem0"),qt(f,"class","svelte-1uxeem0"),qt(h,"class","svelte-1uxeem0"),qt(g,"class","svelte-1uxeem0"),qt(v,"class","svelte-1uxeem0"),qt(w,"class","svelte-1uxeem0"),qt(t,"class","svelte-1uxeem0")},m(e,$){Nt(e,t,$),Ft(t,n),Ft(t,r),Ft(t,o);for(let e=0;e0?A||(A=Wr(),A.c(),A.m(t,u)):A&&(A.d(1),A=null),e[0]?C?C.p(e,n):(C=Kr(e),C.c(),C.m(t,y)):C&&(C.d(1),C=null),e[2]>0?I||(I=Jr(),I.c(),I.m(t,null)):I&&(I.d(1),I=null)},i(n){S||(n&&yn((()=>{S&&($||($=Pn(t,e[4],{duration:100},!0)),$.run(1))})),S=!0)},o(n){n&&($||($=Pn(t,e[4],{duration:100},!1)),$.run(0)),S=!1},d(e){e&&_t(t);for(let e=0;e(s(),s=yt(c,(e=>n(2,o=e))),c);e.$$.on_destroy.push((()=>s()));let{hasModulesIndex:a=!1}=t,{moduleIsPackage:l=!1}=t,{storeTopLevelNodes:c}=t;i();const u=an("#ReflectionKind"),f=an("#storeSettingAnimate");bt(e,f,(e=>n(8,r=e)));const d=r?Hr:()=>{},h=l?"package":"module",p=[];for(const[e,t]of Object.entries(u))"number"==typeof t&&p.push({key:e,value:t});return p.sort(((e,t)=>e.key.localeCompare(t.key))),e.$$set=e=>{"hasModulesIndex"in e&&n(0,a=e.hasModulesIndex),"moduleIsPackage"in e&&n(7,l=e.moduleIsPackage),"storeTopLevelNodes"in e&&i(n(1,c=e.storeTopLevelNodes))},[a,c,o,f,d,h,p,l]}const Yr=class extends Bn{constructor(e){super(),jn(this,e,Zr,Gr,pt,{hasModulesIndex:0,moduleIsPackage:7,storeTopLevelNodes:1})}},Xr="docs-dmt-theme-animate";function eo(e){let t,n,r,o,s,i,a,l,c;return{c(){t=Ut("svg"),n=Ut("symbol"),r=Ut("path"),o=Bt(),s=Qt("button"),s.innerHTML='',i=Bt(),a=Qt("button"),a.innerHTML='',qt(r,"d","M517.408 993.568l-0.448 0.256c-18.592-0.032-37.152-7.168-51.328-21.344L51.392 558.24c-27.904-27.904-28.32-74.624 0.224-103.2 28.768-28.768 74.784-28.672 103.2-0.224l362.272 362.272L879.36 454.816c27.904-27.904 74.624-28.32 103.2 0.224 28.768 28.768 28.672 74.784 0.224 103.2l-414.24 414.24c-13.92 13.92-32.512 20.992-51.2 21.056z m0-397.408l-0.448 0.256c-18.592-0.032-37.152-7.168-51.328-21.344l-414.24-414.24c-27.904-27.904-28.32-74.624 0.224-103.2 28.768-28.768 74.784-28.672 103.2-0.224L517.088 419.68 879.36 57.408c27.904-27.904 74.624-28.32 103.2 0.224 28.768 28.768 28.672 74.784 0.224 103.2l-414.24 414.24c-13.92 13.92-32.512 20.992-51.2 21.056z"),qt(n,"id","dmt-double-icon-arrow"),qt(n,"viewBox","0 0 1024 1024"),Jt(t,"display","none"),qt(t,"class","svelte-1b99m8i"),qt(s,"title","Open All"),qt(s,"class","svelte-1b99m8i"),qt(a,"title","Close All"),qt(a,"class","svelte-1b99m8i")},m(u,f){Nt(u,t,f),Ft(t,n),Ft(n,r),Nt(u,o,f),Nt(u,s,f),Nt(u,i,f),Nt(u,a,f),l||(c=[Ht(s,"click",e[13]),Ht(s,"keydown",ro),Ht(s,"pointerdown",Vt(e[12])),Ht(a,"click",e[14]),Ht(a,"keydown",ro),Ht(a,"pointerdown",Vt(e[11]))],l=!0)},p:at,d(e){e&&(_t(t),_t(o),_t(s),_t(i),_t(a)),l=!1,dt(c)}}}function to(e){let t,n;return t=new Yr({props:{hasModulesIndex:e[3],moduleIsPackage:e[5],storeTopLevelNodes:e[7]}}),{c(){_n(t.$$.fragment)},m(e,r){Qn(t,e,r),n=!0},p:at,i(e){n||(An(t.$$.fragment,e),n=!0)},o(e){Cn(t.$$.fragment,e),n=!1},d(e){Un(t,e)}}}function no(e){let t,n,r,o,s,i,a,l,c,u,f,d,h=e[2]>0&&eo(e),p=e[3]&&function(e){let t,n;return{c(){t=Qt("a"),n=jt(e[8]),qt(t,"href",`${e[4].baseURL}modules.html`),qt(t,"class","svelte-1b99m8i"),Gt(t,"current","modules.html"===e[4].currentPathURL)},m(e,r){Nt(e,t,r),Ft(t,n)},p:at,d(e){e&&_t(t)}}}(e),g=e[0]&&to(e);return{c(){t=Qt("section"),h&&h.c(),n=Bt(),r=Qt("button"),o=Ut("svg"),s=Ut("g"),i=Ut("path"),a=Ut("path"),l=Bt(),p&&p.c(),c=Bt(),g&&g.c(),qt(i,"d","M502.29,788.199h-47c-33.1,0-60,26.9-60,60v64.9c0,33.1,26.9,60,60,60h47c33.101,0,60-26.9,60-60v-64.9 C562.29,815,535.391,788.199,502.29,788.199z"),qt(a,"d","M170.89,285.8l86.7,10.8c27.5,3.4,53.6-12.4,63.5-38.3c12.5-32.7,29.9-58.5,52.2-77.3c31.601-26.6,70.9-40,117.9-40\r\n c48.7,0,87.5,12.8,116.3,38.3c28.8,25.6,43.1,56.2,43.1,92.1c0,25.8-8.1,49.4-24.3,70.8c-10.5,13.6-42.8,42.2-96.7,85.9\r\n c-54,43.7-89.899,83.099-107.899,118.099c-18.4,35.801-24.8,75.5-26.4,115.301c-1.399,34.1,25.8,62.5,60,62.5h49\r\n c31.2,0,57-23.9,59.8-54.9c2-22.299,5.7-39.199,11.301-50.699c9.399-19.701,33.699-45.701,72.699-78.1\r\n C723.59,477.8,772.79,428.4,795.891,392c23-36.3,34.6-74.8,34.6-115.5c0-73.5-31.3-138-94-193.4c-62.6-55.4-147-83.1-253-83.1\r\n c-100.8,0-182.1,27.3-244.1,82c-52.8,46.6-84.9,101.8-96.2,165.5C139.69,266.1,152.39,283.5,170.89,285.8z"),qt(o,"viewBox","0 0 973.1 973.1"),qt(o,"class","svelte-1b99m8i"),qt(r,"title",e[1]),qt(r,"class","svelte-1b99m8i"),qt(t,"class","svelte-1b99m8i")},m(m,y){Nt(m,t,y),h&&h.m(t,null),Ft(t,n),Ft(t,r),Ft(r,o),Ft(o,s),Ft(s,i),Ft(s,a),Ft(t,l),p&&p.m(t,null),Ft(t,c),g&&g.m(t,null),u=!0,f||(d=[Ht(r,"click",e[9]),Ht(r,"keydown",ro)],f=!0)},p(e,[o]){e[2]>0?h?h.p(e,o):(h=eo(e),h.c(),h.m(t,n)):h&&(h.d(1),h=null),(!u||2&o)&&qt(r,"title",e[1]),e[3]&&p.p(e,o),e[0]?g?(g.p(e,o),1&o&&An(g,1)):(g=to(e),g.c(),An(g,1),g.m(t,null)):g&&(Tn(),Cn(g,1,1,(()=>{g=null})),Ln())},i(e){u||(An(g),u=!0)},o(e){Cn(g),u=!1},d(e){e&&_t(t),h&&h.d(),p&&p.d(),g&&g.d(),f=!1,dt(d)}}}function ro(e){e.repeat&&(e.stopPropagation(),e.preventDefault())}function oo(e,t,n){let r,o,s,{dmtComponentData:i}=t;sn("#ReflectionKind",i.ReflectionKind),sn("#storeSettingAnimate",i.dmtLocalStorage.getStore(Xr));const{hasModulesIndex:a,navigationData:l,moduleIsPackage:c}=i,{storeHelpPanelOpen:u,storeTopLevelNodes:f}=l;bt(e,u,(e=>n(0,o=e))),bt(e,f,(e=>n(2,s=e)));const d=c?"Package Index":"Module Index";return e.$$set=e=>{"dmtComponentData"in e&&n(10,i=e.dmtComponentData)},e.$$.update=()=>{1&e.$$.dirty&&n(1,r=o?"Close Help":"Open Help")},[o,r,s,a,l,c,u,f,d,function(){Tt(u,o=!vt(u),o)},i,function(t){ln.call(this,e,t)},function(t){ln.call(this,e,t)},()=>l.setStoresAllOpen(!0),()=>l.setStoresAllOpen(!1)]}const so=class extends Bn{constructor(e){super(),jn(this,e,oo,no,pt,{dmtComponentData:10})}};function io(e,t,n){const r=e.slice();return r[4]=t[n],r}function ao(e,t,n){const r=e.slice();return r[4]=t[n],r}function lo(e,t){let n,r;return{key:e,first:null,c(){n=Qt("a"),r=Qt("span"),r.textContent=`${t[4]}`,qt(n,"href",`${t[1][t[4]]}`),qt(n,"target","_blank"),qt(n,"class","svelte-820e2"),this.first=n},m(e,t){Nt(e,n,t),Ft(n,r)},p(e,n){t=e},d(e){e&&_t(n)}}}function co(e,t){let n,r;return{key:e,first:null,c(){n=Qt("a"),r=Qt("span"),r.textContent=`${t[4]}`,qt(n,"href",`${t[0][t[4]]}`),qt(n,"target","_blank"),qt(n,"class","svelte-820e2"),this.first=n},m(e,t){Nt(e,n,t),Ft(n,r)},p(e,n){t=e},d(e){e&&_t(n)}}}function uo(e){let t,n=e[2]&&function(e){let t,n,r=[],o=new Map,s=[],i=new Map,a=On(Object.keys(e[1]));const l=e=>e[1][e[4]];for(let t=0;te[0][e[4]];for(let t=0;t0;return e.$$set=e=>{"dmtComponentData"in e&&n(3,r=e.dmtComponentData)},[o,s,i,r]}const ho=class extends Bn{constructor(e){super(),jn(this,e,fo,uo,pt,{dmtComponentData:3})}};class po{#u=[];constructor(){const e=document.querySelectorAll("details.tsd-index-accordion");for(const t of e)this.#u.push(lr(t,{store:Hn(t.open)}).update)}setEnabled(e){const t=document.querySelectorAll("details.tsd-index-accordion");for(const n of t){const t=n.querySelector("summary svg");t&&t.classList[e?"add":"remove"]("dmt-summary-svg")}for(const t of this.#u)t({animate:e})}}function go(e,t,n){const r=e.slice();return r[10]=t[n],r}function mo(e){let t,n;return t=new sr({props:{entry:e[10],indentIcon:wo,removeIcon:!e[3]&&2===e[10]?.kind}}),{c(){_n(t.$$.fragment)},m(e,r){Qn(t,e,r),n=!0},p:at,i(e){n||(An(t.$$.fragment,e),n=!0)},o(e){Cn(t.$$.fragment,e),n=!1},d(e){Un(t,e)}}}function yo(e){let t,n;return t=new Br({props:{entry:e[10]}}),{c(){_n(t.$$.fragment)},m(e,r){Qn(t,e,r),n=!0},p:at,i(e){n||(An(t.$$.fragment,e),n=!0)},o(e){Cn(t.$$.fragment,e),n=!1},d(e){Un(t,e)}}}function vo(e,t){let n,r,o,s,i;const a=[yo,mo],l=[];return r=function(e,t){return Array.isArray(e[10].children)?0:1}(t),o=l[r]=a[r](t),{key:e,first:null,c(){n=zt(),o.c(),s=zt(),this.first=n},m(e,t){Nt(e,n,t),l[r].m(e,t),Nt(e,s,t),i=!0},p(e,n){t=e,o.p(t,n)},i(e){i||(An(o),i=!0)},o(e){Cn(o),i=!1},d(e){e&&(_t(n),_t(s)),l[r].d(e)}}}function bo(e){let t,n,r,o,s,i,a,l,c=[],u=new Map;t=new ho({props:{dmtComponentData:e[0]}}),r=new so({props:{dmtComponentData:e[0]}});let f=On(e[2].index);const d=e=>e[10].path;for(let t=0;tn(7,o=e))),sn("#navModuleIcon",a),sn("#navigationData",i),sn("#storeSettingAnimate",c);const{storeCurrentPathURL:u}=i;let f;return bt(e,u,(e=>n(6,r=e))),e.$$set=e=>{"dmtComponentData"in e&&n(0,s=e.dmtComponentData)},e.$$.update=()=>{128&e.$$.dirty&&l.setEnabled(o),66&e.$$.dirty&&r&&er().then((()=>{const e=f.querySelector(`a[href*="${i.currentPathURL}"]`);e&&e.scrollIntoView({block:"center",inline:"center"})}))},[s,f,i,a,c,u,r,o,function(e){un[e?"unshift":"push"]((()=>{f=e,n(1,f)}))}]}const So=class extends Bn{constructor(e){super(),jn(this,e,$o,bo,pt,{dmtComponentData:0})}get dmtComponentData(){return this.$$.ctx[0]}set dmtComponentData(e){this.$$set({dmtComponentData:e}),xn()}};class ko{#f;#d;constructor(e){this.#f=e,this.#d=this.#h.bind(this),this.#p()}get onHashchange(){return this.#d}ensureCurrentPath(e,{setCurrent:t=!0}={}){const n=this.#g(e,(e=>{e.storageKey&&this.#f.dmtSessionStorage.setItem(e.storageKey,!0)}));return n&&t&&this.#f.setCurrentPathURL(e),n}setChildFolderState(e,t){this.#m((e=>{e.storageKey&&this.#f.dmtSessionStorage.setItem(e.storageKey,t)}),e)}#y(){const e=this.#f.baseURL,t=this;function n(n){n.preventDefault();if(globalThis.location.href.split("#")[0]!==this.href.split("#")[0]||globalThis.location.hash!==this.hash)return void(globalThis.location.href=this.href);const r=this.href.replace(e,"");if(!t.ensureCurrentPath(r)&&r.includes("#")){const e=r.split("#");e[0]&&t.ensureCurrentPath(e[0]),t.#v(e[1])}}const r=document.querySelectorAll('div.col-content a[href*="#"], details.tsd-page-navigation a[href*="#"]');for(const e of r)e.addEventListener("click",n)}#b(e){return this.#g(e,(e=>{e.storageKey&&this.#f.dmtSessionStorage.setItem(e.storageKey,!0)}))}#w(){const e=this.#f.dmtSessionStorage,t=this.#f.storagePrepend;let n=0;this.#x(((r,o)=>{o||n++;const s=o?o.path??o.text:"";r.storageKey=`${t}-nav-${r.path??`${s}-${r.text}`}`,e.getStore(r.storageKey,!1)})),this.#f.storeTopLevelNodes.set(n)}async#h(e){const t=e.newURL.replace(this.#f.baseURL,"");if(!this.ensureCurrentPath(t)&&t.includes("#")){const e=t.split("#")[0];e&&this.ensureCurrentPath(e)}}#v(e){}#$(e,t,n){if(e.path===t)return!0;if(Array.isArray(e.children))for(const r of e.children){if(this.#$(r,t,n))return n(e),!0}return!1}#g(e,t){if(!this.#f.index?.length)return!1;for(const t of this.#f.index)if(!Array.isArray(t.children)&&t?.path===e)return!0;for(const n of this.#f.index)if(Array.isArray(n.children)&&this.#$(n,e,t))return!0;return!1}#p(){this.#w();const e=this.#f.initialPathURL,t=this.#b(e);if(e.includes("#")){const n=e.split("#");if(!t){const e=n[0];e&&this.#b(e)&&this.#f.setCurrentPathURL(e)}this.#v(n[1])}this.#y()}#S(e,t,n){if(Array.isArray(e.children))for(const t of e.children)Array.isArray(t.children)&&this.#S(t,e,n);n(e,t)}#x(e){for(const t of this.#f.index)Array.isArray(t.children)&&this.#S(t,void 0,e)}#m(e,t){this.#S(t,void 0,e)}}function Eo(e){let t,n,r,o,s,i,a,l,c,u,f;return{c(){t=Qt("label"),n=Qt("input"),r=Bt(),o=Ut("svg"),s=Ut("rect"),i=Ut("path"),a=Bt(),l=Qt("span"),c=jt(e[1]),qt(n,"type","checkbox"),qt(s,"class","tsd-checkbox-background"),qt(s,"width","30"),qt(s,"height","30"),qt(s,"x","1"),qt(s,"y","1"),qt(s,"rx","6"),qt(s,"fill","none"),qt(i,"class","tsd-checkbox-checkmark"),qt(i,"d","M8.35422 16.8214L13.2143 21.75L24.6458 10.25"),qt(i,"stroke","none"),qt(i,"stroke-width","3.5"),qt(i,"stroke-linejoin","round"),qt(i,"fill","none"),qt(o,"width","32"),qt(o,"height","32"),qt(o,"viewBox","0 0 32 32"),qt(o,"aria-hidden","true"),qt(t,"class","tsd-filter-input")},m(d,h){Nt(d,t,h),Ft(t,n),n.checked=e[2],Ft(t,r),Ft(t,o),Ft(o,s),Ft(o,i),Ft(t,a),Ft(t,l),Ft(l,c),u||(f=Ht(n,"change",e[3]),u=!0)},p(e,[t]){4&t&&(n.checked=e[2]),2&t&&Wt(c,e[1])},i:at,o:at,d(e){e&&_t(t),u=!1,f()}}}function To(e,t,n){let r,o=at,s=()=>(o(),o=yt(i,(e=>n(2,r=e))),i);e.$$.on_destroy.push((()=>o()));let{store:i}=t;s();let{label:a}=t;return e.$$set=e=>{"store"in e&&s(n(0,i=e.store)),"label"in e&&n(1,a=e.label)},[i,a,r,function(){r=this.checked,i.set(r)}]}const Lo=class extends Bn{constructor(e){super(),jn(this,e,To,Eo,pt,{store:0,label:1})}};function Ao(e){let t,n,r;return n=new Lo({props:{store:e[0],label:"Animation"}}),{c(){t=Qt("section"),_n(n.$$.fragment),qt(t,"class","svelte-20evnz")},m(e,o){Nt(e,t,o),Qn(n,t,null),r=!0},p:at,i(e){r||(An(n.$$.fragment,e),r=!0)},o(e){Cn(n.$$.fragment,e),r=!1},d(e){e&&_t(t),Un(n)}}}function Co(e,t,n){let{dmtComponentData:r}=t;const o=r.dmtLocalStorage.getStore(Xr,!Xn.prefersReducedMotion);return e.$$set=e=>{"dmtComponentData"in e&&n(1,r=e.dmtComponentData)},[o,r]}const Io=class extends Bn{constructor(e){super(),jn(this,e,Co,Ao,pt,{dmtComponentData:1})}};function Po(e,t,n){const r=e.slice();return r[4]=t[n],r}function Oo(e,t,n){const r=e.slice();return r[4]=t[n],r}function Do(e,t){let n,r,o;return{key:e,first:null,c(){n=Qt("a"),r=Qt("img"),mt(r.src,o="string"==typeof t[4].dmtPath?`${t[0]}${t[4].dmtPath}`:t[4].iconURL)||qt(r,"src",o),qt(r,"alt",t[4].title),qt(r,"class","svelte-1iuo1zb"),qt(n,"href",t[4].url),qt(n,"target","_blank"),qt(n,"title",t[4].title),qt(n,"class","svelte-1iuo1zb"),this.first=n},m(e,t){Nt(e,n,t),Ft(n,r)},p(e,n){t=e},d(e){e&&_t(n)}}}function Fo(e,t){let n,r,o,s;return{key:e,first:null,c(){n=Qt("a"),r=Qt("img"),s=Bt(),mt(r.src,o=`${t[0]}${t[4].dmtPath}`)||qt(r,"src",o),qt(r,"alt",t[4].title),qt(r,"class","svelte-1iuo1zb"),qt(n,"href",t[4].url),qt(n,"target","_blank"),qt(n,"title",t[4].title),qt(n,"class","svelte-1iuo1zb"),this.first=n},m(e,t){Nt(e,n,t),Ft(n,r),Ft(n,s)},p(e,n){t=e},d(e){e&&_t(n)}}}function Ro(e){let t,n,r=[],o=new Map,s=[],i=new Map,a=On(e[1]);const l=e=>e[4].url;for(let t=0;te[4].url;for(let t=0;t{"dmtComponentData"in e&&n(3,r=e.dmtComponentData)},[o,s,i,r]}const No=class extends Bn{constructor(e){super(),jn(this,e,Mo,Ro,pt,{dmtComponentData:3})}};function _o(e){let t,n;return t=new No({props:{dmtComponentData:e[0]}}),{c(){_n(t.$$.fragment)},m(e,r){Qn(t,e,r),n=!0},p(e,[n]){const r={};1&n&&(r.dmtComponentData=e[0]),t.$set(r)},i(e){n||(An(t.$$.fragment,e),n=!0)},o(e){Cn(t.$$.fragment,e),n=!1},d(e){Un(t,e)}}}function Qo(e,t,n){let{dmtComponentData:r}=t;return e.$$set=e=>{"dmtComponentData"in e&&n(0,r=e.dmtComponentData)},[r]}const Uo=class extends Bn{constructor(e){super(),jn(this,e,Qo,_o,pt,{dmtComponentData:0})}};function jo(e){let t,n,r;return{c(){t=Qt("button"),t.innerHTML='',qt(t,"class","svelte-10arjs8")},m(o,s){Nt(o,t,s),n||(r=[Ht(t,"click",e[3]),Ht(t,"pointerdown",Vt(e[2]))],n=!0)},p:at,i:at,o:at,d(e){e&&_t(t),n=!1,dt(r)}}}function Bo(e,t,n){let r;const o=an("#storeVisible");bt(e,o,(e=>n(0,r=e)));return[r,o,function(t){ln.call(this,e,t)},()=>Tt(o,r=!r,r)]}class zo extends Bn{constructor(e){super(),jn(this,e,Bo,jo,pt,{})}}function Ho(e,t,n){const r=e.slice();return r[12]=t[n],r}function Vo(e){let t,n,r;return{c(){t=Ut("svg"),n=Ut("use"),qt(n,"href",r=`#icon-${e[12].kind}`),qt(t,"class","tsd-kind-icon"),qt(t,"viewBox","0 0 24 24")},m(e,r){Nt(e,t,r),Ft(t,n)},p(e,t){2&t&&r!==(r=`#icon-${e[12].kind}`)&&qt(n,"href",r)},d(e){e&&_t(t)}}}function qo(e,t){let n,r,o,s,i,a,l,c=t[12].name+"",u=t[12].kind&&Vo(t);function f(){return t[8](t[12])}return{key:e,first:null,c(){n=Qt("li"),u&&u.c(),r=Bt(),o=Qt("span"),s=Bt(),qt(o,"class","parent"),qt(n,"class",i=Et(t[12].classes)+" svelte-5rxzhp"),qt(n,"role","menuitem"),Gt(n,"selected",t[12].id===t[2]),this.first=n},m(e,t){Nt(e,n,t),u&&u.m(n,null),Ft(n,r),Ft(n,o),o.innerHTML=c,Ft(n,s),a||(l=Ht(n,"click",f),a=!0)},p(e,s){(t=e)[12].kind?u?u.p(t,s):(u=Vo(t),u.c(),u.m(n,r)):u&&(u.d(1),u=null),2&s&&c!==(c=t[12].name+"")&&(o.innerHTML=c),2&s&&i!==(i=Et(t[12].classes)+" svelte-5rxzhp")&&qt(n,"class",i),6&s&&Gt(n,"selected",t[12].id===t[2])},d(e){e&&_t(n),u&&u.d(),a=!1,l()}}}function Wo(e){let t,n,r,o=[],s=new Map,i=On(e[1]);const a=e=>e[12].id;for(let t=0;t{r&&(n||(n=Pn(t,e[6],{duration:100},!0)),n.run(1))})),r=!0)},o(o){n||(n=Pn(t,e[6],{duration:100},!1)),n.run(0),r=!1},d(r){r&&_t(t);for(let e=0;en(2,s=e)));const c=an("#storeSettingAnimate");bt(e,c,(e=>n(11,o=e)));const u=an("#storeVisible");bt(e,u,(e=>n(10,r=e)));const f=o?Hr:()=>{};function d(e){Tt(u,r=!1,r),globalThis.location.href=e}return e.$$set=e=>{"results"in e&&n(1,i=e.results),"resultsEl"in e&&n(0,a=e.resultsEl)},[a,i,s,l,c,u,f,d,e=>d(e.href),function(e){un[e?"unshift":"push"]((()=>{a=e,n(0,a)}))}]}class Jo extends Bn{constructor(e){super(),jn(this,e,Ko,Wo,pt,{results:1,resultsEl:0})}}function Go(e,t){if(""===t)return e;const n=e.toLocaleLowerCase(),r=t.toLocaleLowerCase(),o=[];let s=0,i=n.indexOf(r);for(;-1!==i;)o.push(Yo(e.substring(s,i)),`${Yo(e.substring(i,i+r.length))}`),s=i+r.length,i=n.indexOf(r,s);return o.push(Yo(e.substring(s))),o.join("")}const Zo={"&":"&","<":"<",">":">","'":"'",'"':"""};function Yo(e){return e.replace(/[&<>"']/g,(e=>Zo[e]))}const{window:Xo}=Dt;function es(e){let t,n,r;function o(t){e[13](t)}let s={results:e[0]};return void 0!==e[3]&&(s.resultsEl=e[3]),t=new Jo({props:s}),un.push((()=>function(e,t,n){const r=e.$$.props[t];void 0!==r&&(e.$$.bound[r]=n,n(e.$$.ctx[r]))}(t,"resultsEl",o))),{c(){_n(t.$$.fragment)},m(e,n){Qn(t,e,n),r=!0},p(e,r){const o={};var s;1&r&&(o.results=e[0]),!n&&8&r&&(n=!0,o.resultsEl=e[3],s=()=>n=!1,dn.push(s)),t.$set(o)},i(e){r||(An(t.$$.fragment,e),r=!0)},o(e){Cn(t.$$.fragment,e),r=!1},d(e){Un(t,e)}}}function ts(e){let t,n,r,o,s,i,a,l=e[0].length&&es(e);return{c(){t=Qt("input"),r=Bt(),l&&l.c(),o=zt(),qt(t,"type","search"),qt(t,"id","dmt-search-field"),qt(t,"aria-label","Search"),qt(t,"class","svelte-tuln0o"),Jt(t,"color",e[4]?"red":null),Jt(t,"border-color",e[4]?"red":null)},m(n,c){Nt(n,t,c),e[11](t),Kt(t,e[1]),Nt(n,r,c),l&&l.m(n,c),Nt(n,o,c),s=!0,i||(a=[Ht(Xo,"pointerdown",e[10]),Ht(t,"input",e[12]),Ht(t,"keydown",e[9])],i=!0)},p(e,[n]){2&n&&t.value!==e[1]&&Kt(t,e[1]),16&n&&Jt(t,"color",e[4]?"red":null),16&n&&Jt(t,"border-color",e[4]?"red":null),e[0].length?l?(l.p(e,n),1&n&&An(l,1)):(l=es(e),l.c(),An(l,1),l.m(o.parentNode,o)):l&&(Tn(),Cn(l,1,1,(()=>{l=null})),Ln())},i(r){s||(r&&yn((()=>{s&&(n||(n=Pn(t,e[8],{duration:200},!0)),n.run(1))})),An(l),s=!0)},o(r){r&&(n||(n=Pn(t,e[8],{duration:200},!1)),n.run(0)),Cn(l),s=!1},d(s){s&&(_t(t),_t(r),_t(o)),e[11](null),s&&n&&n.end(),l&&l.d(s),i=!1,dt(a)}}}function ns(e,t,n){let r,o,s,i;const a=Hn(void 0);sn("#storeCurrentId",a);const l=an("#basePath"),c=an("#navModuleIcon"),u=an("#searchFullName"),f=an("#searchLimit"),d=an("#storeVisible");bt(e,d,(e=>n(15,o=e)));const h=an("#storeSettingAnimate");bt(e,h,(e=>n(16,i=e)));const p=Hn("");bt(e,p,(e=>n(1,s=e)));const g=i?Hr:()=>{},m={basePath:l,navModuleIcon:c,searchFullName:u,searchLimit:f};let y,v,b,w=0;var x;return x=()=>y.focus(),on().$$.on_mount.push(x),e.$$.update=()=>{2&e.$$.dirty&&(n(0,v=function(e,{basePath:t,navModuleIcon:n=!0,searchFullName:r=!1,searchLimit:o=10}={}){if(!globalThis.dmtSearchMainIndex||!globalThis.dmtSearchMainRows)return[];const s=e.trim();if(0===s.length)return[];const i=globalThis.dmtSearchMainIndex.search(`*${s}*`),a=[];for(let e=0;et.score-e.score));for(let e=Math.min(o,i.length),l=0;l${Go(c.p,s)}.${u}`);const f=n||2!==c.k?c.k:void 0;a.push({id:o,kind:f,classes:c.c??"",href:`${t}${c.u}`,name:u})}return a}(s,{...m})),w=-1,a.set(void 0)),3&e.$$.dirty&&n(4,r=s.length&&!v?.length)},[v,s,y,b,r,d,h,p,g,function(e){switch(e.code){case"ArrowDown":if(0===v.length)return;w0&&(a.set(v[--w].id),e.preventDefault());break;case"Enter":w>=0&&(window.location.href=v[w].href),e.preventDefault();break;case"Escape":o&&!s.length&&Tt(d,o=!1,o);break;case"Tab":if(0===v.length)return void e.preventDefault();e.shiftKey?w>0&&a.set(v[--w].id):w{y=e,n(2,y)}))},function(){s=this.value,p.set(s)},function(e){b=e,n(3,b)}]}class rs extends Bn{constructor(e){super(),jn(this,e,ns,ts,pt,{})}}function os(e){let t,n;return t=new rs({}),{c(){_n(t.$$.fragment)},m(e,r){Qn(t,e,r),n=!0},i(e){n||(An(t.$$.fragment,e),n=!0)},o(e){Cn(t.$$.fragment,e),n=!1},d(e){Un(t,e)}}}function ss(e){let t,n,r,o,s,i,a=e[0]&&os();return r=new zo({}),{c(){a&&a.c(),t=Bt(),n=Qt("div"),_n(r.$$.fragment),qt(n,"class","dmt-widget dmt-toolbar-icon search no-caption svelte-wmon9h")},m(l,c){a&&a.m(l,c),Nt(l,t,c),Nt(l,n,c),Qn(r,n,null),o=!0,s||(i=Ht(window,"keydown",e[2]),s=!0)},p(e,[n]){e[0]?a?1&n&&An(a,1):(a=os(),a.c(),An(a,1),a.m(t.parentNode,t)):a&&(Tn(),Cn(a,1,1,(()=>{a=null})),Ln())},i(e){o||(An(a),An(r.$$.fragment,e),o=!0)},o(e){Cn(a),Cn(r.$$.fragment,e),o=!1},d(e){e&&(_t(t),_t(n)),a&&a.d(e),Un(r),s=!1,i()}}}function is(e,t,n){let r,{dmtComponentData:o}=t;const s=Hn(!1);return bt(e,s,(e=>n(0,r=e))),sn("#basePath",o.basePath),sn("#navModuleIcon",o.navModuleIcon),sn("#searchFullName",o.search.fullName),sn("#searchLimit",o.search?.limit??10),sn("#storeVisible",s),sn("#storeSettingAnimate",o.dmtLocalStorage.getStore(Xr)),e.$$set=e=>{"dmtComponentData"in e&&n(3,o=e.dmtComponentData)},[r,s,function(e){if(e.altKey&&!e.repeat&&"KeyS"===e.code)e.preventDefault(),Tt(s,r=!0,r)},o]}const as=class extends Bn{constructor(e){super(),jn(this,e,is,ss,pt,{dmtComponentData:3})}};var ls,cs={exports:{}}; + +import './dmt-component-data.js'; + +var decoder; +try { + decoder = new TextDecoder(); +} catch(error) {} +var src; +var srcEnd; +var position$1 = 0; +var currentUnpackr = {}; +var currentStructures; +var srcString; +var srcStringStart = 0; +var srcStringEnd = 0; +var bundledStrings$1; +var referenceMap; +var currentExtensions = []; +var dataView; +var defaultOptions = { + useRecords: false, + mapsAsObjects: true +}; +class C1Type {} +const C1 = new C1Type(); +C1.name = 'MessagePack 0xC1'; +var sequentialMode = false; +var inlineObjectReadThreshold = 2; +var readStruct; +// no-eval build +try { + new Function(''); +} catch(error) { + // if eval variants are not supported, do not create inline object readers ever + inlineObjectReadThreshold = Infinity; +} + +class Unpackr { + constructor(options) { + if (options) { + if (options.useRecords === false && options.mapsAsObjects === undefined) + options.mapsAsObjects = true; + if (options.sequential && options.trusted !== false) { + options.trusted = true; + if (!options.structures && options.useRecords != false) { + options.structures = []; + if (!options.maxSharedStructures) + options.maxSharedStructures = 0; + } + } + if (options.structures) + options.structures.sharedLength = options.structures.length; + else if (options.getStructures) { + (options.structures = []).uninitialized = true; // this is what we use to denote an uninitialized structures + options.structures.sharedLength = 0; + } + if (options.int64AsNumber) { + options.int64AsType = 'number'; + } + } + Object.assign(this, options); + } + unpack(source, options) { + if (src) { + // re-entrant execution, save the state and restore it after we do this unpack + return saveState(() => { + clearSource(); + return this ? this.unpack(source, options) : Unpackr.prototype.unpack.call(defaultOptions, source, options) + }) + } + if (!source.buffer && source.constructor === ArrayBuffer) + source = typeof Buffer !== 'undefined' ? Buffer.from(source) : new Uint8Array(source); + if (typeof options === 'object') { + srcEnd = options.end || source.length; + position$1 = options.start || 0; + } else { + position$1 = 0; + srcEnd = options > -1 ? options : source.length; + } + srcStringEnd = 0; + srcString = null; + bundledStrings$1 = null; + src = source; + // this provides cached access to the data view for a buffer if it is getting reused, which is a recommend + // technique for getting data from a database where it can be copied into an existing buffer instead of creating + // new ones + try { + dataView = source.dataView || (source.dataView = new DataView(source.buffer, source.byteOffset, source.byteLength)); + } catch(error) { + // if it doesn't have a buffer, maybe it is the wrong type of object + src = null; + if (source instanceof Uint8Array) + throw error + throw new Error('Source must be a Uint8Array or Buffer but was a ' + ((source && typeof source == 'object') ? source.constructor.name : typeof source)) + } + if (this instanceof Unpackr) { + currentUnpackr = this; + if (this.structures) { + currentStructures = this.structures; + return checkedRead(options) + } else if (!currentStructures || currentStructures.length > 0) { + currentStructures = []; + } + } else { + currentUnpackr = defaultOptions; + if (!currentStructures || currentStructures.length > 0) + currentStructures = []; + } + return checkedRead(options) + } + unpackMultiple(source, forEach) { + let values, lastPosition = 0; + try { + sequentialMode = true; + let size = source.length; + let value = this ? this.unpack(source, size) : defaultUnpackr.unpack(source, size); + if (forEach) { + if (forEach(value, lastPosition, position$1) === false) return; + while(position$1 < size) { + lastPosition = position$1; + if (forEach(checkedRead(), lastPosition, position$1) === false) { + return + } + } + } + else { + values = [ value ]; + while(position$1 < size) { + lastPosition = position$1; + values.push(checkedRead()); + } + return values + } + } catch(error) { + error.lastPosition = lastPosition; + error.values = values; + throw error + } finally { + sequentialMode = false; + clearSource(); + } + } + _mergeStructures(loadedStructures, existingStructures) { + loadedStructures = loadedStructures || []; + if (Object.isFrozen(loadedStructures)) + loadedStructures = loadedStructures.map(structure => structure.slice(0)); + for (let i = 0, l = loadedStructures.length; i < l; i++) { + let structure = loadedStructures[i]; + if (structure) { + structure.isShared = true; + if (i >= 32) + structure.highByte = (i - 32) >> 5; + } + } + loadedStructures.sharedLength = loadedStructures.length; + for (let id in existingStructures || []) { + if (id >= 0) { + let structure = loadedStructures[id]; + let existing = existingStructures[id]; + if (existing) { + if (structure) + (loadedStructures.restoreStructures || (loadedStructures.restoreStructures = []))[id] = structure; + loadedStructures[id] = existing; + } + } + } + return this.structures = loadedStructures + } + decode(source, options) { + return this.unpack(source, options) + } +} +function checkedRead(options) { + try { + if (!currentUnpackr.trusted && !sequentialMode) { + let sharedLength = currentStructures.sharedLength || 0; + if (sharedLength < currentStructures.length) + currentStructures.length = sharedLength; + } + let result; + if (currentUnpackr.randomAccessStructure && src[position$1] < 0x40 && src[position$1] >= 0x20 && readStruct) { + result = readStruct(src, position$1, srcEnd, currentUnpackr); + src = null; // dispose of this so that recursive unpack calls don't save state + if (!(options && options.lazy) && result) + result = result.toJSON(); + position$1 = srcEnd; + } else + result = read(); + if (bundledStrings$1) { // bundled strings to skip past + position$1 = bundledStrings$1.postBundlePosition; + bundledStrings$1 = null; + } + if (sequentialMode) + // we only need to restore the structures if there was an error, but if we completed a read, + // we can clear this out and keep the structures we read + currentStructures.restoreStructures = null; + + if (position$1 == srcEnd) { + // finished reading this source, cleanup references + if (currentStructures && currentStructures.restoreStructures) + restoreStructures(); + currentStructures = null; + src = null; + if (referenceMap) + referenceMap = null; + } else if (position$1 > srcEnd) { + // over read + throw new Error('Unexpected end of MessagePack data') + } else if (!sequentialMode) { + let jsonView; + try { + jsonView = JSON.stringify(result, (_, value) => typeof value === "bigint" ? `${value}n` : value).slice(0, 100); + } catch(error) { + jsonView = '(JSON view not available ' + error + ')'; + } + throw new Error('Data read, but end of buffer not reached ' + jsonView) + } + // else more to read, but we are reading sequentially, so don't clear source yet + return result + } catch(error) { + if (currentStructures && currentStructures.restoreStructures) + restoreStructures(); + clearSource(); + if (error instanceof RangeError || error.message.startsWith('Unexpected end of buffer') || position$1 > srcEnd) { + error.incomplete = true; + } + throw error + } +} + +function restoreStructures() { + for (let id in currentStructures.restoreStructures) { + currentStructures[id] = currentStructures.restoreStructures[id]; + } + currentStructures.restoreStructures = null; +} + +function read() { + let token = src[position$1++]; + if (token < 0xa0) { + if (token < 0x80) { + if (token < 0x40) + return token + else { + let structure = currentStructures[token & 0x3f] || + currentUnpackr.getStructures && loadStructures()[token & 0x3f]; + if (structure) { + if (!structure.read) { + structure.read = createStructureReader(structure, token & 0x3f); + } + return structure.read() + } else + return token + } + } else if (token < 0x90) { + // map + token -= 0x80; + if (currentUnpackr.mapsAsObjects) { + let object = {}; + for (let i = 0; i < token; i++) { + let key = readKey(); + if (key === '__proto__') + key = '__proto_'; + object[key] = read(); + } + return object + } else { + let map = new Map(); + for (let i = 0; i < token; i++) { + map.set(read(), read()); + } + return map + } + } else { + token -= 0x90; + let array = new Array(token); + for (let i = 0; i < token; i++) { + array[i] = read(); + } + if (currentUnpackr.freezeData) + return Object.freeze(array) + return array + } + } else if (token < 0xc0) { + // fixstr + let length = token - 0xa0; + if (srcStringEnd >= position$1) { + return srcString.slice(position$1 - srcStringStart, (position$1 += length) - srcStringStart) + } + if (srcStringEnd == 0 && srcEnd < 140) { + // for small blocks, avoiding the overhead of the extract call is helpful + let string = length < 16 ? shortStringInJS(length) : longStringInJS(length); + if (string != null) + return string + } + return readFixedString(length) + } else { + let value; + switch (token) { + case 0xc0: return null + case 0xc1: + if (bundledStrings$1) { + value = read(); // followed by the length of the string in characters (not bytes!) + if (value > 0) + return bundledStrings$1[1].slice(bundledStrings$1.position1, bundledStrings$1.position1 += value) + else + return bundledStrings$1[0].slice(bundledStrings$1.position0, bundledStrings$1.position0 -= value) + } + return C1; // "never-used", return special object to denote that + case 0xc2: return false + case 0xc3: return true + case 0xc4: + // bin 8 + value = src[position$1++]; + if (value === undefined) + throw new Error('Unexpected end of buffer') + return readBin(value) + case 0xc5: + // bin 16 + value = dataView.getUint16(position$1); + position$1 += 2; + return readBin(value) + case 0xc6: + // bin 32 + value = dataView.getUint32(position$1); + position$1 += 4; + return readBin(value) + case 0xc7: + // ext 8 + return readExt(src[position$1++]) + case 0xc8: + // ext 16 + value = dataView.getUint16(position$1); + position$1 += 2; + return readExt(value) + case 0xc9: + // ext 32 + value = dataView.getUint32(position$1); + position$1 += 4; + return readExt(value) + case 0xca: + value = dataView.getFloat32(position$1); + if (currentUnpackr.useFloat32 > 2) { + // this does rounding of numbers that were encoded in 32-bit float to nearest significant decimal digit that could be preserved + let multiplier = mult10[((src[position$1] & 0x7f) << 1) | (src[position$1 + 1] >> 7)]; + position$1 += 4; + return ((multiplier * value + (value > 0 ? 0.5 : -0.5)) >> 0) / multiplier + } + position$1 += 4; + return value + case 0xcb: + value = dataView.getFloat64(position$1); + position$1 += 8; + return value + // uint handlers + case 0xcc: + return src[position$1++] + case 0xcd: + value = dataView.getUint16(position$1); + position$1 += 2; + return value + case 0xce: + value = dataView.getUint32(position$1); + position$1 += 4; + return value + case 0xcf: + if (currentUnpackr.int64AsType === 'number') { + value = dataView.getUint32(position$1) * 0x100000000; + value += dataView.getUint32(position$1 + 4); + } else if (currentUnpackr.int64AsType === 'string') { + value = dataView.getBigUint64(position$1).toString(); + } else if (currentUnpackr.int64AsType === 'auto') { + value = dataView.getBigUint64(position$1); + if (value<=BigInt(2)<=BigInt(-2)<= position$1) { + return srcString.slice(position$1 - srcStringStart, (position$1 += value) - srcStringStart) + } + return readString8(value) + case 0xda: + // str 16 + value = dataView.getUint16(position$1); + position$1 += 2; + if (srcStringEnd >= position$1) { + return srcString.slice(position$1 - srcStringStart, (position$1 += value) - srcStringStart) + } + return readString16(value) + case 0xdb: + // str 32 + value = dataView.getUint32(position$1); + position$1 += 4; + if (srcStringEnd >= position$1) { + return srcString.slice(position$1 - srcStringStart, (position$1 += value) - srcStringStart) + } + return readString32(value) + case 0xdc: + // array 16 + value = dataView.getUint16(position$1); + position$1 += 2; + return readArray(value) + case 0xdd: + // array 32 + value = dataView.getUint32(position$1); + position$1 += 4; + return readArray(value) + case 0xde: + // map 16 + value = dataView.getUint16(position$1); + position$1 += 2; + return readMap(value) + case 0xdf: + // map 32 + value = dataView.getUint32(position$1); + position$1 += 4; + return readMap(value) + default: // negative int + if (token >= 0xe0) + return token - 0x100 + if (token === undefined) { + let error = new Error('Unexpected end of MessagePack data'); + error.incomplete = true; + throw error + } + throw new Error('Unknown MessagePack token ' + token) + + } + } +} +const validName = /^[a-zA-Z_$][a-zA-Z\d_$]*$/; +function createStructureReader(structure, firstId) { + function readObject() { + // This initial function is quick to instantiate, but runs slower. After several iterations pay the cost to build the faster function + if (readObject.count++ > inlineObjectReadThreshold) { + let readObject = structure.read = (new Function('r', 'return function(){return ' + (currentUnpackr.freezeData ? 'Object.freeze' : '') + + '({' + structure.map(key => key === '__proto__' ? '__proto_:r()' : validName.test(key) ? key + ':r()' : ('[' + JSON.stringify(key) + ']:r()')).join(',') + '})}'))(read); + if (structure.highByte === 0) + structure.read = createSecondByteReader(firstId, structure.read); + return readObject() // second byte is already read, if there is one so immediately read object + } + let object = {}; + for (let i = 0, l = structure.length; i < l; i++) { + let key = structure[i]; + if (key === '__proto__') + key = '__proto_'; + object[key] = read(); + } + if (currentUnpackr.freezeData) + return Object.freeze(object); + return object + } + readObject.count = 0; + if (structure.highByte === 0) { + return createSecondByteReader(firstId, readObject) + } + return readObject +} + +const createSecondByteReader = (firstId, read0) => { + return function() { + let highByte = src[position$1++]; + if (highByte === 0) + return read0() + let id = firstId < 32 ? -(firstId + (highByte << 5)) : firstId + (highByte << 5); + let structure = currentStructures[id] || loadStructures()[id]; + if (!structure) { + throw new Error('Record id is not defined for ' + id) + } + if (!structure.read) + structure.read = createStructureReader(structure, firstId); + return structure.read() + } +}; + +function loadStructures() { + let loadedStructures = saveState(() => { + // save the state in case getStructures modifies our buffer + src = null; + return currentUnpackr.getStructures() + }); + return currentStructures = currentUnpackr._mergeStructures(loadedStructures, currentStructures) +} + +var readFixedString = readStringJS; +var readString8 = readStringJS; +var readString16 = readStringJS; +var readString32 = readStringJS; +function readStringJS(length) { + let result; + if (length < 16) { + if (result = shortStringInJS(length)) + return result + } + if (length > 64 && decoder) + return decoder.decode(src.subarray(position$1, position$1 += length)) + const end = position$1 + length; + const units = []; + result = ''; + while (position$1 < end) { + const byte1 = src[position$1++]; + if ((byte1 & 0x80) === 0) { + // 1 byte + units.push(byte1); + } else if ((byte1 & 0xe0) === 0xc0) { + // 2 bytes + const byte2 = src[position$1++] & 0x3f; + units.push(((byte1 & 0x1f) << 6) | byte2); + } else if ((byte1 & 0xf0) === 0xe0) { + // 3 bytes + const byte2 = src[position$1++] & 0x3f; + const byte3 = src[position$1++] & 0x3f; + units.push(((byte1 & 0x1f) << 12) | (byte2 << 6) | byte3); + } else if ((byte1 & 0xf8) === 0xf0) { + // 4 bytes + const byte2 = src[position$1++] & 0x3f; + const byte3 = src[position$1++] & 0x3f; + const byte4 = src[position$1++] & 0x3f; + let unit = ((byte1 & 0x07) << 0x12) | (byte2 << 0x0c) | (byte3 << 0x06) | byte4; + if (unit > 0xffff) { + unit -= 0x10000; + units.push(((unit >>> 10) & 0x3ff) | 0xd800); + unit = 0xdc00 | (unit & 0x3ff); + } + units.push(unit); + } else { + units.push(byte1); + } + + if (units.length >= 0x1000) { + result += fromCharCode.apply(String, units); + units.length = 0; + } + } + + if (units.length > 0) { + result += fromCharCode.apply(String, units); + } + + return result +} + +function readArray(length) { + let array = new Array(length); + for (let i = 0; i < length; i++) { + array[i] = read(); + } + if (currentUnpackr.freezeData) + return Object.freeze(array) + return array +} + +function readMap(length) { + if (currentUnpackr.mapsAsObjects) { + let object = {}; + for (let i = 0; i < length; i++) { + let key = readKey(); + if (key === '__proto__') + key = '__proto_'; + object[key] = read(); + } + return object + } else { + let map = new Map(); + for (let i = 0; i < length; i++) { + map.set(read(), read()); + } + return map + } +} + +var fromCharCode = String.fromCharCode; +function longStringInJS(length) { + let start = position$1; + let bytes = new Array(length); + for (let i = 0; i < length; i++) { + const byte = src[position$1++]; + if ((byte & 0x80) > 0) { + position$1 = start; + return + } + bytes[i] = byte; + } + return fromCharCode.apply(String, bytes) +} +function shortStringInJS(length) { + if (length < 4) { + if (length < 2) { + if (length === 0) + return '' + else { + let a = src[position$1++]; + if ((a & 0x80) > 1) { + position$1 -= 1; + return + } + return fromCharCode(a) + } + } else { + let a = src[position$1++]; + let b = src[position$1++]; + if ((a & 0x80) > 0 || (b & 0x80) > 0) { + position$1 -= 2; + return + } + if (length < 3) + return fromCharCode(a, b) + let c = src[position$1++]; + if ((c & 0x80) > 0) { + position$1 -= 3; + return + } + return fromCharCode(a, b, c) + } + } else { + let a = src[position$1++]; + let b = src[position$1++]; + let c = src[position$1++]; + let d = src[position$1++]; + if ((a & 0x80) > 0 || (b & 0x80) > 0 || (c & 0x80) > 0 || (d & 0x80) > 0) { + position$1 -= 4; + return + } + if (length < 6) { + if (length === 4) + return fromCharCode(a, b, c, d) + else { + let e = src[position$1++]; + if ((e & 0x80) > 0) { + position$1 -= 5; + return + } + return fromCharCode(a, b, c, d, e) + } + } else if (length < 8) { + let e = src[position$1++]; + let f = src[position$1++]; + if ((e & 0x80) > 0 || (f & 0x80) > 0) { + position$1 -= 6; + return + } + if (length < 7) + return fromCharCode(a, b, c, d, e, f) + let g = src[position$1++]; + if ((g & 0x80) > 0) { + position$1 -= 7; + return + } + return fromCharCode(a, b, c, d, e, f, g) + } else { + let e = src[position$1++]; + let f = src[position$1++]; + let g = src[position$1++]; + let h = src[position$1++]; + if ((e & 0x80) > 0 || (f & 0x80) > 0 || (g & 0x80) > 0 || (h & 0x80) > 0) { + position$1 -= 8; + return + } + if (length < 10) { + if (length === 8) + return fromCharCode(a, b, c, d, e, f, g, h) + else { + let i = src[position$1++]; + if ((i & 0x80) > 0) { + position$1 -= 9; + return + } + return fromCharCode(a, b, c, d, e, f, g, h, i) + } + } else if (length < 12) { + let i = src[position$1++]; + let j = src[position$1++]; + if ((i & 0x80) > 0 || (j & 0x80) > 0) { + position$1 -= 10; + return + } + if (length < 11) + return fromCharCode(a, b, c, d, e, f, g, h, i, j) + let k = src[position$1++]; + if ((k & 0x80) > 0) { + position$1 -= 11; + return + } + return fromCharCode(a, b, c, d, e, f, g, h, i, j, k) + } else { + let i = src[position$1++]; + let j = src[position$1++]; + let k = src[position$1++]; + let l = src[position$1++]; + if ((i & 0x80) > 0 || (j & 0x80) > 0 || (k & 0x80) > 0 || (l & 0x80) > 0) { + position$1 -= 12; + return + } + if (length < 14) { + if (length === 12) + return fromCharCode(a, b, c, d, e, f, g, h, i, j, k, l) + else { + let m = src[position$1++]; + if ((m & 0x80) > 0) { + position$1 -= 13; + return + } + return fromCharCode(a, b, c, d, e, f, g, h, i, j, k, l, m) + } + } else { + let m = src[position$1++]; + let n = src[position$1++]; + if ((m & 0x80) > 0 || (n & 0x80) > 0) { + position$1 -= 14; + return + } + if (length < 15) + return fromCharCode(a, b, c, d, e, f, g, h, i, j, k, l, m, n) + let o = src[position$1++]; + if ((o & 0x80) > 0) { + position$1 -= 15; + return + } + return fromCharCode(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) + } + } + } + } +} + +function readOnlyJSString() { + let token = src[position$1++]; + let length; + if (token < 0xc0) { + // fixstr + length = token - 0xa0; + } else { + switch(token) { + case 0xd9: + // str 8 + length = src[position$1++]; + break + case 0xda: + // str 16 + length = dataView.getUint16(position$1); + position$1 += 2; + break + case 0xdb: + // str 32 + length = dataView.getUint32(position$1); + position$1 += 4; + break + default: + throw new Error('Expected string') + } + } + return readStringJS(length) +} + + +function readBin(length) { + return currentUnpackr.copyBuffers ? + // specifically use the copying slice (not the node one) + Uint8Array.prototype.slice.call(src, position$1, position$1 += length) : + src.subarray(position$1, position$1 += length) +} +function readExt(length) { + let type = src[position$1++]; + if (currentExtensions[type]) { + let end; + return currentExtensions[type](src.subarray(position$1, end = (position$1 += length)), (readPosition) => { + position$1 = readPosition; + try { + return read(); + } finally { + position$1 = end; + } + }) + } + else + throw new Error('Unknown extension type ' + type) +} + +var keyCache = new Array(4096); +function readKey() { + let length = src[position$1++]; + if (length >= 0xa0 && length < 0xc0) { + // fixstr, potentially use key cache + length = length - 0xa0; + if (srcStringEnd >= position$1) // if it has been extracted, must use it (and faster anyway) + return srcString.slice(position$1 - srcStringStart, (position$1 += length) - srcStringStart) + else if (!(srcStringEnd == 0 && srcEnd < 180)) + return readFixedString(length) + } else { // not cacheable, go back and do a standard read + position$1--; + return asSafeString(read()) + } + let key = ((length << 5) ^ (length > 1 ? dataView.getUint16(position$1) : length > 0 ? src[position$1] : 0)) & 0xfff; + let entry = keyCache[key]; + let checkPosition = position$1; + let end = position$1 + length - 3; + let chunk; + let i = 0; + if (entry && entry.bytes == length) { + while (checkPosition < end) { + chunk = dataView.getUint32(checkPosition); + if (chunk != entry[i++]) { + checkPosition = 0x70000000; + break + } + checkPosition += 4; + } + end += 3; + while (checkPosition < end) { + chunk = src[checkPosition++]; + if (chunk != entry[i++]) { + checkPosition = 0x70000000; + break + } + } + if (checkPosition === end) { + position$1 = checkPosition; + return entry.string + } + end -= 3; + checkPosition = position$1; + } + entry = []; + keyCache[key] = entry; + entry.bytes = length; + while (checkPosition < end) { + chunk = dataView.getUint32(checkPosition); + entry.push(chunk); + checkPosition += 4; + } + end += 3; + while (checkPosition < end) { + chunk = src[checkPosition++]; + entry.push(chunk); + } + // for small blocks, avoiding the overhead of the extract call is helpful + let string = length < 16 ? shortStringInJS(length) : longStringInJS(length); + if (string != null) + return entry.string = string + return entry.string = readFixedString(length) +} + +function asSafeString(property) { + if (typeof property === 'string') return property; + if (typeof property === 'number') return property.toString(); + throw new Error('Invalid property type for record', typeof property); +} +// the registration of the record definition extension (as "r") +const recordDefinition = (id, highByte) => { + let structure = read().map(asSafeString); // ensure that all keys are strings and + // that the array is mutable + let firstByte = id; + if (highByte !== undefined) { + id = id < 32 ? -((highByte << 5) + id) : ((highByte << 5) + id); + structure.highByte = highByte; + } + let existingStructure = currentStructures[id]; + // If it is a shared structure, we need to restore any changes after reading. + // Also in sequential mode, we may get incomplete reads and thus errors, and we need to restore + // to the state prior to an incomplete read in order to properly resume. + if (existingStructure && (existingStructure.isShared || sequentialMode)) { + (currentStructures.restoreStructures || (currentStructures.restoreStructures = []))[id] = existingStructure; + } + currentStructures[id] = structure; + structure.read = createStructureReader(structure, firstByte); + return structure.read() +}; +currentExtensions[0] = () => {}; // notepack defines extension 0 to mean undefined, so use that as the default here +currentExtensions[0].noBuffer = true; + +currentExtensions[0x42] = (data) => { + // decode bigint + let length = data.length; + let value = BigInt(data[0] & 0x80 ? data[0] - 0x100 : data[0]); + for (let i = 1; i < length; i++) { + value <<= 8n; + value += BigInt(data[i]); + } + return value; +}; + +let errors = { Error, TypeError, ReferenceError }; +currentExtensions[0x65] = () => { + let data = read(); + return (errors[data[0]] || Error)(data[1]) +}; + +currentExtensions[0x69] = (data) => { + // id extension (for structured clones) + if (currentUnpackr.structuredClone === false) throw new Error('Structured clone extension is disabled') + let id = dataView.getUint32(position$1 - 4); + if (!referenceMap) + referenceMap = new Map(); + let token = src[position$1]; + let target; + // TODO: handle Maps, Sets, and other types that can cycle; this is complicated, because you potentially need to read + // ahead past references to record structure definitions + if (token >= 0x90 && token < 0xa0 || token == 0xdc || token == 0xdd) + target = []; + else + target = {}; + + let refEntry = { target }; // a placeholder object + referenceMap.set(id, refEntry); + let targetProperties = read(); // read the next value as the target object to id + if (refEntry.used) // there is a cycle, so we have to assign properties to original target + return Object.assign(target, targetProperties) + refEntry.target = targetProperties; // the placeholder wasn't used, replace with the deserialized one + return targetProperties // no cycle, can just use the returned read object +}; + +currentExtensions[0x70] = (data) => { + // pointer extension (for structured clones) + if (currentUnpackr.structuredClone === false) throw new Error('Structured clone extension is disabled') + let id = dataView.getUint32(position$1 - 4); + let refEntry = referenceMap.get(id); + refEntry.used = true; + return refEntry.target +}; + +currentExtensions[0x73] = () => new Set(read()); + +const typedArrays = ['Int8','Uint8','Uint8Clamped','Int16','Uint16','Int32','Uint32','Float32','Float64','BigInt64','BigUint64'].map(type => type + 'Array'); + +let glbl = typeof globalThis === 'object' ? globalThis : window; +currentExtensions[0x74] = (data) => { + let typeCode = data[0]; + let typedArrayName = typedArrays[typeCode]; + if (!typedArrayName) + throw new Error('Could not find typed array for code ' + typeCode) + // we have to always slice/copy here to get a new ArrayBuffer that is word/byte aligned + return new glbl[typedArrayName](Uint8Array.prototype.slice.call(data, 1).buffer) +}; +currentExtensions[0x78] = () => { + let data = read(); + return new RegExp(data[0], data[1]) +}; +const TEMP_BUNDLE = []; +currentExtensions[0x62] = (data) => { + let dataSize = (data[0] << 24) + (data[1] << 16) + (data[2] << 8) + data[3]; + let dataPosition = position$1; + position$1 += dataSize - data.length; + bundledStrings$1 = TEMP_BUNDLE; + bundledStrings$1 = [readOnlyJSString(), readOnlyJSString()]; + bundledStrings$1.position0 = 0; + bundledStrings$1.position1 = 0; + bundledStrings$1.postBundlePosition = position$1; + position$1 = dataPosition; + return read() +}; + +currentExtensions[0xff] = (data) => { + // 32-bit date extension + if (data.length == 4) + return new Date((data[0] * 0x1000000 + (data[1] << 16) + (data[2] << 8) + data[3]) * 1000) + else if (data.length == 8) + return new Date( + ((data[0] << 22) + (data[1] << 14) + (data[2] << 6) + (data[3] >> 2)) / 1000000 + + ((data[3] & 0x3) * 0x100000000 + data[4] * 0x1000000 + (data[5] << 16) + (data[6] << 8) + data[7]) * 1000) + else if (data.length == 12)// TODO: Implement support for negative + return new Date( + ((data[0] << 24) + (data[1] << 16) + (data[2] << 8) + data[3]) / 1000000 + + (((data[4] & 0x80) ? -0x1000000000000 : 0) + data[6] * 0x10000000000 + data[7] * 0x100000000 + data[8] * 0x1000000 + (data[9] << 16) + (data[10] << 8) + data[11]) * 1000) + else + return new Date('invalid') +}; // notepack defines extension 0 to mean undefined, so use that as the default here +// registration of bulk record definition? +// currentExtensions[0x52] = () => + +function saveState(callback) { + let savedSrcEnd = srcEnd; + let savedPosition = position$1; + let savedSrcStringStart = srcStringStart; + let savedSrcStringEnd = srcStringEnd; + let savedSrcString = srcString; + let savedReferenceMap = referenceMap; + let savedBundledStrings = bundledStrings$1; + + // TODO: We may need to revisit this if we do more external calls to user code (since it could be slow) + let savedSrc = new Uint8Array(src.slice(0, srcEnd)); // we copy the data in case it changes while external data is processed + let savedStructures = currentStructures; + let savedStructuresContents = currentStructures.slice(0, currentStructures.length); + let savedPackr = currentUnpackr; + let savedSequentialMode = sequentialMode; + let value = callback(); + srcEnd = savedSrcEnd; + position$1 = savedPosition; + srcStringStart = savedSrcStringStart; + srcStringEnd = savedSrcStringEnd; + srcString = savedSrcString; + referenceMap = savedReferenceMap; + bundledStrings$1 = savedBundledStrings; + src = savedSrc; + sequentialMode = savedSequentialMode; + currentStructures = savedStructures; + currentStructures.splice(0, currentStructures.length, ...savedStructuresContents); + currentUnpackr = savedPackr; + dataView = new DataView(src.buffer, src.byteOffset, src.byteLength); + return value +} +function clearSource() { + src = null; + referenceMap = null; + currentStructures = null; +} + +const mult10 = new Array(147); // this is a table matching binary exponents to the multiplier to determine significant digit rounding +for (let i = 0; i < 256; i++) { + mult10[i] = +('1e' + Math.floor(45.15 - i * 0.30103)); +} +var defaultUnpackr = new Unpackr({ useRecords: false }); +const unpack = defaultUnpackr.unpack; +defaultUnpackr.unpackMultiple; +defaultUnpackr.unpack; +let f32Array = new Float32Array(1); +new Uint8Array(f32Array.buffer, 0, 4); + +let textEncoder; +try { + textEncoder = new TextEncoder(); +} catch (error) {} +let extensions, extensionClasses; +const hasNodeBuffer = typeof Buffer !== 'undefined'; +const ByteArrayAllocate = hasNodeBuffer ? + function(length) { return Buffer.allocUnsafeSlow(length) } : Uint8Array; +const ByteArray = hasNodeBuffer ? Buffer : Uint8Array; +const MAX_BUFFER_SIZE = hasNodeBuffer ? 0x100000000 : 0x7fd00000; +let target, keysTarget; +let targetView; +let position = 0; +let safeEnd; +let bundledStrings = null; +let writeStructSlots; +const MAX_BUNDLE_SIZE = 0x5500; // maximum characters such that the encoded bytes fits in 16 bits. +const hasNonLatin = /[\u0080-\uFFFF]/; +const RECORD_SYMBOL = Symbol('record-id'); +class Packr extends Unpackr { + constructor(options) { + super(options); + this.offset = 0; + let start; + let hasSharedUpdate; + let structures; + let referenceMap; + let encodeUtf8 = ByteArray.prototype.utf8Write ? function(string, position) { + return target.utf8Write(string, position, 0xffffffff) + } : (textEncoder && textEncoder.encodeInto) ? + function(string, position) { + return textEncoder.encodeInto(string, target.subarray(position)).written + } : false; + + let packr = this; + if (!options) + options = {}; + let isSequential = options && options.sequential; + let hasSharedStructures = options.structures || options.saveStructures; + let maxSharedStructures = options.maxSharedStructures; + if (maxSharedStructures == null) + maxSharedStructures = hasSharedStructures ? 32 : 0; + if (maxSharedStructures > 8160) + throw new Error('Maximum maxSharedStructure is 8160') + if (options.structuredClone && options.moreTypes == undefined) { + this.moreTypes = true; + } + let maxOwnStructures = options.maxOwnStructures; + if (maxOwnStructures == null) + maxOwnStructures = hasSharedStructures ? 32 : 64; + if (!this.structures && options.useRecords != false) + this.structures = []; + // two byte record ids for shared structures + let useTwoByteRecords = maxSharedStructures > 32 || (maxOwnStructures + maxSharedStructures > 64); + let sharedLimitId = maxSharedStructures + 0x40; + let maxStructureId = maxSharedStructures + maxOwnStructures + 0x40; + if (maxStructureId > 8256) { + throw new Error('Maximum maxSharedStructure + maxOwnStructure is 8192') + } + let recordIdsToRemove = []; + let transitionsCount = 0; + let serializationsSinceTransitionRebuild = 0; + + this.pack = this.encode = function(value, encodeOptions) { + if (!target) { + target = new ByteArrayAllocate(8192); + targetView = target.dataView || (target.dataView = new DataView(target.buffer, 0, 8192)); + position = 0; + } + safeEnd = target.length - 10; + if (safeEnd - position < 0x800) { + // don't start too close to the end, + target = new ByteArrayAllocate(target.length); + targetView = target.dataView || (target.dataView = new DataView(target.buffer, 0, target.length)); + safeEnd = target.length - 10; + position = 0; + } else + position = (position + 7) & 0x7ffffff8; // Word align to make any future copying of this buffer faster + start = position; + if (encodeOptions & RESERVE_START_SPACE) position += (encodeOptions & 0xff); + referenceMap = packr.structuredClone ? new Map() : null; + if (packr.bundleStrings && typeof value !== 'string') { + bundledStrings = []; + bundledStrings.size = Infinity; // force a new bundle start on first string + } else + bundledStrings = null; + structures = packr.structures; + if (structures) { + if (structures.uninitialized) + structures = packr._mergeStructures(packr.getStructures()); + let sharedLength = structures.sharedLength || 0; + if (sharedLength > maxSharedStructures) { + //if (maxSharedStructures <= 32 && structures.sharedLength > 32) // TODO: could support this, but would need to update the limit ids + throw new Error('Shared structures is larger than maximum shared structures, try increasing maxSharedStructures to ' + structures.sharedLength) + } + if (!structures.transitions) { + // rebuild our structure transitions + structures.transitions = Object.create(null); + for (let i = 0; i < sharedLength; i++) { + let keys = structures[i]; + if (!keys) + continue + let nextTransition, transition = structures.transitions; + for (let j = 0, l = keys.length; j < l; j++) { + let key = keys[j]; + nextTransition = transition[key]; + if (!nextTransition) { + nextTransition = transition[key] = Object.create(null); + } + transition = nextTransition; + } + transition[RECORD_SYMBOL] = i + 0x40; + } + this.lastNamedStructuresLength = sharedLength; + } + if (!isSequential) { + structures.nextId = sharedLength + 0x40; + } + } + if (hasSharedUpdate) + hasSharedUpdate = false; + let encodingError; + try { + if (packr.randomAccessStructure && value && value.constructor && value.constructor === Object) + writeStruct(value); + else + pack(value); + let lastBundle = bundledStrings; + if (bundledStrings) + writeBundles(start, pack, 0); + if (referenceMap && referenceMap.idsToInsert) { + let idsToInsert = referenceMap.idsToInsert.sort((a, b) => a.offset > b.offset ? 1 : -1); + let i = idsToInsert.length; + let incrementPosition = -1; + while (lastBundle && i > 0) { + let insertionPoint = idsToInsert[--i].offset + start; + if (insertionPoint < (lastBundle.stringsPosition + start) && incrementPosition === -1) + incrementPosition = 0; + if (insertionPoint > (lastBundle.position + start)) { + if (incrementPosition >= 0) + incrementPosition += 6; + } else { + if (incrementPosition >= 0) { + // update the bundle reference now + targetView.setUint32(lastBundle.position + start, + targetView.getUint32(lastBundle.position + start) + incrementPosition); + incrementPosition = -1; // reset + } + lastBundle = lastBundle.previous; + i++; + } + } + if (incrementPosition >= 0 && lastBundle) { + // update the bundle reference now + targetView.setUint32(lastBundle.position + start, + targetView.getUint32(lastBundle.position + start) + incrementPosition); + } + position += idsToInsert.length * 6; + if (position > safeEnd) + makeRoom(position); + packr.offset = position; + let serialized = insertIds(target.subarray(start, position), idsToInsert); + referenceMap = null; + return serialized + } + packr.offset = position; // update the offset so next serialization doesn't write over our buffer, but can continue writing to same buffer sequentially + if (encodeOptions & REUSE_BUFFER_MODE) { + target.start = start; + target.end = position; + return target + } + return target.subarray(start, position) // position can change if we call pack again in saveStructures, so we get the buffer now + } catch(error) { + encodingError = error; + throw error; + } finally { + if (structures) { + resetStructures(); + if (hasSharedUpdate && packr.saveStructures) { + let sharedLength = structures.sharedLength || 0; + // we can't rely on start/end with REUSE_BUFFER_MODE since they will (probably) change when we save + let returnBuffer = target.subarray(start, position); + let newSharedData = prepareStructures(structures, packr); + if (!encodingError) { // TODO: If there is an encoding error, should make the structures as uninitialized so they get rebuilt next time + if (packr.saveStructures(newSharedData, newSharedData.isCompatible) === false) { + // get updated structures and try again if the update failed + return packr.pack(value, encodeOptions) + } + packr.lastNamedStructuresLength = sharedLength; + return returnBuffer + } + } + } + if (encodeOptions & RESET_BUFFER_MODE) + position = start; + } + }; + const resetStructures = () => { + if (serializationsSinceTransitionRebuild < 10) + serializationsSinceTransitionRebuild++; + let sharedLength = structures.sharedLength || 0; + if (structures.length > sharedLength && !isSequential) + structures.length = sharedLength; + if (transitionsCount > 10000) { + // force a rebuild occasionally after a lot of transitions so it can get cleaned up + structures.transitions = null; + serializationsSinceTransitionRebuild = 0; + transitionsCount = 0; + if (recordIdsToRemove.length > 0) + recordIdsToRemove = []; + } else if (recordIdsToRemove.length > 0 && !isSequential) { + for (let i = 0, l = recordIdsToRemove.length; i < l; i++) { + recordIdsToRemove[i][RECORD_SYMBOL] = 0; + } + recordIdsToRemove = []; + } + }; + const packArray = (value) => { + var length = value.length; + if (length < 0x10) { + target[position++] = 0x90 | length; + } else if (length < 0x10000) { + target[position++] = 0xdc; + target[position++] = length >> 8; + target[position++] = length & 0xff; + } else { + target[position++] = 0xdd; + targetView.setUint32(position, length); + position += 4; + } + for (let i = 0; i < length; i++) { + pack(value[i]); + } + }; + const pack = (value) => { + if (position > safeEnd) + target = makeRoom(position); + + var type = typeof value; + var length; + if (type === 'string') { + let strLength = value.length; + if (bundledStrings && strLength >= 4 && strLength < 0x1000) { + if ((bundledStrings.size += strLength) > MAX_BUNDLE_SIZE) { + let extStart; + let maxBytes = (bundledStrings[0] ? bundledStrings[0].length * 3 + bundledStrings[1].length : 0) + 10; + if (position + maxBytes > safeEnd) + target = makeRoom(position + maxBytes); + let lastBundle; + if (bundledStrings.position) { // here we use the 0x62 extension to write the last bundle and reserve space for the reference pointer to the next/current bundle + lastBundle = bundledStrings; + target[position] = 0xc8; // ext 16 + position += 3; // reserve for the writing bundle size + target[position++] = 0x62; // 'b' + extStart = position - start; + position += 4; // reserve for writing bundle reference + writeBundles(start, pack, 0); // write the last bundles + targetView.setUint16(extStart + start - 3, position - start - extStart); + } else { // here we use the 0x62 extension just to reserve the space for the reference pointer to the bundle (will be updated once the bundle is written) + target[position++] = 0xd6; // fixext 4 + target[position++] = 0x62; // 'b' + extStart = position - start; + position += 4; // reserve for writing bundle reference + } + bundledStrings = ['', '']; // create new ones + bundledStrings.previous = lastBundle; + bundledStrings.size = 0; + bundledStrings.position = extStart; + } + let twoByte = hasNonLatin.test(value); + bundledStrings[twoByte ? 0 : 1] += value; + target[position++] = 0xc1; + pack(twoByte ? -strLength : strLength); + return + } + let headerSize; + // first we estimate the header size, so we can write to the correct location + if (strLength < 0x20) { + headerSize = 1; + } else if (strLength < 0x100) { + headerSize = 2; + } else if (strLength < 0x10000) { + headerSize = 3; + } else { + headerSize = 5; + } + let maxBytes = strLength * 3; + if (position + maxBytes > safeEnd) + target = makeRoom(position + maxBytes); + + if (strLength < 0x40 || !encodeUtf8) { + let i, c1, c2, strPosition = position + headerSize; + for (i = 0; i < strLength; i++) { + c1 = value.charCodeAt(i); + if (c1 < 0x80) { + target[strPosition++] = c1; + } else if (c1 < 0x800) { + target[strPosition++] = c1 >> 6 | 0xc0; + target[strPosition++] = c1 & 0x3f | 0x80; + } else if ( + (c1 & 0xfc00) === 0xd800 && + ((c2 = value.charCodeAt(i + 1)) & 0xfc00) === 0xdc00 + ) { + c1 = 0x10000 + ((c1 & 0x03ff) << 10) + (c2 & 0x03ff); + i++; + target[strPosition++] = c1 >> 18 | 0xf0; + target[strPosition++] = c1 >> 12 & 0x3f | 0x80; + target[strPosition++] = c1 >> 6 & 0x3f | 0x80; + target[strPosition++] = c1 & 0x3f | 0x80; + } else { + target[strPosition++] = c1 >> 12 | 0xe0; + target[strPosition++] = c1 >> 6 & 0x3f | 0x80; + target[strPosition++] = c1 & 0x3f | 0x80; + } + } + length = strPosition - position - headerSize; + } else { + length = encodeUtf8(value, position + headerSize); + } + + if (length < 0x20) { + target[position++] = 0xa0 | length; + } else if (length < 0x100) { + if (headerSize < 2) { + target.copyWithin(position + 2, position + 1, position + 1 + length); + } + target[position++] = 0xd9; + target[position++] = length; + } else if (length < 0x10000) { + if (headerSize < 3) { + target.copyWithin(position + 3, position + 2, position + 2 + length); + } + target[position++] = 0xda; + target[position++] = length >> 8; + target[position++] = length & 0xff; + } else { + if (headerSize < 5) { + target.copyWithin(position + 5, position + 3, position + 3 + length); + } + target[position++] = 0xdb; + targetView.setUint32(position, length); + position += 4; + } + position += length; + } else if (type === 'number') { + if (value >>> 0 === value) {// positive integer, 32-bit or less + // positive uint + if (value < 0x20 || (value < 0x80 && this.useRecords === false) || (value < 0x40 && !this.randomAccessStructure)) { + target[position++] = value; + } else if (value < 0x100) { + target[position++] = 0xcc; + target[position++] = value; + } else if (value < 0x10000) { + target[position++] = 0xcd; + target[position++] = value >> 8; + target[position++] = value & 0xff; + } else { + target[position++] = 0xce; + targetView.setUint32(position, value); + position += 4; + } + } else if (value >> 0 === value) { // negative integer + if (value >= -0x20) { + target[position++] = 0x100 + value; + } else if (value >= -0x80) { + target[position++] = 0xd0; + target[position++] = value + 0x100; + } else if (value >= -0x8000) { + target[position++] = 0xd1; + targetView.setInt16(position, value); + position += 2; + } else { + target[position++] = 0xd2; + targetView.setInt32(position, value); + position += 4; + } + } else { + let useFloat32; + if ((useFloat32 = this.useFloat32) > 0 && value < 0x100000000 && value >= -0x80000000) { + target[position++] = 0xca; + targetView.setFloat32(position, value); + let xShifted; + if (useFloat32 < 4 || + // this checks for rounding of numbers that were encoded in 32-bit float to nearest significant decimal digit that could be preserved + ((xShifted = value * mult10[((target[position] & 0x7f) << 1) | (target[position + 1] >> 7)]) >> 0) === xShifted) { + position += 4; + return + } else + position--; // move back into position for writing a double + } + target[position++] = 0xcb; + targetView.setFloat64(position, value); + position += 8; + } + } else if (type === 'object' || type === 'function') { + if (!value) + target[position++] = 0xc0; + else { + if (referenceMap) { + let referee = referenceMap.get(value); + if (referee) { + if (!referee.id) { + let idsToInsert = referenceMap.idsToInsert || (referenceMap.idsToInsert = []); + referee.id = idsToInsert.push(referee); + } + target[position++] = 0xd6; // fixext 4 + target[position++] = 0x70; // "p" for pointer + targetView.setUint32(position, referee.id); + position += 4; + return + } else + referenceMap.set(value, { offset: position - start }); + } + let constructor = value.constructor; + if (constructor === Object) { + writeObject(value, true); + } else if (constructor === Array) { + packArray(value); + } else if (constructor === Map) { + if (this.mapAsEmptyObject) target[position++] = 0x80; + else { + length = value.size; + if (length < 0x10) { + target[position++] = 0x80 | length; + } else if (length < 0x10000) { + target[position++] = 0xde; + target[position++] = length >> 8; + target[position++] = length & 0xff; + } else { + target[position++] = 0xdf; + targetView.setUint32(position, length); + position += 4; + } + for (let [key, entryValue] of value) { + pack(key); + pack(entryValue); + } + } + } else { + for (let i = 0, l = extensions.length; i < l; i++) { + let extensionClass = extensionClasses[i]; + if (value instanceof extensionClass) { + let extension = extensions[i]; + if (extension.write) { + if (extension.type) { + target[position++] = 0xd4; // one byte "tag" extension + target[position++] = extension.type; + target[position++] = 0; + } + let writeResult = extension.write.call(this, value); + if (writeResult === value) { // avoid infinite recursion + if (Array.isArray(value)) { + packArray(value); + } else { + writeObject(value); + } + } else { + pack(writeResult); + } + return + } + let currentTarget = target; + let currentTargetView = targetView; + let currentPosition = position; + target = null; + let result; + try { + result = extension.pack.call(this, value, (size) => { + // restore target and use it + target = currentTarget; + currentTarget = null; + position += size; + if (position > safeEnd) + makeRoom(position); + return { + target, targetView, position: position - size + } + }, pack); + } finally { + // restore current target information (unless already restored) + if (currentTarget) { + target = currentTarget; + targetView = currentTargetView; + position = currentPosition; + safeEnd = target.length - 10; + } + } + if (result) { + if (result.length + position > safeEnd) + makeRoom(result.length + position); + position = writeExtensionData(result, target, position, extension.type); + } + return + } + } + // check isArray after extensions, because extensions can extend Array + if (Array.isArray(value)) { + packArray(value); + } else { + // use this as an alternate mechanism for expressing how to serialize + if (value.toJSON) { + const json = value.toJSON(); + // if for some reason value.toJSON returns itself it'll loop forever + if (json !== value) + return pack(json) + } + + // if there is a writeFunction, use it, otherwise just encode as undefined + if (type === 'function') + return pack(this.writeFunction && this.writeFunction(value)); + + // no extension found, write as object + writeObject(value, !value.hasOwnProperty); // if it doesn't have hasOwnProperty, don't do hasOwnProperty checks + } + } + } + } else if (type === 'boolean') { + target[position++] = value ? 0xc3 : 0xc2; + } else if (type === 'bigint') { + if (value < (BigInt(1)<= -(BigInt(1)< 0) { + // if we can fit an unsigned int, use that + target[position++] = 0xcf; + targetView.setBigUint64(position, value); + } else { + // overflow + if (this.largeBigIntToFloat) { + target[position++] = 0xcb; + targetView.setFloat64(position, Number(value)); + } else if (this.useBigIntExtension && value < 2n**(1023n) && value > -(2n**(1023n))) { + target[position++] = 0xc7; + position++; + target[position++] = 0x42; // "B" for BigInt + let bytes = []; + let alignedSign; + do { + let byte = value & 0xffn; + alignedSign = (byte & 0x80n) === (value < 0n ? 0x80n : 0n); + bytes.push(byte); + value >>= 8n; + } while (!((value === 0n || value === -1n) && alignedSign)); + target[position-2] = bytes.length; + for (let i = bytes.length; i > 0;) { + target[position++] = Number(bytes[--i]); + } + return + } else { + throw new RangeError(value + ' was too large to fit in MessagePack 64-bit integer format, use' + + ' useBigIntExtension or set largeBigIntToFloat to convert to float-64') + } + } + position += 8; + } else if (type === 'undefined') { + if (this.encodeUndefinedAsNil) + target[position++] = 0xc0; + else { + target[position++] = 0xd4; // a number of implementations use fixext1 with type 0, data 0 to denote undefined, so we follow suite + target[position++] = 0; + target[position++] = 0; + } + } else { + throw new Error('Unknown type: ' + type) + } + }; + + const writePlainObject = (this.variableMapSize || this.coercibleKeyAsNumber) ? (object) => { + // this method is slightly slower, but generates "preferred serialization" (optimally small for smaller objects) + let keys = Object.keys(object); + let length = keys.length; + if (length < 0x10) { + target[position++] = 0x80 | length; + } else if (length < 0x10000) { + target[position++] = 0xde; + target[position++] = length >> 8; + target[position++] = length & 0xff; + } else { + target[position++] = 0xdf; + targetView.setUint32(position, length); + position += 4; + } + let key; + if (this.coercibleKeyAsNumber) { + for (let i = 0; i < length; i++) { + key = keys[i]; + let num = Number(key); + pack(isNaN(num) ? key : num); + pack(object[key]); + } + + } else { + for (let i = 0; i < length; i++) { + pack(key = keys[i]); + pack(object[key]); + } + } + } : + (object, safePrototype) => { + target[position++] = 0xde; // always using map 16, so we can preallocate and set the length afterwards + let objectOffset = position - start; + position += 2; + let size = 0; + for (let key in object) { + if (safePrototype || object.hasOwnProperty(key)) { + pack(key); + pack(object[key]); + size++; + } + } + target[objectOffset++ + start] = size >> 8; + target[objectOffset + start] = size & 0xff; + }; + + const writeRecord = this.useRecords === false ? writePlainObject : + (options.progressiveRecords && !useTwoByteRecords) ? // this is about 2% faster for highly stable structures, since it only requires one for-in loop (but much more expensive when new structure needs to be written) + (object, safePrototype) => { + let nextTransition, transition = structures.transitions || (structures.transitions = Object.create(null)); + let objectOffset = position++ - start; + let wroteKeys; + for (let key in object) { + if (safePrototype || object.hasOwnProperty(key)) { + nextTransition = transition[key]; + if (nextTransition) + transition = nextTransition; + else { + // record doesn't exist, create full new record and insert it + let keys = Object.keys(object); + let lastTransition = transition; + transition = structures.transitions; + let newTransitions = 0; + for (let i = 0, l = keys.length; i < l; i++) { + let key = keys[i]; + nextTransition = transition[key]; + if (!nextTransition) { + nextTransition = transition[key] = Object.create(null); + newTransitions++; + } + transition = nextTransition; + } + if (objectOffset + start + 1 == position) { + // first key, so we don't need to insert, we can just write record directly + position--; + newRecord(transition, keys, newTransitions); + } else // otherwise we need to insert the record, moving existing data after the record + insertNewRecord(transition, keys, objectOffset, newTransitions); + wroteKeys = true; + transition = lastTransition[key]; + } + pack(object[key]); + } + } + if (!wroteKeys) { + let recordId = transition[RECORD_SYMBOL]; + if (recordId) + target[objectOffset + start] = recordId; + else + insertNewRecord(transition, Object.keys(object), objectOffset, 0); + } + } : + (object, safePrototype) => { + let nextTransition, transition = structures.transitions || (structures.transitions = Object.create(null)); + let newTransitions = 0; + for (let key in object) if (safePrototype || object.hasOwnProperty(key)) { + nextTransition = transition[key]; + if (!nextTransition) { + nextTransition = transition[key] = Object.create(null); + newTransitions++; + } + transition = nextTransition; + } + let recordId = transition[RECORD_SYMBOL]; + if (recordId) { + if (recordId >= 0x60 && useTwoByteRecords) { + target[position++] = ((recordId -= 0x60) & 0x1f) + 0x60; + target[position++] = recordId >> 5; + } else + target[position++] = recordId; + } else { + newRecord(transition, transition.__keys__ || Object.keys(object), newTransitions); + } + // now write the values + for (let key in object) + if (safePrototype || object.hasOwnProperty(key)) { + pack(object[key]); + } + }; + + // craete reference to useRecords if useRecords is a function + const checkUseRecords = typeof this.useRecords == 'function' && this.useRecords; + + const writeObject = checkUseRecords ? (object, safePrototype) => { + checkUseRecords(object) ? writeRecord(object,safePrototype) : writePlainObject(object,safePrototype); + } : writeRecord; + + const makeRoom = (end) => { + let newSize; + if (end > 0x1000000) { + // special handling for really large buffers + if ((end - start) > MAX_BUFFER_SIZE) + throw new Error('Packed buffer would be larger than maximum buffer size') + newSize = Math.min(MAX_BUFFER_SIZE, + Math.round(Math.max((end - start) * (end > 0x4000000 ? 1.25 : 2), 0x400000) / 0x1000) * 0x1000); + } else // faster handling for smaller buffers + newSize = ((Math.max((end - start) << 2, target.length - 1) >> 12) + 1) << 12; + let newBuffer = new ByteArrayAllocate(newSize); + targetView = newBuffer.dataView || (newBuffer.dataView = new DataView(newBuffer.buffer, 0, newSize)); + end = Math.min(end, target.length); + if (target.copy) + target.copy(newBuffer, 0, start, end); + else + newBuffer.set(target.slice(start, end)); + position -= start; + start = 0; + safeEnd = newBuffer.length - 10; + return target = newBuffer + }; + const newRecord = (transition, keys, newTransitions) => { + let recordId = structures.nextId; + if (!recordId) + recordId = 0x40; + if (recordId < sharedLimitId && this.shouldShareStructure && !this.shouldShareStructure(keys)) { + recordId = structures.nextOwnId; + if (!(recordId < maxStructureId)) + recordId = sharedLimitId; + structures.nextOwnId = recordId + 1; + } else { + if (recordId >= maxStructureId)// cycle back around + recordId = sharedLimitId; + structures.nextId = recordId + 1; + } + let highByte = keys.highByte = recordId >= 0x60 && useTwoByteRecords ? (recordId - 0x60) >> 5 : -1; + transition[RECORD_SYMBOL] = recordId; + transition.__keys__ = keys; + structures[recordId - 0x40] = keys; + + if (recordId < sharedLimitId) { + keys.isShared = true; + structures.sharedLength = recordId - 0x3f; + hasSharedUpdate = true; + if (highByte >= 0) { + target[position++] = (recordId & 0x1f) + 0x60; + target[position++] = highByte; + } else { + target[position++] = recordId; + } + } else { + if (highByte >= 0) { + target[position++] = 0xd5; // fixext 2 + target[position++] = 0x72; // "r" record defintion extension type + target[position++] = (recordId & 0x1f) + 0x60; + target[position++] = highByte; + } else { + target[position++] = 0xd4; // fixext 1 + target[position++] = 0x72; // "r" record defintion extension type + target[position++] = recordId; + } + + if (newTransitions) + transitionsCount += serializationsSinceTransitionRebuild * newTransitions; + // record the removal of the id, we can maintain our shared structure + if (recordIdsToRemove.length >= maxOwnStructures) + recordIdsToRemove.shift()[RECORD_SYMBOL] = 0; // we are cycling back through, and have to remove old ones + recordIdsToRemove.push(transition); + pack(keys); + } + }; + const insertNewRecord = (transition, keys, insertionOffset, newTransitions) => { + let mainTarget = target; + let mainPosition = position; + let mainSafeEnd = safeEnd; + let mainStart = start; + target = keysTarget; + position = 0; + start = 0; + if (!target) + keysTarget = target = new ByteArrayAllocate(8192); + safeEnd = target.length - 10; + newRecord(transition, keys, newTransitions); + keysTarget = target; + let keysPosition = position; + target = mainTarget; + position = mainPosition; + safeEnd = mainSafeEnd; + start = mainStart; + if (keysPosition > 1) { + let newEnd = position + keysPosition - 1; + if (newEnd > safeEnd) + makeRoom(newEnd); + let insertionPosition = insertionOffset + start; + target.copyWithin(insertionPosition + keysPosition, insertionPosition + 1, position); + target.set(keysTarget.slice(0, keysPosition), insertionPosition); + position = newEnd; + } else { + target[insertionOffset + start] = keysTarget[0]; + } + }; + const writeStruct = (object, safePrototype) => { + let newPosition = writeStructSlots(object, target, start, position, structures, makeRoom, (value, newPosition, notifySharedUpdate) => { + if (notifySharedUpdate) + return hasSharedUpdate = true; + position = newPosition; + let startTarget = target; + pack(value); + resetStructures(); + if (startTarget !== target) { + return { position, targetView, target }; // indicate the buffer was re-allocated + } + return position; + }, this); + if (newPosition === 0) // bail and go to a msgpack object + return writeObject(object, true); + position = newPosition; + }; + } + useBuffer(buffer) { + // this means we are finished using our own buffer and we can write over it safely + target = buffer; + targetView = new DataView(target.buffer, target.byteOffset, target.byteLength); + position = 0; + } + clearSharedData() { + if (this.structures) + this.structures = []; + if (this.typedStructs) + this.typedStructs = []; + } +} + +extensionClasses = [ Date, Set, Error, RegExp, ArrayBuffer, Object.getPrototypeOf(Uint8Array.prototype).constructor /*TypedArray*/, C1Type ]; +extensions = [{ + pack(date, allocateForWrite, pack) { + let seconds = date.getTime() / 1000; + if ((this.useTimestamp32 || date.getMilliseconds() === 0) && seconds >= 0 && seconds < 0x100000000) { + // Timestamp 32 + let { target, targetView, position} = allocateForWrite(6); + target[position++] = 0xd6; + target[position++] = 0xff; + targetView.setUint32(position, seconds); + } else if (seconds > 0 && seconds < 0x100000000) { + // Timestamp 64 + let { target, targetView, position} = allocateForWrite(10); + target[position++] = 0xd7; + target[position++] = 0xff; + targetView.setUint32(position, date.getMilliseconds() * 4000000 + ((seconds / 1000 / 0x100000000) >> 0)); + targetView.setUint32(position + 4, seconds); + } else if (isNaN(seconds)) { + if (this.onInvalidDate) { + allocateForWrite(0); + return pack(this.onInvalidDate()) + } + // Intentionally invalid timestamp + let { target, targetView, position} = allocateForWrite(3); + target[position++] = 0xd4; + target[position++] = 0xff; + target[position++] = 0xff; + } else { + // Timestamp 96 + let { target, targetView, position} = allocateForWrite(15); + target[position++] = 0xc7; + target[position++] = 12; + target[position++] = 0xff; + targetView.setUint32(position, date.getMilliseconds() * 1000000); + targetView.setBigInt64(position + 4, BigInt(Math.floor(seconds))); + } + } +}, { + pack(set, allocateForWrite, pack) { + if (this.setAsEmptyObject) { + allocateForWrite(0); + return pack({}) + } + let array = Array.from(set); + let { target, position} = allocateForWrite(this.moreTypes ? 3 : 0); + if (this.moreTypes) { + target[position++] = 0xd4; + target[position++] = 0x73; // 's' for Set + target[position++] = 0; + } + pack(array); + } +}, { + pack(error, allocateForWrite, pack) { + let { target, position} = allocateForWrite(this.moreTypes ? 3 : 0); + if (this.moreTypes) { + target[position++] = 0xd4; + target[position++] = 0x65; // 'e' for error + target[position++] = 0; + } + pack([ error.name, error.message ]); + } +}, { + pack(regex, allocateForWrite, pack) { + let { target, position} = allocateForWrite(this.moreTypes ? 3 : 0); + if (this.moreTypes) { + target[position++] = 0xd4; + target[position++] = 0x78; // 'x' for regeXp + target[position++] = 0; + } + pack([ regex.source, regex.flags ]); + } +}, { + pack(arrayBuffer, allocateForWrite) { + if (this.moreTypes) + writeExtBuffer(arrayBuffer, 0x10, allocateForWrite); + else + writeBuffer(hasNodeBuffer ? Buffer.from(arrayBuffer) : new Uint8Array(arrayBuffer), allocateForWrite); + } +}, { + pack(typedArray, allocateForWrite) { + let constructor = typedArray.constructor; + if (constructor !== ByteArray && this.moreTypes) + writeExtBuffer(typedArray, typedArrays.indexOf(constructor.name), allocateForWrite); + else + writeBuffer(typedArray, allocateForWrite); + } +}, { + pack(c1, allocateForWrite) { // specific 0xC1 object + let { target, position} = allocateForWrite(1); + target[position] = 0xc1; + } +}]; + +function writeExtBuffer(typedArray, type, allocateForWrite, encode) { + let length = typedArray.byteLength; + if (length + 1 < 0x100) { + var { target, position } = allocateForWrite(4 + length); + target[position++] = 0xc7; + target[position++] = length + 1; + } else if (length + 1 < 0x10000) { + var { target, position } = allocateForWrite(5 + length); + target[position++] = 0xc8; + target[position++] = (length + 1) >> 8; + target[position++] = (length + 1) & 0xff; + } else { + var { target, position, targetView } = allocateForWrite(7 + length); + target[position++] = 0xc9; + targetView.setUint32(position, length + 1); // plus one for the type byte + position += 4; + } + target[position++] = 0x74; // "t" for typed array + target[position++] = type; + target.set(new Uint8Array(typedArray.buffer, typedArray.byteOffset, typedArray.byteLength), position); +} +function writeBuffer(buffer, allocateForWrite) { + let length = buffer.byteLength; + var target, position; + if (length < 0x100) { + var { target, position } = allocateForWrite(length + 2); + target[position++] = 0xc4; + target[position++] = length; + } else if (length < 0x10000) { + var { target, position } = allocateForWrite(length + 3); + target[position++] = 0xc5; + target[position++] = length >> 8; + target[position++] = length & 0xff; + } else { + var { target, position, targetView } = allocateForWrite(length + 5); + target[position++] = 0xc6; + targetView.setUint32(position, length); + position += 4; + } + target.set(buffer, position); +} + +function writeExtensionData(result, target, position, type) { + let length = result.length; + switch (length) { + case 1: + target[position++] = 0xd4; + break + case 2: + target[position++] = 0xd5; + break + case 4: + target[position++] = 0xd6; + break + case 8: + target[position++] = 0xd7; + break + case 16: + target[position++] = 0xd8; + break + default: + if (length < 0x100) { + target[position++] = 0xc7; + target[position++] = length; + } else if (length < 0x10000) { + target[position++] = 0xc8; + target[position++] = length >> 8; + target[position++] = length & 0xff; + } else { + target[position++] = 0xc9; + target[position++] = length >> 24; + target[position++] = (length >> 16) & 0xff; + target[position++] = (length >> 8) & 0xff; + target[position++] = length & 0xff; + } + } + target[position++] = type; + target.set(result, position); + position += length; + return position +} + +function insertIds(serialized, idsToInsert) { + // insert the ids that need to be referenced for structured clones + let nextId; + let distanceToMove = idsToInsert.length * 6; + let lastEnd = serialized.length - distanceToMove; + while (nextId = idsToInsert.pop()) { + let offset = nextId.offset; + let id = nextId.id; + serialized.copyWithin(offset + distanceToMove, offset, lastEnd); + distanceToMove -= 6; + let position = offset + distanceToMove; + serialized[position++] = 0xd6; + serialized[position++] = 0x69; // 'i' + serialized[position++] = id >> 24; + serialized[position++] = (id >> 16) & 0xff; + serialized[position++] = (id >> 8) & 0xff; + serialized[position++] = id & 0xff; + lastEnd = offset; + } + return serialized +} + +function writeBundles(start, pack, incrementPosition) { + if (bundledStrings.length > 0) { + targetView.setUint32(bundledStrings.position + start, position + incrementPosition - bundledStrings.position - start); + bundledStrings.stringsPosition = position - start; + let writeStrings = bundledStrings; + bundledStrings = null; + pack(writeStrings[0]); + pack(writeStrings[1]); + } +} +function prepareStructures(structures, packr) { + structures.isCompatible = (existingStructures) => { + let compatible = !existingStructures || ((packr.lastNamedStructuresLength || 0) === existingStructures.length); + if (!compatible) // we want to merge these existing structures immediately since we already have it and we are in the right transaction + packr._mergeStructures(existingStructures); + return compatible; + }; + return structures +} + +let defaultPackr = new Packr({ useRecords: false }); +defaultPackr.pack; +defaultPackr.pack; +const REUSE_BUFFER_MODE = 512; +const RESET_BUFFER_MODE = 1024; +const RESERVE_START_SPACE = 2048; + +// DEFLATE is a complex format; to read this code, you should probably check the RFC first: +// https://tools.ietf.org/html/rfc1951 +// You may also wish to take a look at the guide I made about this program: +// https://gist.github.com/101arrowz/253f31eb5abc3d9275ab943003ffecad +// Some of the following code is similar to that of UZIP.js: +// https://github.com/photopea/UZIP.js +// However, the vast majority of the codebase has diverged from UZIP.js to increase performance and reduce bundle size. +// Sometimes 0 will appear where -1 would be more appropriate. This is because using a uint +// is better for memory in most engines (I *think*). + +// aliases for shorter compressed code (most minifers don't do this) +var u8 = Uint8Array, u16 = Uint16Array, i32 = Int32Array; +// fixed length extra bits +var fleb = new u8([0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 2, 2, 2, 2, 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5, 0, /* unused */ 0, 0, /* impossible */ 0]); +// fixed distance extra bits +var fdeb = new u8([0, 0, 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 5, 5, 6, 6, 7, 7, 8, 8, 9, 9, 10, 10, 11, 11, 12, 12, 13, 13, /* unused */ 0, 0]); +// code length index map +var clim = new u8([16, 17, 18, 0, 8, 7, 9, 6, 10, 5, 11, 4, 12, 3, 13, 2, 14, 1, 15]); +// get base, reverse index map from extra bits +var freb = function (eb, start) { + var b = new u16(31); + for (var i = 0; i < 31; ++i) { + b[i] = start += 1 << eb[i - 1]; + } + // numbers here are at max 18 bits + var r = new i32(b[30]); + for (var i = 1; i < 30; ++i) { + for (var j = b[i]; j < b[i + 1]; ++j) { + r[j] = ((j - b[i]) << 5) | i; + } + } + return { b: b, r: r }; +}; +var _a = freb(fleb, 2), fl = _a.b, revfl = _a.r; +// we can ignore the fact that the other numbers are wrong; they never happen anyway +fl[28] = 258, revfl[258] = 28; +var _b = freb(fdeb, 0), fd = _b.b; +// map of value to reverse (assuming 16 bits) +var rev = new u16(32768); +for (var i = 0; i < 32768; ++i) { + // reverse table algorithm from SO + var x = ((i & 0xAAAA) >> 1) | ((i & 0x5555) << 1); + x = ((x & 0xCCCC) >> 2) | ((x & 0x3333) << 2); + x = ((x & 0xF0F0) >> 4) | ((x & 0x0F0F) << 4); + rev[i] = (((x & 0xFF00) >> 8) | ((x & 0x00FF) << 8)) >> 1; +} +// create huffman tree from u8 "map": index -> code length for code index +// mb (max bits) must be at most 15 +// TODO: optimize/split up? +var hMap = (function (cd, mb, r) { + var s = cd.length; + // index + var i = 0; + // u16 "map": index -> # of codes with bit length = index + var l = new u16(mb); + // length of cd must be 288 (total # of codes) + for (; i < s; ++i) { + if (cd[i]) + ++l[cd[i] - 1]; + } + // u16 "map": index -> minimum code for bit length = index + var le = new u16(mb); + for (i = 1; i < mb; ++i) { + le[i] = (le[i - 1] + l[i - 1]) << 1; + } + var co; + if (r) { + // u16 "map": index -> number of actual bits, symbol for code + co = new u16(1 << mb); + // bits to remove for reverser + var rvb = 15 - mb; + for (i = 0; i < s; ++i) { + // ignore 0 lengths + if (cd[i]) { + // num encoding both symbol and bits read + var sv = (i << 4) | cd[i]; + // free bits + var r_1 = mb - cd[i]; + // start value + var v = le[cd[i] - 1]++ << r_1; + // m is end value + for (var m = v | ((1 << r_1) - 1); v <= m; ++v) { + // every 16 bit value starting with the code yields the same result + co[rev[v] >> rvb] = sv; + } + } + } + } + else { + co = new u16(s); + for (i = 0; i < s; ++i) { + if (cd[i]) { + co[i] = rev[le[cd[i] - 1]++] >> (15 - cd[i]); + } + } + } + return co; +}); +// fixed length tree +var flt = new u8(288); +for (var i = 0; i < 144; ++i) + flt[i] = 8; +for (var i = 144; i < 256; ++i) + flt[i] = 9; +for (var i = 256; i < 280; ++i) + flt[i] = 7; +for (var i = 280; i < 288; ++i) + flt[i] = 8; +// fixed distance tree +var fdt = new u8(32); +for (var i = 0; i < 32; ++i) + fdt[i] = 5; +// fixed length map +var flrm = /*#__PURE__*/ hMap(flt, 9, 1); +// fixed distance map +var fdrm = /*#__PURE__*/ hMap(fdt, 5, 1); +// find max of array +var max = function (a) { + var m = a[0]; + for (var i = 1; i < a.length; ++i) { + if (a[i] > m) + m = a[i]; + } + return m; +}; +// read d, starting at bit p and mask with m +var bits = function (d, p, m) { + var o = (p / 8) | 0; + return ((d[o] | (d[o + 1] << 8)) >> (p & 7)) & m; +}; +// read d, starting at bit p continuing for at least 16 bits +var bits16 = function (d, p) { + var o = (p / 8) | 0; + return ((d[o] | (d[o + 1] << 8) | (d[o + 2] << 16)) >> (p & 7)); +}; +// get end of byte +var shft = function (p) { return ((p + 7) / 8) | 0; }; +// typed array slice - allows garbage collector to free original reference, +// while being more compatible than .slice +var slc = function (v, s, e) { + if (e == null || e > v.length) + e = v.length; + // can't use .constructor in case user-supplied + return new u8(v.subarray(s, e)); +}; +// error codes +var ec = [ + 'unexpected EOF', + 'invalid block type', + 'invalid length/literal', + 'invalid distance', + 'stream finished', + 'no stream handler', + , + 'no callback', + 'invalid UTF-8 data', + 'extra field too long', + 'date not in range 1980-2099', + 'filename too long', + 'stream finishing', + 'invalid zip data' + // determined by unknown compression method +]; +var err = function (ind, msg, nt) { + var e = new Error(msg || ec[ind]); + e.code = ind; + if (Error.captureStackTrace) + Error.captureStackTrace(e, err); + if (!nt) + throw e; + return e; +}; +// expands raw DEFLATE data +var inflt = function (dat, st, buf, dict) { + // source length dict length + var sl = dat.length, dl = dict ? dict.length : 0; + if (!sl || st.f && !st.l) + return buf || new u8(0); + var noBuf = !buf; + // have to estimate size + var resize = noBuf || st.i != 2; + // no state + var noSt = st.i; + // Assumes roughly 33% compression ratio average + if (noBuf) + buf = new u8(sl * 3); + // ensure buffer can fit at least l elements + var cbuf = function (l) { + var bl = buf.length; + // need to increase size to fit + if (l > bl) { + // Double or set to necessary, whichever is greater + var nbuf = new u8(Math.max(bl * 2, l)); + nbuf.set(buf); + buf = nbuf; + } + }; + // last chunk bitpos bytes + var final = st.f || 0, pos = st.p || 0, bt = st.b || 0, lm = st.l, dm = st.d, lbt = st.m, dbt = st.n; + // total bits + var tbts = sl * 8; + do { + if (!lm) { + // BFINAL - this is only 1 when last chunk is next + final = bits(dat, pos, 1); + // type: 0 = no compression, 1 = fixed huffman, 2 = dynamic huffman + var type = bits(dat, pos + 1, 3); + pos += 3; + if (!type) { + // go to end of byte boundary + var s = shft(pos) + 4, l = dat[s - 4] | (dat[s - 3] << 8), t = s + l; + if (t > sl) { + if (noSt) + err(0); + break; + } + // ensure size + if (resize) + cbuf(bt + l); + // Copy over uncompressed data + buf.set(dat.subarray(s, t), bt); + // Get new bitpos, update byte count + st.b = bt += l, st.p = pos = t * 8, st.f = final; + continue; + } + else if (type == 1) + lm = flrm, dm = fdrm, lbt = 9, dbt = 5; + else if (type == 2) { + // literal lengths + var hLit = bits(dat, pos, 31) + 257, hcLen = bits(dat, pos + 10, 15) + 4; + var tl = hLit + bits(dat, pos + 5, 31) + 1; + pos += 14; + // length+distance tree + var ldt = new u8(tl); + // code length tree + var clt = new u8(19); + for (var i = 0; i < hcLen; ++i) { + // use index map to get real code + clt[clim[i]] = bits(dat, pos + i * 3, 7); + } + pos += hcLen * 3; + // code lengths bits + var clb = max(clt), clbmsk = (1 << clb) - 1; + // code lengths map + var clm = hMap(clt, clb, 1); + for (var i = 0; i < tl;) { + var r = clm[bits(dat, pos, clbmsk)]; + // bits read + pos += r & 15; + // symbol + var s = r >> 4; + // code length to copy + if (s < 16) { + ldt[i++] = s; + } + else { + // copy count + var c = 0, n = 0; + if (s == 16) + n = 3 + bits(dat, pos, 3), pos += 2, c = ldt[i - 1]; + else if (s == 17) + n = 3 + bits(dat, pos, 7), pos += 3; + else if (s == 18) + n = 11 + bits(dat, pos, 127), pos += 7; + while (n--) + ldt[i++] = c; + } + } + // length tree distance tree + var lt = ldt.subarray(0, hLit), dt = ldt.subarray(hLit); + // max length bits + lbt = max(lt); + // max dist bits + dbt = max(dt); + lm = hMap(lt, lbt, 1); + dm = hMap(dt, dbt, 1); + } + else + err(1); + if (pos > tbts) { + if (noSt) + err(0); + break; + } + } + // Make sure the buffer can hold this + the largest possible addition + // Maximum chunk size (practically, theoretically infinite) is 2^17 + if (resize) + cbuf(bt + 131072); + var lms = (1 << lbt) - 1, dms = (1 << dbt) - 1; + var lpos = pos; + for (;; lpos = pos) { + // bits read, code + var c = lm[bits16(dat, pos) & lms], sym = c >> 4; + pos += c & 15; + if (pos > tbts) { + if (noSt) + err(0); + break; + } + if (!c) + err(2); + if (sym < 256) + buf[bt++] = sym; + else if (sym == 256) { + lpos = pos, lm = null; + break; + } + else { + var add = sym - 254; + // no extra bits needed if less + if (sym > 264) { + // index + var i = sym - 257, b = fleb[i]; + add = bits(dat, pos, (1 << b) - 1) + fl[i]; + pos += b; + } + // dist + var d = dm[bits16(dat, pos) & dms], dsym = d >> 4; + if (!d) + err(3); + pos += d & 15; + var dt = fd[dsym]; + if (dsym > 3) { + var b = fdeb[dsym]; + dt += bits16(dat, pos) & (1 << b) - 1, pos += b; + } + if (pos > tbts) { + if (noSt) + err(0); + break; + } + if (resize) + cbuf(bt + 131072); + var end = bt + add; + if (bt < dt) { + var shift = dl - dt, dend = Math.min(dt, end); + if (shift + bt < 0) + err(3); + for (; bt < dend; ++bt) + buf[bt] = dict[shift + bt]; + } + for (; bt < end; ++bt) + buf[bt] = buf[bt - dt]; + } + } + st.l = lm, st.p = lpos, st.b = bt, st.f = final; + if (lm) + final = 1, st.m = lbt, st.d = dm, st.n = dbt; + } while (!final); + // don't reallocate for streams or user buffers + return bt != buf.length && noBuf ? slc(buf, 0, bt) : buf.subarray(0, bt); +}; +// empty +var et = /*#__PURE__*/ new u8(0); +/** + * Expands DEFLATE data with no wrapper + * @param data The data to decompress + * @param opts The decompression options + * @returns The decompressed version of the data + */ +function inflateSync(data, opts) { + return inflt(data, { i: 2 }, opts && opts.out, opts && opts.dictionary); +} +// text decoder +var td = typeof TextDecoder != 'undefined' && /*#__PURE__*/ new TextDecoder(); +// text decoder stream +var tds = 0; +try { + td.decode(et, { stream: true }); + tds = 1; +} +catch (e) { } + +/** + * base64.ts + * + * Licensed under the BSD 3-Clause License. + * http://opensource.org/licenses/BSD-3-Clause + * + * References: + * http://en.wikipedia.org/wiki/Base64 + * + * @author Dan Kogai (https://github.com/dankogai) + */ +const _hasBuffer = typeof Buffer === 'function'; +typeof TextDecoder === 'function' ? new TextDecoder() : undefined; +typeof TextEncoder === 'function' ? new TextEncoder() : undefined; +const b64ch = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/='; +const b64chs = Array.prototype.slice.call(b64ch); +const b64tab = ((a) => { + let tab = {}; + a.forEach((c, i) => tab[c] = i); + return tab; +})(b64chs); +const b64re = /^(?:[A-Za-z\d+\/]{4})*?(?:[A-Za-z\d+\/]{2}(?:==)?|[A-Za-z\d+\/]{3}=?)?$/; +const _fromCC = String.fromCharCode.bind(String); +const _U8Afrom = typeof Uint8Array.from === 'function' + ? Uint8Array.from.bind(Uint8Array) + : (it) => new Uint8Array(Array.prototype.slice.call(it, 0)); +const _tidyB64 = (s) => s.replace(/[^A-Za-z0-9\+\/]/g, ''); +/** + * polyfill version of `atob` + */ +const atobPolyfill = (asc) => { + // console.log('polyfilled'); + asc = asc.replace(/\s+/g, ''); + if (!b64re.test(asc)) + throw new TypeError('malformed base64.'); + asc += '=='.slice(2 - (asc.length & 3)); + let u24, bin = '', r1, r2; + for (let i = 0; i < asc.length;) { + u24 = b64tab[asc.charAt(i++)] << 18 + | b64tab[asc.charAt(i++)] << 12 + | (r1 = b64tab[asc.charAt(i++)]) << 6 + | (r2 = b64tab[asc.charAt(i++)]); + bin += r1 === 64 ? _fromCC(u24 >> 16 & 255) + : r2 === 64 ? _fromCC(u24 >> 16 & 255, u24 >> 8 & 255) + : _fromCC(u24 >> 16 & 255, u24 >> 8 & 255, u24 & 255); + } + return bin; +}; +/** + * does what `window.atob` of web browsers do. + * @param {String} asc Base64-encoded string + * @returns {string} binary string + */ +const _atob = typeof atob === 'function' ? (asc) => atob(_tidyB64(asc)) + : _hasBuffer ? (asc) => Buffer.from(asc, 'base64').toString('binary') + : atobPolyfill; +// +const _toUint8Array = _hasBuffer + ? (a) => _U8Afrom(Buffer.from(a, 'base64')) + : (a) => _U8Afrom(_atob(a).split('').map(c => c.charCodeAt(0))); +/** + * converts a Base64 string to a Uint8Array. + */ +const toUint8Array = (a) => _toUint8Array(_unURI(a)); +const _unURI = (a) => _tidyB64(a.replace(/[-_]/g, (m0) => m0 == '-' ? '+' : '/')); + +/** + * Inflates given data then unpacks with MessagePack. This function is the inverse of `packAndDeflate`. + * + * @param {Uint8Array} data - Any data. + * + * @param {object} [opts] - Optional parameters. + * + * @param {import('#runtime/data/compress').InflateOptions} [opts.inflateOptions] - Inflate options. + * + * @returns {any} Inflated and unpacked data. + */ +function inflateAndUnpack(data, { inflateOptions } = {}) +{ + return unpack(inflateSync(data, inflateOptions)); +} + +/** + * Converts Base64 string to Uint8Array / inflates then unpacks with MessagePack. This function is the inverse of + * `packAndDeflateB64`. + * + * @param {string} data - Any Base64 data that has been compressed with + * + * @param {object} [opts] - Optional parameters. + * + * @param {import('#runtime/data/compress').InflateOptions} [opts.inflateOptions] - Inflate options. + * + * @returns {any} Inflated and unpacked data. + */ +function inflateAndUnpackB64(data, { inflateOptions } = {}) +{ + return unpack(inflateSync(toUint8Array(data), inflateOptions)); +} + +/** @returns {void} */ +function noop() {} + +const identity = (x) => x; + +/** + * @template T + * @template S + * @param {T} tar + * @param {S} src + * @returns {T & S} + */ +function assign(tar, src) { + // @ts-ignore + for (const k in src) tar[k] = src[k]; + return /** @type {T & S} */ (tar); +} + +function run(fn) { + return fn(); +} + +function blank_object() { + return Object.create(null); +} + +/** + * @param {Function[]} fns + * @returns {void} + */ +function run_all(fns) { + fns.forEach(run); +} + +/** + * @param {any} thing + * @returns {thing is Function} + */ +function is_function(thing) { + return typeof thing === 'function'; +} + +/** @returns {boolean} */ +function safe_not_equal(a, b) { + return a != a ? b == b : a !== b || (a && typeof a === 'object') || typeof a === 'function'; +} + +let src_url_equal_anchor; + +/** + * @param {string} element_src + * @param {string} url + * @returns {boolean} + */ +function src_url_equal(element_src, url) { + if (element_src === url) return true; + if (!src_url_equal_anchor) { + src_url_equal_anchor = document.createElement('a'); + } + // This is actually faster than doing URL(..).href + src_url_equal_anchor.href = url; + return element_src === src_url_equal_anchor.href; +} + +/** @returns {boolean} */ +function is_empty(obj) { + return Object.keys(obj).length === 0; +} + +function subscribe(store, ...callbacks) { + if (store == null) { + for (const callback of callbacks) { + callback(undefined); + } + return noop; + } + const unsub = store.subscribe(...callbacks); + return unsub.unsubscribe ? () => unsub.unsubscribe() : unsub; +} + +/** + * Get the current value from a store by subscribing and immediately unsubscribing. + * + * https://svelte.dev/docs/svelte-store#get + * @template T + * @param {import('../store/public.js').Readable} store + * @returns {T} + */ +function get_store_value(store) { + let value; + subscribe(store, (_) => (value = _))(); + return value; +} + +/** @returns {void} */ +function component_subscribe(component, store, callback) { + component.$$.on_destroy.push(subscribe(store, callback)); +} + +function create_slot(definition, ctx, $$scope, fn) { + if (definition) { + const slot_ctx = get_slot_context(definition, ctx, $$scope, fn); + return definition[0](slot_ctx); + } +} + +function get_slot_context(definition, ctx, $$scope, fn) { + return definition[1] && fn ? assign($$scope.ctx.slice(), definition[1](fn(ctx))) : $$scope.ctx; +} + +function get_slot_changes(definition, $$scope, dirty, fn) { + if (definition[2] && fn) { + const lets = definition[2](fn(dirty)); + if ($$scope.dirty === undefined) { + return lets; + } + if (typeof lets === 'object') { + const merged = []; + const len = Math.max($$scope.dirty.length, lets.length); + for (let i = 0; i < len; i += 1) { + merged[i] = $$scope.dirty[i] | lets[i]; + } + return merged; + } + return $$scope.dirty | lets; + } + return $$scope.dirty; +} + +/** @returns {void} */ +function update_slot_base( + slot, + slot_definition, + ctx, + $$scope, + slot_changes, + get_slot_context_fn +) { + if (slot_changes) { + const slot_context = get_slot_context(slot_definition, ctx, $$scope, get_slot_context_fn); + slot.p(slot_context, slot_changes); + } +} + +/** @returns {any[] | -1} */ +function get_all_dirty_from_scope($$scope) { + if ($$scope.ctx.length > 32) { + const dirty = []; + const length = $$scope.ctx.length / 32; + for (let i = 0; i < length; i++) { + dirty[i] = -1; + } + return dirty; + } + return -1; +} + +function null_to_empty(value) { + return value == null ? '' : value; +} + +function set_store_value(store, ret, value) { + store.set(value); + return ret; +} + +function action_destroyer(action_result) { + return action_result && is_function(action_result.destroy) ? action_result.destroy : noop; +} + +const is_client = typeof window !== 'undefined'; + +/** @type {() => number} */ +let now = is_client ? () => window.performance.now() : () => Date.now(); + +let raf = is_client ? (cb) => requestAnimationFrame(cb) : noop; + +const tasks = new Set(); + +/** + * @param {number} now + * @returns {void} + */ +function run_tasks(now) { + tasks.forEach((task) => { + if (!task.c(now)) { + tasks.delete(task); + task.f(); + } + }); + if (tasks.size !== 0) raf(run_tasks); +} + +/** + * Creates a new task that runs on each raf frame + * until it returns a falsy value or is aborted + * @param {import('./private.js').TaskCallback} callback + * @returns {import('./private.js').Task} + */ +function loop(callback) { + /** @type {import('./private.js').TaskEntry} */ + let task; + if (tasks.size === 0) raf(run_tasks); + return { + promise: new Promise((fulfill) => { + tasks.add((task = { c: callback, f: fulfill })); + }), + abort() { + tasks.delete(task); + } + }; +} + +/** @type {typeof globalThis} */ +const globals = + typeof window !== 'undefined' + ? window + : typeof globalThis !== 'undefined' + ? globalThis + : // @ts-ignore Node typings have this + global; + +/** + * @param {Node} target + * @param {Node} node + * @returns {void} + */ +function append(target, node) { + target.appendChild(node); +} + +/** + * @param {Node} node + * @returns {ShadowRoot | Document} + */ +function get_root_for_style(node) { + if (!node) return document; + const root = node.getRootNode ? node.getRootNode() : node.ownerDocument; + if (root && /** @type {ShadowRoot} */ (root).host) { + return /** @type {ShadowRoot} */ (root); + } + return node.ownerDocument; +} + +/** + * @param {Node} node + * @returns {CSSStyleSheet} + */ +function append_empty_stylesheet(node) { + const style_element = element('style'); + // For transitions to work without 'style-src: unsafe-inline' Content Security Policy, + // these empty tags need to be allowed with a hash as a workaround until we move to the Web Animations API. + // Using the hash for the empty string (for an empty tag) works in all browsers except Safari. + // So as a workaround for the workaround, when we append empty style tags we set their content to /* empty */. + // The hash 'sha256-9OlNO0DNEeaVzHL4RZwCLsBHA8WBQ8toBp/4F5XV2nc=' will then work even in Safari. + style_element.textContent = '/* empty */'; + append_stylesheet(get_root_for_style(node), style_element); + return style_element.sheet; +} + +/** + * @param {ShadowRoot | Document} node + * @param {HTMLStyleElement} style + * @returns {CSSStyleSheet} + */ +function append_stylesheet(node, style) { + append(/** @type {Document} */ (node).head || node, style); + return style.sheet; +} + +/** + * @param {Node} target + * @param {Node} node + * @param {Node} [anchor] + * @returns {void} + */ +function insert(target, node, anchor) { + target.insertBefore(node, anchor || null); +} + +/** + * @param {Node} node + * @returns {void} + */ +function detach(node) { + if (node.parentNode) { + node.parentNode.removeChild(node); + } +} + +/** + * @template {keyof HTMLElementTagNameMap} K + * @param {K} name + * @returns {HTMLElementTagNameMap[K]} + */ +function element(name) { + return document.createElement(name); +} + +/** + * @template {keyof SVGElementTagNameMap} K + * @param {K} name + * @returns {SVGElement} + */ +function svg_element(name) { + return document.createElementNS('http://www.w3.org/2000/svg', name); +} + +/** + * @param {string} data + * @returns {Text} + */ +function text(data) { + return document.createTextNode(data); +} + +/** + * @returns {Text} */ +function space() { + return text(' '); +} + +/** + * @returns {Text} */ +function empty() { + return text(''); +} + +/** + * @param {EventTarget} node + * @param {string} event + * @param {EventListenerOrEventListenerObject} handler + * @param {boolean | AddEventListenerOptions | EventListenerOptions} [options] + * @returns {() => void} + */ +function listen(node, event, handler, options) { + node.addEventListener(event, handler, options); + return () => node.removeEventListener(event, handler, options); +} + +/** + * @returns {(event: any) => any} */ +function prevent_default(fn) { + return function (event) { + event.preventDefault(); + // @ts-ignore + return fn.call(this, event); + }; +} + +/** + * @returns {(event: any) => any} */ +function stop_propagation(fn) { + return function (event) { + event.stopPropagation(); + // @ts-ignore + return fn.call(this, event); + }; +} + +/** + * @param {Element} node + * @param {string} attribute + * @param {string} [value] + * @returns {void} + */ +function attr(node, attribute, value) { + if (value == null) node.removeAttribute(attribute); + else if (node.getAttribute(attribute) !== value) node.setAttribute(attribute, value); +} + +/** + * @param {Element} element + * @returns {ChildNode[]} + */ +function children(element) { + return Array.from(element.childNodes); +} + +/** + * @param {Text} text + * @param {unknown} data + * @returns {void} + */ +function set_data(text, data) { + data = '' + data; + if (text.data === data) return; + text.data = /** @type {string} */ (data); +} + +/** + * @returns {void} */ +function set_input_value(input, value) { + input.value = value == null ? '' : value; +} + +/** + * @returns {void} */ +function set_style(node, key, value, important) { + if (value == null) { + node.style.removeProperty(key); + } else { + node.style.setProperty(key, value, ''); + } +} + +/** + * @returns {void} */ +function toggle_class(element, name, toggle) { + // The `!!` is required because an `undefined` flag means flipping the current state. + element.classList.toggle(name, !!toggle); +} + +/** + * @template T + * @param {string} type + * @param {T} [detail] + * @param {{ bubbles?: boolean, cancelable?: boolean }} [options] + * @returns {CustomEvent} + */ +function custom_event(type, detail, { bubbles = false, cancelable = false } = {}) { + return new CustomEvent(type, { detail, bubbles, cancelable }); +} + +function construct_svelte_component(component, props) { + return new component(props); +} + +/** + * @typedef {Node & { + * claim_order?: number; + * hydrate_init?: true; + * actual_end_child?: NodeEx; + * childNodes: NodeListOf; + * }} NodeEx + */ + +/** @typedef {ChildNode & NodeEx} ChildNodeEx */ + +/** @typedef {NodeEx & { claim_order: number }} NodeEx2 */ + +/** + * @typedef {ChildNodeEx[] & { + * claim_info?: { + * last_index: number; + * total_claimed: number; + * }; + * }} ChildNodeArray + */ + +// we need to store the information for multiple documents because a Svelte application could also contain iframes +// https://github.com/sveltejs/svelte/issues/3624 +/** @type {Map} */ +const managed_styles = new Map(); + +let active = 0; + +// https://github.com/darkskyapp/string-hash/blob/master/index.js +/** + * @param {string} str + * @returns {number} + */ +function hash(str) { + let hash = 5381; + let i = str.length; + while (i--) hash = ((hash << 5) - hash) ^ str.charCodeAt(i); + return hash >>> 0; +} + +/** + * @param {Document | ShadowRoot} doc + * @param {Element & ElementCSSInlineStyle} node + * @returns {{ stylesheet: any; rules: {}; }} + */ +function create_style_information(doc, node) { + const info = { stylesheet: append_empty_stylesheet(node), rules: {} }; + managed_styles.set(doc, info); + return info; +} + +/** + * @param {Element & ElementCSSInlineStyle} node + * @param {number} a + * @param {number} b + * @param {number} duration + * @param {number} delay + * @param {(t: number) => number} ease + * @param {(t: number, u: number) => string} fn + * @param {number} uid + * @returns {string} + */ +function create_rule(node, a, b, duration, delay, ease, fn, uid = 0) { + const step = 16.666 / duration; + let keyframes = '{\n'; + for (let p = 0; p <= 1; p += step) { + const t = a + (b - a) * ease(p); + keyframes += p * 100 + `%{${fn(t, 1 - t)}}\n`; + } + const rule = keyframes + `100% {${fn(b, 1 - b)}}\n}`; + const name = `__svelte_${hash(rule)}_${uid}`; + const doc = get_root_for_style(node); + const { stylesheet, rules } = managed_styles.get(doc) || create_style_information(doc, node); + if (!rules[name]) { + rules[name] = true; + stylesheet.insertRule(`@keyframes ${name} ${rule}`, stylesheet.cssRules.length); + } + const animation = node.style.animation || ''; + node.style.animation = `${ + animation ? `${animation}, ` : '' + }${name} ${duration}ms linear ${delay}ms 1 both`; + active += 1; + return name; +} + +/** + * @param {Element & ElementCSSInlineStyle} node + * @param {string} [name] + * @returns {void} + */ +function delete_rule(node, name) { + const previous = (node.style.animation || '').split(', '); + const next = previous.filter( + name + ? (anim) => anim.indexOf(name) < 0 // remove specific animation + : (anim) => anim.indexOf('__svelte') === -1 // remove all Svelte animations + ); + const deleted = previous.length - next.length; + if (deleted) { + node.style.animation = next.join(', '); + active -= deleted; + if (!active) clear_rules(); + } +} + +/** @returns {void} */ +function clear_rules() { + raf(() => { + if (active) return; + managed_styles.forEach((info) => { + const { ownerNode } = info.stylesheet; + // there is no ownerNode if it runs on jsdom. + if (ownerNode) detach(ownerNode); + }); + managed_styles.clear(); + }); +} + +let current_component; + +/** @returns {void} */ +function set_current_component(component) { + current_component = component; +} + +function get_current_component() { + if (!current_component) throw new Error('Function called outside component initialization'); + return current_component; +} + +/** + * The `onMount` function schedules a callback to run as soon as the component has been mounted to the DOM. + * It must be called during the component's initialisation (but doesn't need to live *inside* the component; + * it can be called from an external module). + * + * If a function is returned _synchronously_ from `onMount`, it will be called when the component is unmounted. + * + * `onMount` does not run inside a [server-side component](https://svelte.dev/docs#run-time-server-side-component-api). + * + * https://svelte.dev/docs/svelte#onmount + * @template T + * @param {() => import('./private.js').NotFunction | Promise> | (() => any)} fn + * @returns {void} + */ +function onMount(fn) { + get_current_component().$$.on_mount.push(fn); +} + +/** + * Schedules a callback to run immediately before the component is unmounted. + * + * Out of `onMount`, `beforeUpdate`, `afterUpdate` and `onDestroy`, this is the + * only one that runs inside a server-side component. + * + * https://svelte.dev/docs/svelte#ondestroy + * @param {() => any} fn + * @returns {void} + */ +function onDestroy(fn) { + get_current_component().$$.on_destroy.push(fn); +} + +/** + * Associates an arbitrary `context` object with the current component and the specified `key` + * and returns that object. The context is then available to children of the component + * (including slotted content) with `getContext`. + * + * Like lifecycle functions, this must be called during component initialisation. + * + * https://svelte.dev/docs/svelte#setcontext + * @template T + * @param {any} key + * @param {T} context + * @returns {T} + */ +function setContext(key, context) { + get_current_component().$$.context.set(key, context); + return context; +} + +/** + * Retrieves the context that belongs to the closest parent component with the specified `key`. + * Must be called during component initialisation. + * + * https://svelte.dev/docs/svelte#getcontext + * @template T + * @param {any} key + * @returns {T} + */ +function getContext(key) { + return get_current_component().$$.context.get(key); +} + +// TODO figure out if we still want to support +// shorthand events, or if we want to implement +// a real bubbling mechanism +/** + * @param component + * @param event + * @returns {void} + */ +function bubble(component, event) { + const callbacks = component.$$.callbacks[event.type]; + if (callbacks) { + // @ts-ignore + callbacks.slice().forEach((fn) => fn.call(this, event)); + } +} + +const dirty_components = []; +const binding_callbacks = []; + +let render_callbacks = []; + +const flush_callbacks = []; + +const resolved_promise = /* @__PURE__ */ Promise.resolve(); + +let update_scheduled = false; + +/** @returns {void} */ +function schedule_update() { + if (!update_scheduled) { + update_scheduled = true; + resolved_promise.then(flush); + } +} + +/** @returns {Promise} */ +function tick() { + schedule_update(); + return resolved_promise; +} + +/** @returns {void} */ +function add_render_callback(fn) { + render_callbacks.push(fn); +} + +/** @returns {void} */ +function add_flush_callback(fn) { + flush_callbacks.push(fn); +} + +// flush() calls callbacks in this order: +// 1. All beforeUpdate callbacks, in order: parents before children +// 2. All bind:this callbacks, in reverse order: children before parents. +// 3. All afterUpdate callbacks, in order: parents before children. EXCEPT +// for afterUpdates called during the initial onMount, which are called in +// reverse order: children before parents. +// Since callbacks might update component values, which could trigger another +// call to flush(), the following steps guard against this: +// 1. During beforeUpdate, any updated components will be added to the +// dirty_components array and will cause a reentrant call to flush(). Because +// the flush index is kept outside the function, the reentrant call will pick +// up where the earlier call left off and go through all dirty components. The +// current_component value is saved and restored so that the reentrant call will +// not interfere with the "parent" flush() call. +// 2. bind:this callbacks cannot trigger new flush() calls. +// 3. During afterUpdate, any updated components will NOT have their afterUpdate +// callback called a second time; the seen_callbacks set, outside the flush() +// function, guarantees this behavior. +const seen_callbacks = new Set(); + +let flushidx = 0; // Do *not* move this inside the flush() function + +/** @returns {void} */ +function flush() { + // Do not reenter flush while dirty components are updated, as this can + // result in an infinite loop. Instead, let the inner flush handle it. + // Reentrancy is ok afterwards for bindings etc. + if (flushidx !== 0) { + return; + } + const saved_component = current_component; + do { + // first, call beforeUpdate functions + // and update components + try { + while (flushidx < dirty_components.length) { + const component = dirty_components[flushidx]; + flushidx++; + set_current_component(component); + update(component.$$); + } + } catch (e) { + // reset dirty state to not end up in a deadlocked state and then rethrow + dirty_components.length = 0; + flushidx = 0; + throw e; + } + set_current_component(null); + dirty_components.length = 0; + flushidx = 0; + while (binding_callbacks.length) binding_callbacks.pop()(); + // then, once components are updated, call + // afterUpdate functions. This may cause + // subsequent updates... + for (let i = 0; i < render_callbacks.length; i += 1) { + const callback = render_callbacks[i]; + if (!seen_callbacks.has(callback)) { + // ...so guard against infinite loops + seen_callbacks.add(callback); + callback(); + } + } + render_callbacks.length = 0; + } while (dirty_components.length); + while (flush_callbacks.length) { + flush_callbacks.pop()(); + } + update_scheduled = false; + seen_callbacks.clear(); + set_current_component(saved_component); +} + +/** @returns {void} */ +function update($$) { + if ($$.fragment !== null) { + $$.update(); + run_all($$.before_update); + const dirty = $$.dirty; + $$.dirty = [-1]; + $$.fragment && $$.fragment.p($$.ctx, dirty); + $$.after_update.forEach(add_render_callback); + } +} + +/** + * Useful for example to execute remaining `afterUpdate` callbacks before executing `destroy`. + * @param {Function[]} fns + * @returns {void} + */ +function flush_render_callbacks(fns) { + const filtered = []; + const targets = []; + render_callbacks.forEach((c) => (fns.indexOf(c) === -1 ? filtered.push(c) : targets.push(c))); + targets.forEach((c) => c()); + render_callbacks = filtered; +} + +/** + * @type {Promise | null} + */ +let promise; + +/** + * @returns {Promise} + */ +function wait() { + if (!promise) { + promise = Promise.resolve(); + promise.then(() => { + promise = null; + }); + } + return promise; +} + +/** + * @param {Element} node + * @param {INTRO | OUTRO | boolean} direction + * @param {'start' | 'end'} kind + * @returns {void} + */ +function dispatch(node, direction, kind) { + node.dispatchEvent(custom_event(`${direction ? 'intro' : 'outro'}${kind}`)); +} + +const outroing = new Set(); + +/** + * @type {Outro} + */ +let outros; + +/** + * @returns {void} */ +function group_outros() { + outros = { + r: 0, + c: [], + p: outros // parent group + }; +} + +/** + * @returns {void} */ +function check_outros() { + if (!outros.r) { + run_all(outros.c); + } + outros = outros.p; +} + +/** + * @param {import('./private.js').Fragment} block + * @param {0 | 1} [local] + * @returns {void} + */ +function transition_in(block, local) { + if (block && block.i) { + outroing.delete(block); + block.i(local); + } +} + +/** + * @param {import('./private.js').Fragment} block + * @param {0 | 1} local + * @param {0 | 1} [detach] + * @param {() => void} [callback] + * @returns {void} + */ +function transition_out(block, local, detach, callback) { + if (block && block.o) { + if (outroing.has(block)) return; + outroing.add(block); + outros.c.push(() => { + outroing.delete(block); + if (callback) { + if (detach) block.d(1); + callback(); + } + }); + block.o(local); + } else if (callback) { + callback(); + } +} + +/** + * @type {import('../transition/public.js').TransitionConfig} + */ +const null_transition = { duration: 0 }; + +/** + * @param {Element & ElementCSSInlineStyle} node + * @param {TransitionFn} fn + * @param {any} params + * @param {boolean} intro + * @returns {{ run(b: 0 | 1): void; end(): void; }} + */ +function create_bidirectional_transition(node, fn, params, intro) { + /** + * @type {TransitionOptions} */ + const options = { direction: 'both' }; + let config = fn(node, params, options); + let t = intro ? 0 : 1; + + /** + * @type {Program | null} */ + let running_program = null; + + /** + * @type {PendingProgram | null} */ + let pending_program = null; + let animation_name = null; + + /** @type {boolean} */ + let original_inert_value; + + /** + * @returns {void} */ + function clear_animation() { + if (animation_name) delete_rule(node, animation_name); + } + + /** + * @param {PendingProgram} program + * @param {number} duration + * @returns {Program} + */ + function init(program, duration) { + const d = /** @type {Program['d']} */ (program.b - t); + duration *= Math.abs(d); + return { + a: t, + b: program.b, + d, + duration, + start: program.start, + end: program.start + duration, + group: program.group + }; + } + + /** + * @param {INTRO | OUTRO} b + * @returns {void} + */ + function go(b) { + const { + delay = 0, + duration = 300, + easing = identity, + tick = noop, + css + } = config || null_transition; + + /** + * @type {PendingProgram} */ + const program = { + start: now() + delay, + b + }; + + if (!b) { + // @ts-ignore todo: improve typings + program.group = outros; + outros.r += 1; + } + + if ('inert' in node) { + if (b) { + if (original_inert_value !== undefined) { + // aborted/reversed outro — restore previous inert value + node.inert = original_inert_value; + } + } else { + original_inert_value = /** @type {HTMLElement} */ (node).inert; + node.inert = true; + } + } + + if (running_program || pending_program) { + pending_program = program; + } else { + // if this is an intro, and there's a delay, we need to do + // an initial tick and/or apply CSS animation immediately + if (css) { + clear_animation(); + animation_name = create_rule(node, t, b, duration, delay, easing, css); + } + if (b) tick(0, 1); + running_program = init(program, duration); + add_render_callback(() => dispatch(node, b, 'start')); + loop((now) => { + if (pending_program && now > pending_program.start) { + running_program = init(pending_program, duration); + pending_program = null; + dispatch(node, running_program.b, 'start'); + if (css) { + clear_animation(); + animation_name = create_rule( + node, + t, + running_program.b, + running_program.duration, + 0, + easing, + config.css + ); + } + } + if (running_program) { + if (now >= running_program.end) { + tick((t = running_program.b), 1 - t); + dispatch(node, running_program.b, 'end'); + if (!pending_program) { + // we're done + if (running_program.b) { + // intro — we can tidy up immediately + clear_animation(); + } else { + // outro — needs to be coordinated + if (!--running_program.group.r) run_all(running_program.group.c); + } + } + running_program = null; + } else if (now >= running_program.start) { + const p = now - running_program.start; + t = running_program.a + running_program.d * easing(p / running_program.duration); + tick(t, 1 - t); + } + } + return !!(running_program || pending_program); + }); + } + } + return { + run(b) { + if (is_function(config)) { + wait().then(() => { + const opts = { direction: b ? 'in' : 'out' }; + // @ts-ignore + config = config(opts); + go(b); + }); + } else { + go(b); + } + }, + end() { + clear_animation(); + running_program = pending_program = null; + } + }; +} + +/** @typedef {1} INTRO */ +/** @typedef {0} OUTRO */ +/** @typedef {{ direction: 'in' | 'out' | 'both' }} TransitionOptions */ +/** @typedef {(node: Element, params: any, options: TransitionOptions) => import('../transition/public.js').TransitionConfig} TransitionFn */ + +/** + * @typedef {Object} Outro + * @property {number} r + * @property {Function[]} c + * @property {Object} p + */ + +/** + * @typedef {Object} PendingProgram + * @property {number} start + * @property {INTRO|OUTRO} b + * @property {Outro} [group] + */ + +/** + * @typedef {Object} Program + * @property {number} a + * @property {INTRO|OUTRO} b + * @property {1|-1} d + * @property {number} duration + * @property {number} start + * @property {number} end + * @property {Outro} [group] + */ + +// general each functions: + +function ensure_array_like(array_like_or_iterator) { + return array_like_or_iterator?.length !== undefined + ? array_like_or_iterator + : Array.from(array_like_or_iterator); +} + +// keyed each functions: + +/** @returns {void} */ +function destroy_block(block, lookup) { + block.d(1); + lookup.delete(block.key); +} + +/** @returns {void} */ +function outro_and_destroy_block(block, lookup) { + transition_out(block, 1, 1, () => { + lookup.delete(block.key); + }); +} + +/** @returns {any[]} */ +function update_keyed_each( + old_blocks, + dirty, + get_key, + dynamic, + ctx, + list, + lookup, + node, + destroy, + create_each_block, + next, + get_context +) { + let o = old_blocks.length; + let n = list.length; + let i = o; + const old_indexes = {}; + while (i--) old_indexes[old_blocks[i].key] = i; + const new_blocks = []; + const new_lookup = new Map(); + const deltas = new Map(); + const updates = []; + i = n; + while (i--) { + const child_ctx = get_context(ctx, list, i); + const key = get_key(child_ctx); + let block = lookup.get(key); + if (!block) { + block = create_each_block(key, child_ctx); + block.c(); + } else { + // defer updates until all the DOM shuffling is done + updates.push(() => block.p(child_ctx, dirty)); + } + new_lookup.set(key, (new_blocks[i] = block)); + if (key in old_indexes) deltas.set(key, Math.abs(i - old_indexes[key])); + } + const will_move = new Set(); + const did_move = new Set(); + /** @returns {void} */ + function insert(block) { + transition_in(block, 1); + block.m(node, next); + lookup.set(block.key, block); + next = block.first; + n--; + } + while (o && n) { + const new_block = new_blocks[n - 1]; + const old_block = old_blocks[o - 1]; + const new_key = new_block.key; + const old_key = old_block.key; + if (new_block === old_block) { + // do nothing + next = new_block.first; + o--; + n--; + } else if (!new_lookup.has(old_key)) { + // remove old block + destroy(old_block, lookup); + o--; + } else if (!lookup.has(new_key) || will_move.has(new_key)) { + insert(new_block); + } else if (did_move.has(old_key)) { + o--; + } else if (deltas.get(new_key) > deltas.get(old_key)) { + did_move.add(new_key); + insert(new_block); + } else { + will_move.add(old_key); + o--; + } + } + while (o--) { + const old_block = old_blocks[o]; + if (!new_lookup.has(old_block.key)) destroy(old_block, lookup); + } + while (n) insert(new_blocks[n - 1]); + run_all(updates); + return new_blocks; +} + +/** @returns {{}} */ +function get_spread_update(levels, updates) { + const update = {}; + const to_null_out = {}; + const accounted_for = { $$scope: 1 }; + let i = levels.length; + while (i--) { + const o = levels[i]; + const n = updates[i]; + if (n) { + for (const key in o) { + if (!(key in n)) to_null_out[key] = 1; + } + for (const key in n) { + if (!accounted_for[key]) { + update[key] = n[key]; + accounted_for[key] = 1; + } + } + levels[i] = n; + } else { + for (const key in o) { + accounted_for[key] = 1; + } + } + } + for (const key in to_null_out) { + if (!(key in update)) update[key] = undefined; + } + return update; +} + +function get_spread_object(spread_props) { + return typeof spread_props === 'object' && spread_props !== null ? spread_props : {}; +} + +/** @returns {void} */ +function bind(component, name, callback) { + const index = component.$$.props[name]; + if (index !== undefined) { + component.$$.bound[index] = callback; + callback(component.$$.ctx[index]); + } +} + +/** @returns {void} */ +function create_component(block) { + block && block.c(); +} + +/** @returns {void} */ +function mount_component(component, target, anchor) { + const { fragment, after_update } = component.$$; + fragment && fragment.m(target, anchor); + // onMount happens before the initial afterUpdate + add_render_callback(() => { + const new_on_destroy = component.$$.on_mount.map(run).filter(is_function); + // if the component was destroyed immediately + // it will update the `$$.on_destroy` reference to `null`. + // the destructured on_destroy may still reference to the old array + if (component.$$.on_destroy) { + component.$$.on_destroy.push(...new_on_destroy); + } else { + // Edge case - component was destroyed immediately, + // most likely as a result of a binding initialising + run_all(new_on_destroy); + } + component.$$.on_mount = []; + }); + after_update.forEach(add_render_callback); +} + +/** @returns {void} */ +function destroy_component(component, detaching) { + const $$ = component.$$; + if ($$.fragment !== null) { + flush_render_callbacks($$.after_update); + run_all($$.on_destroy); + $$.fragment && $$.fragment.d(detaching); + // TODO null out other refs, including component.$$ (but need to + // preserve final state?) + $$.on_destroy = $$.fragment = null; + $$.ctx = []; + } +} + +/** @returns {void} */ +function make_dirty(component, i) { + if (component.$$.dirty[0] === -1) { + dirty_components.push(component); + schedule_update(); + component.$$.dirty.fill(0); + } + component.$$.dirty[(i / 31) | 0] |= 1 << i % 31; +} + +// TODO: Document the other params +/** + * @param {SvelteComponent} component + * @param {import('./public.js').ComponentConstructorOptions} options + * + * @param {import('./utils.js')['not_equal']} not_equal Used to compare props and state values. + * @param {(target: Element | ShadowRoot) => void} [append_styles] Function that appends styles to the DOM when the component is first initialised. + * This will be the `add_css` function from the compiled component. + * + * @returns {void} + */ +function init( + component, + options, + instance, + create_fragment, + not_equal, + props, + append_styles = null, + dirty = [-1] +) { + const parent_component = current_component; + set_current_component(component); + /** @type {import('./private.js').T$$} */ + const $$ = (component.$$ = { + fragment: null, + ctx: [], + // state + props, + update: noop, + not_equal, + bound: blank_object(), + // lifecycle + on_mount: [], + on_destroy: [], + on_disconnect: [], + before_update: [], + after_update: [], + context: new Map(options.context || (parent_component ? parent_component.$$.context : [])), + // everything else + callbacks: blank_object(), + dirty, + skip_bound: false, + root: options.target || parent_component.$$.root + }); + append_styles && append_styles($$.root); + let ready = false; + $$.ctx = instance + ? instance(component, options.props || {}, (i, ret, ...rest) => { + const value = rest.length ? rest[0] : ret; + if ($$.ctx && not_equal($$.ctx[i], ($$.ctx[i] = value))) { + if (!$$.skip_bound && $$.bound[i]) $$.bound[i](value); + if (ready) make_dirty(component, i); + } + return ret; + }) + : []; + $$.update(); + ready = true; + run_all($$.before_update); + // `false` as a special case of no DOM component + $$.fragment = create_fragment ? create_fragment($$.ctx) : false; + if (options.target) { + if (options.hydrate) { + // TODO: what is the correct type here? + // @ts-expect-error + const nodes = children(options.target); + $$.fragment && $$.fragment.l(nodes); + nodes.forEach(detach); + } else { + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + $$.fragment && $$.fragment.c(); + } + if (options.intro) transition_in(component.$$.fragment); + mount_component(component, options.target, options.anchor); + flush(); + } + set_current_component(parent_component); +} + +/** + * Base class for Svelte components. Used when dev=false. + * + * @template {Record} [Props=any] + * @template {Record} [Events=any] + */ +class SvelteComponent { + /** + * ### PRIVATE API + * + * Do not use, may change at any time + * + * @type {any} + */ + $$ = undefined; + /** + * ### PRIVATE API + * + * Do not use, may change at any time + * + * @type {any} + */ + $$set = undefined; + + /** @returns {void} */ + $destroy() { + destroy_component(this, 1); + this.$destroy = noop; + } + + /** + * @template {Extract} K + * @param {K} type + * @param {((e: Events[K]) => void) | null | undefined} callback + * @returns {() => void} + */ + $on(type, callback) { + if (!is_function(callback)) { + return noop; + } + const callbacks = this.$$.callbacks[type] || (this.$$.callbacks[type] = []); + callbacks.push(callback); + return () => { + const index = callbacks.indexOf(callback); + if (index !== -1) callbacks.splice(index, 1); + }; + } + + /** + * @param {Partial} props + * @returns {void} + */ + $set(props) { + if (this.$$set && !is_empty(props)) { + this.$$.skip_bound = true; + this.$$set(props); + this.$$.skip_bound = false; + } + } +} + +/** + * @typedef {Object} CustomElementPropDefinition + * @property {string} [attribute] + * @property {boolean} [reflect] + * @property {'String'|'Boolean'|'Number'|'Array'|'Object'} [type] + */ + +// generated during release, do not modify + +const PUBLIC_VERSION = '4'; + +/** + * Provides a basic test for a given variable to test if it has the shape of a readable store by having a `subscribe` + * function. + * + * Note: functions are also objects, so test that the variable might be a function w/ a `subscribe` function. + * + * @param {*} store - variable to test that might be a store. + * + * @returns {boolean} Whether the variable tested has the shape of a store. + */ + +/** + * Provides a basic test for a given variable to test if it has the shape of a writable store by having a `subscribe` + * function and an `update` function. + * + * Note: functions are also objects, so test that the variable might be a function w/ a `subscribe` function. + * + * @param {*} store - variable to test that might be a store. + * + * @returns {boolean} Whether the variable tested has the shape of a store. + */ +function isUpdatableStore(store) +{ + if (store === null || store === void 0) { return false; } + + switch (typeof store) + { + case 'function': + case 'object': + return typeof store.subscribe === 'function' && typeof store.update === 'function'; + } + + return false; +} + +/** + * Provides a basic test for a given variable to test if it has the shape of a writable store by having a `subscribe` + * `set`, and `update` functions. + * + * Note: functions are also objects, so test that the variable might be a function w/ `subscribe` & `set` functions. + * + * @param {*} store - variable to test that might be a store. + * + * @returns {boolean} Whether the variable tested has the shape of a store. + */ +function isWritableStore(store) +{ + if (store === null || store === void 0) { return false; } + + switch (typeof store) + { + case 'function': + case 'object': + return typeof store.subscribe === 'function' && typeof store.set === 'function'; + } + + return false; +} + +/** + * Subscribes to the given store with the update function provided and ignores the first automatic + * update. All future updates are dispatched to the update function. + * + * @param {import('svelte/store').Readable | import('svelte/store').Writable} store - + * Store to subscribe to... + * + * @param {import('svelte/store').Updater} update - function to receive future updates. + * + * @returns {import('svelte/store').Unsubscriber} Store unsubscribe function. + */ +function subscribeIgnoreFirst(store, update) +{ + let firedFirst = false; + + return store.subscribe((value) => + { + if (!firedFirst) + { + firedFirst = true; + } + else + { + update(value); + } + }); +} + +/** + * Subscribes to the given store with two update functions provided. The first function is invoked on the initial + * subscription. All future updates are dispatched to the update function. + * + * @param {import('svelte/store').Readable | import('svelte/store').Writable} store - + * Store to subscribe to... + * + * @param {import('svelte/store').Updater} first - Function to receive first update. + * + * @param {import('svelte/store').Updater} update - Function to receive future updates. + * + * @returns {import('svelte/store').Unsubscriber} Store unsubscribe function. + */ +function subscribeFirstRest(store, first, update) +{ + let firedFirst = false; + + return store.subscribe((value) => + { + if (!firedFirst) + { + firedFirst = true; + first(value); + } + else + { + update(value); + } + }); +} + +/** + * Provides various utilities for generating hash codes for strings and UUIDs. + * + * This class should not be constructed as it only contains static methods. + */ + +/** + * Provides timing related higher-order functions. + * + * This class should not be constructed as it only contains static methods. + */ +class Timing +{ + /** + * @hideconstructor + */ + constructor() + { + throw new Error('Timing constructor: This is a static class and should not be constructed.'); + } + + /** + * Wraps a callback in a debounced timeout. Delay execution of the callback function until the function has not been + * called for the given delay in milliseconds. + * + * @template Args + * + * @param {(...args: Args[]) => void} callback - A function to execute once the debounced threshold has been passed. + * + * @param {number} delay - An amount of time in milliseconds to delay. + * + * @returns {(...args: Args[]) => void} A wrapped function that can be called to debounce execution. + * + * @example + * /** + * * Debounce the update invocation by 500ms. + * *\/ + * const updateDebounced = Timing.debounce(() => doc.update(), 500); + * + * // Use the function like: + * updateDebounced(); + * + * @example + * /** + * * Debounce the update invocation by 500ms. + * * + * * \@param {string} value - A value to update. + * *\/ + * const updateDebounced = Timing.debounce((value) => doc.update(value), 500); + * + * // Use the function like: + * updateDebounced('new value'); + */ + static debounce(callback, delay) + { + if (typeof callback !== 'function') + { + throw new TypeError(`'callback' must be a function.`); + } + + if (!Number.isInteger(delay) || delay < 0) + { + throw new TypeError(`'delay' must be a positive integer representing milliseconds.`); + } + + let timeoutId; + + return function(...args) + { + globalThis.clearTimeout(timeoutId); + timeoutId = globalThis.setTimeout(() => { callback.apply(this, args); }, delay); + }; + } + + /** + * Creates a double click event handler that distinguishes between single and double clicks. Calls the `single` + * callback on a single click and the `double` callback on a double click. The default double click delay to invoke + * the `double` callback is 400 milliseconds. + * + * @param {object} opts - Optional parameters. + * + * @param {(event: Event) => void} [opts.single] - Single click callback. + * + * @param {(event: Event) => void} [opts.double] - Double click callback. + * + * @param {number} [opts.delay=400] - Double click delay. + * + * @returns {(event: Event) => void} The gated double-click handler. + * + * @example + * // Given a button element. + * button.addEventListener('click', Timing.doubleClick({ + * single: (event) => console.log('Single click: ', event), + * double: (event) => console.log('Double click: ', event) + * }); + */ + static doubleClick({ single, double, delay = 400 }) + { + if (single !== void 0 && typeof single !== 'function') { throw new TypeError(`'single' must be a function.`); } + if (double !== void 0 && typeof double !== 'function') { throw new TypeError(`'double' must be a function.`); } + + if (!Number.isInteger(delay) || delay < 0) + { + throw new TypeError(`'delay' must be a positive integer representing milliseconds.`); + } + + let clicks = 0; + let timeoutId; + + return (event) => + { + globalThis.clearTimeout(timeoutId); + clicks++; + + if (clicks === 1) + { + timeoutId = globalThis.setTimeout(() => + { + if (typeof single === 'function') { single(event); } + clicks = 0; + }, delay); + } + else + { + if (typeof double === 'function') { double(event); } + clicks = 0; + } + }; + } +} + +/** + * Tests for whether an object is iterable. + * + * @param {unknown} value - Any value. + * + * @returns {boolean} Whether object is iterable. + */ +function isIterable(value) { + if (value === null || value === void 0 || typeof value !== 'object') { + return false; + } + return Symbol.iterator in value; +} +/** + * Tests for whether object is not null, typeof object, and not an array. + * + * @param {unknown} value - Any value. + * + * @returns {boolean} Is it an object. + */ +function isObject(value) { + return value !== null && typeof value === 'object' && !Array.isArray(value); +} +/** + * Provides a way to safely access an objects data / entries given an accessor string which describes the + * entries to walk. To access deeper entries into the object format the accessor string with `.` between entries + * to walk. + * + * @param {object} data - An object to access entry data. + * + * @param {string} accessor - A string describing the entries to access with keys separated by `.`. + * + * @param {any} [defaultValue] - (Optional) A default value to return if an entry for accessor is not found. + * + * @returns {object} The data object. + */ +function safeAccess(data, accessor, defaultValue) { + if (typeof data !== 'object') { + return defaultValue; + } + if (typeof accessor !== 'string') { + return defaultValue; + } + const access = accessor.split('.'); + // Walk through the given object by the accessor indexes. + for (let cntr = 0; cntr < access.length; cntr++) { + // If the next level of object access is undefined or null then return the empty string. + if (typeof data[access[cntr]] === 'undefined' || data[access[cntr]] === null) { + return defaultValue; + } + data = data[access[cntr]]; + } + return data; +} + +/** + * @typedef {object} StackingContext + * + * @property {Element} node - A DOM Element. + * + * @property {string} reason - Reason for why a stacking context was created. + */ + +/** + * Provides resources for parsing style strings. + */ +class StyleParse +{ + static #regexPixels = /(\d+)\s*px/; + + /** + * Parses a pixel string / computed styles. Ex. `100px` returns `100`. + * + * @param {string} value - Value to parse. + * + * @returns {number|undefined} The integer component of a pixel string. + */ + static pixels(value) + { + if (typeof value !== 'string') { return void 0; } + + const isPixels = this.#regexPixels.test(value); + const number = parseInt(value); + + return isPixels && Number.isFinite(number) ? number : void 0; + } + + /** + * Returns the pixel value for `1rem` based on the root document element. You may apply an optional multiplier. + * + * @param {number} [multiplier=1] - Optional multiplier to apply to `rem` pixel value; default: 1. + * + * @param {object} [options] - Optional parameters. + * + * @param {Document} [options.targetDocument=document] The target DOM {@link Document} if different from the main + * browser global `document`. + * + * @returns {number} The pixel value for `1rem` with or without a multiplier based on the root document element. + */ + static remPixels(multiplier = 1, { targetDocument = document } = {}) + { + return targetDocument?.documentElement ? + multiplier * parseFloat(globalThis.getComputedStyle(targetDocument.documentElement).fontSize) : void 0; + } +} + +/** + * Provides an instance of {@link ResizeObserver} that can manage multiple elements and notify a wide range of + * {@link ResizeObserverData.ResizeTarget} listeners. Offset width and height is also provided through caching the + * margin and padding styles of the target element. + * + * The action, {@link resizeObserver}, utilizes ResizeObserverManager for automatic registration and removal + * via Svelte. + */ +class ResizeObserverManager +{ + /** @type {Map} */ + #elMap = new Map(); + + /** @type {ResizeObserver} */ + #resizeObserver; + + /** + * Defines the various shape / update type of the given target. + * + * @type {Record} + */ + static #updateTypes = Object.freeze({ + none: 0, + attribute: 1, + function: 2, + resizeObserved: 3, + setContentBounds: 4, + setDimension: 5, + storeObject: 6, + storesObject: 7 + }); + + constructor() + { + this.#resizeObserver = new ResizeObserver((entries) => + { + for (const entry of entries) + { + const subscribers = this.#elMap.get(entry?.target); + + if (Array.isArray(subscribers)) + { + const contentWidth = entry.contentRect.width; + const contentHeight = entry.contentRect.height; + + for (const subscriber of subscribers) + { + ResizeObserverManager.#updateSubscriber(subscriber, contentWidth, contentHeight); + } + } + } + }); + } + + /** + * Add an {@link HTMLElement} and {@link ResizeObserverData.ResizeTarget} instance for monitoring. Create cached + * style attributes for the given element include border & padding dimensions for offset width / height calculations. + * + * @param {HTMLElement} el - The element to observe. + * + * @param {import('./types').ResizeObserverData.ResizeTarget} target - A target that contains one of several + * mechanisms for updating resize data. + */ + add(el, target) + { + if (!(el instanceof HTMLElement)) + { + throw new TypeError(`ResizeObserverManager.add error: 'el' is not a HTMLElement.`); + } + + // Verify that this target is not already added for this element. + if (this.#hasTarget(el, target)) { return; } + + const updateType = ResizeObserverManager.#getUpdateType(target); + + if (updateType === 0) + { + throw new Error(`ResizeObserverManager.add error: 'target' is not a valid ResizeObserverManager target.`); + } + + const computed = globalThis.getComputedStyle(el); + + // Cache styles first from any inline styles then computed styles defaulting to 0 otherwise. + // Used to create the offset width & height values from the context box ResizeObserver provides. + const borderBottom = StyleParse.pixels(el.style.borderBottom) ?? StyleParse.pixels(computed.borderBottom) ?? 0; + const borderLeft = StyleParse.pixels(el.style.borderLeft) ?? StyleParse.pixels(computed.borderLeft) ?? 0; + const borderRight = StyleParse.pixels(el.style.borderRight) ?? StyleParse.pixels(computed.borderRight) ?? 0; + const borderTop = StyleParse.pixels(el.style.borderTop) ?? StyleParse.pixels(computed.borderTop) ?? 0; + const paddingBottom = StyleParse.pixels(el.style.paddingBottom) ?? StyleParse.pixels(computed.paddingBottom) ?? 0; + const paddingLeft = StyleParse.pixels(el.style.paddingLeft) ?? StyleParse.pixels(computed.paddingLeft) ?? 0; + const paddingRight = StyleParse.pixels(el.style.paddingRight) ?? StyleParse.pixels(computed.paddingRight) ?? 0; + const paddingTop = StyleParse.pixels(el.style.paddingTop) ?? StyleParse.pixels(computed.paddingTop) ?? 0; + + /** @type {import('./types-local').ResizeObserverSubscriber} */ + const data = { + updateType, + target, + + // Stores most recent contentRect.width and contentRect.height values from ResizeObserver. + contentWidth: 0, + contentHeight: 0, + + // Convenience data for total border & padding for offset width & height calculations. + styles: { + additionalWidth: borderLeft + borderRight + paddingLeft + paddingRight, + additionalHeight: borderTop + borderBottom + paddingTop + paddingBottom + } + }; + + if (this.#elMap.has(el)) + { + const subscribers = this.#elMap.get(el); + subscribers.push(data); + } + else + { + this.#elMap.set(el, [data]); + } + + this.#resizeObserver.observe(el); + } + + /** + * Clears and unobserves all currently tracked elements and managed targets. + */ + clear() + { + for (const el of this.#elMap.keys()) { this.#resizeObserver.unobserve(el); } + + this.#elMap.clear(); + } + + /** + * Removes all {@link ResizeObserverData.ResizeTarget} instances for the given element from monitoring when just an + * element is provided otherwise removes a specific target from the monitoring map. If no more targets remain then + * the element is removed from monitoring. + * + * @param {HTMLElement} el - Element to remove from monitoring. + * + * @param {import('./types').ResizeObserverData.ResizeTarget} [target] - A specific target to remove from monitoring. + */ + remove(el, target = void 0) + { + const subscribers = this.#elMap.get(el); + if (Array.isArray(subscribers)) + { + // Remove specific target from subscribers. + if (target !== void 0) + { + const index = subscribers.findIndex((entry) => entry.target === target); + if (index >= 0) + { + subscribers.splice(index, 1); + } + } + else + { + // Remove all subscribers. + subscribers.length = 0; + } + + // Remove element monitoring if last target removed. + if (subscribers.length === 0) + { + this.#elMap.delete(el); + this.#resizeObserver.unobserve(el); + } + } + } + + /** + * Provides a function that when invoked with an element updates the cached styles for each subscriber of the + * element. + * + * The style attributes cached to calculate offset height / width include border & padding dimensions. You only need + * to update the cache if you change border or padding attributes of the element. + * + * @param {HTMLElement} el - A HTML element. + */ + updateCache(el) + { + const subscribers = this.#elMap.get(el); + + if (Array.isArray(subscribers)) + { + const computed = globalThis.getComputedStyle(el); + + // Cache styles first from any inline styles then computed styles defaulting to 0 otherwise. + // Used to create the offset width & height values from the context box ResizeObserver provides. + const borderBottom = StyleParse.pixels(el.style.borderBottom) ?? StyleParse.pixels(computed.borderBottom) ?? 0; + const borderLeft = StyleParse.pixels(el.style.borderLeft) ?? StyleParse.pixels(computed.borderLeft) ?? 0; + const borderRight = StyleParse.pixels(el.style.borderRight) ?? StyleParse.pixels(computed.borderRight) ?? 0; + const borderTop = StyleParse.pixels(el.style.borderTop) ?? StyleParse.pixels(computed.borderTop) ?? 0; + const paddingBottom = StyleParse.pixels(el.style.paddingBottom) ?? + StyleParse.pixels(computed.paddingBottom) ?? 0; + const paddingLeft = StyleParse.pixels(el.style.paddingLeft) ?? StyleParse.pixels(computed.paddingLeft) ?? 0; + const paddingRight = StyleParse.pixels(el.style.paddingRight) ?? StyleParse.pixels(computed.paddingRight) ?? 0; + const paddingTop = StyleParse.pixels(el.style.paddingTop) ?? StyleParse.pixels(computed.paddingTop) ?? 0; + + const additionalWidth = borderLeft + borderRight + paddingLeft + paddingRight; + const additionalHeight = borderTop + borderBottom + paddingTop + paddingBottom; + + for (const subscriber of subscribers) + { + subscriber.styles.additionalWidth = additionalWidth; + subscriber.styles.additionalHeight = additionalHeight; + ResizeObserverManager.#updateSubscriber(subscriber, subscriber.contentWidth, subscriber.contentHeight); + } + } + } + + // Internal implementation ---------------------------------------------------------------------------------------- + + /** + * Determines the shape of the target instance regarding valid update mechanisms to set width & height changes. + * + * @param {import('./types').ResizeObserverData.ResizeTarget} target - The target instance. + * + * @returns {number} Update type value. + */ + static #getUpdateType(target) + { + if (typeof target?.resizeObserved === 'function') { return this.#updateTypes.resizeObserved; } + if (typeof target?.setDimension === 'function') { return this.#updateTypes.setDimension; } + if (typeof target?.setContentBounds === 'function') { return this.#updateTypes.setContentBounds; } + + const targetType = typeof target; + + // Does the target have resizeObserved writable store? + if (targetType !== null && (targetType === 'object' || targetType === 'function')) + { + if (isUpdatableStore(target.resizeObserved)) + { + return this.#updateTypes.storeObject; + } + + // Now check for a child stores object which is a common TRL pattern for exposing stores. + const stores = target?.stores; + if (isObject(stores) || typeof stores === 'function') + { + if (isUpdatableStore(stores.resizeObserved)) + { + return this.#updateTypes.storesObject; + } + } + } + + if (targetType !== null && targetType === 'object') { return this.#updateTypes.attribute; } + + if (targetType === 'function') { return this.#updateTypes.function; } + + return this.#updateTypes.none; + } + + /** + * Determines if a given element and target is already being observed. + * + * @param {HTMLElement} el - A HTMLElement. + * + * @param {import('./types').ResizeObserverData.ResizeTarget} [target] - A specific target to find. + * + * @returns {boolean} Whether the target is already being tracked for the given element. + */ + #hasTarget(el, target) + { + if (target === void 0 || target === null) { return false;} + + const subscribers = this.#elMap.get(el); + if (Array.isArray(subscribers)) + { + return subscribers.findIndex((entry) => entry.target === target) >= 0; + } + + return false; + } + + /** + * Updates a subscriber target with given content width & height values. Offset width & height is calculated from + * the content values + cached styles. + * + * @param {import('./types-local').ResizeObserverSubscriber} subscriber - Internal data about subscriber. + * + * @param {number|undefined} contentWidth - ResizeObserver `contentRect.width` value or undefined. + * + * @param {number|undefined} contentHeight - ResizeObserver `contentRect.height` value or undefined. + */ + static #updateSubscriber(subscriber, contentWidth, contentHeight) + { + const styles = subscriber.styles; + + subscriber.contentWidth = contentWidth; + subscriber.contentHeight = contentHeight; + + const offsetWidth = Number.isFinite(contentWidth) ? contentWidth + styles.additionalWidth : void 0; + const offsetHeight = Number.isFinite(contentHeight) ? contentHeight + styles.additionalHeight : void 0; + + const target = subscriber.target; + + switch (subscriber.updateType) + { + case this.#updateTypes.attribute: + target.contentWidth = contentWidth; + target.contentHeight = contentHeight; + target.offsetWidth = offsetWidth; + target.offsetHeight = offsetHeight; + break; + + case this.#updateTypes.function: + target?.(offsetWidth, offsetHeight, contentWidth, contentHeight); + break; + + case this.#updateTypes.resizeObserved: + target.resizeObserved?.(offsetWidth, offsetHeight, contentWidth, contentHeight); + break; + + case this.#updateTypes.setContentBounds: + target.setContentBounds?.(contentWidth, contentHeight); + break; + + case this.#updateTypes.setDimension: + target.setDimension?.(offsetWidth, offsetHeight); + break; + + case this.#updateTypes.storeObject: + target.resizeObserved.update((object) => + { + object.contentHeight = contentHeight; + object.contentWidth = contentWidth; + object.offsetHeight = offsetHeight; + object.offsetWidth = offsetWidth; + + return object; + }); + break; + + case this.#updateTypes.storesObject: + target.stores.resizeObserved.update((object) => + { + object.contentHeight = contentHeight; + object.contentWidth = contentWidth; + object.offsetHeight = offsetHeight; + object.offsetWidth = offsetWidth; + + return object; + }); + break; + } + } +} + +/** + * Provides several helpful utility methods for accessibility and keyboard navigation. + * + * Note: Global debugging can be enabled by setting `A11yHelper.debug = true`. + */ +class A11yHelper +{ + /** + * Provides the event constructor names to duck type against. This is necessary for when HTML nodes / elements are + * moved to another browser window as `instanceof` checks will fail. + * + * @type {Set} + */ + static #eventTypesAll = new Set(['KeyboardEvent', 'MouseEvent', 'PointerEvent']); + static #eventTypesPointer = new Set(['MouseEvent', 'PointerEvent']); + + /** + * You can set global focus debugging enabled by setting `A11yHelper.debug = true`. + * + * @type {boolean} + */ + static #globalDebug = false; + + /** + * @returns {boolean} Global debugging enabled. + */ + static get debug() { return this.#globalDebug; } + + /** + * @param {boolean} debug - Global debug enabled + */ + static set debug(debug) + { + if (typeof debug !== 'boolean') { throw new TypeError(`'debug' is not a boolean.`); } + + this.#globalDebug = debug; + } + + /** + * Runs a media query to determine if the user / OS configuration is set up for reduced motion / animation. + * + * @returns {boolean} User prefers reduced motion. + */ + static get prefersReducedMotion() + { + return globalThis?.matchMedia('(prefers-reduced-motion: reduce)')?.matches ?? false; + } + + /** + * Apply focus to the HTMLElement / SVGElement targets in a given A11yFocusSource data object. An iterable list + * `options.focusEl` can contain HTMLElement / SVGElements or selector strings. If multiple focus targets are + * provided in a list then the first valid target found will be focused. If focus target is a string then a lookup + * via `document.querySelector` is performed. In this case you should provide a unique selector for the desired + * focus target. + * + * Note: The body of this method is postponed to the next clock tick to allow any changes in the DOM to occur that + * might alter focus targets before applying. + * + * @param {A11yFocusSource | { focusSource: A11yFocusSource }} options - The focus options instance to apply. + */ + static applyFocusSource(options) + { + if (!isObject(options)) { return; } + + // Handle the case of receiving an object with embedded `focusSource`. + const focusOpts = isObject(options?.focusSource) ? options.focusSource : options; + + setTimeout(() => + { + const debug = typeof focusOpts.debug === 'boolean' ? this.debug || focusOpts.debug : this.debug; + + if (isIterable(focusOpts.focusEl)) + { + if (debug) + { + console.debug(`A11yHelper.applyFocusSource debug - Attempting to apply focus target: `, + focusOpts.focusEl); + } + + for (const target of focusOpts.focusEl) + { + if (target?.nodeType === Node.ELEMENT_NODE && target?.isConnected) + { + target?.focus(); + if (debug) + { + console.debug(`A11yHelper.applyFocusSource debug - Applied focus to target: `, target); + } + break; + } + else if (typeof target === 'string') + { + const element = document.querySelector(target); + if (element?.nodeType === Node.ELEMENT_NODE && element?.isConnected) + { + element?.focus(); + if (debug) + { + console.debug(`A11yHelper.applyFocusSource debug - Applied focus to target: `, element); + } + break; + } + else if (debug) + { + console.debug(`A11yHelper.applyFocusSource debug - Could not query selector: `, target); + } + } + } + } + else if (debug) + { + console.debug(`A11yHelper.applyFocusSource debug - No focus targets defined.`); + } + }, 0); + } + + /** + * Returns first focusable element within a specified element. + * + * @param {Element | Document} [element=document] - Optional element to start query. + * + * @param {object} [options] - Optional parameters. + * + * @param {Iterable} [options.ignoreClasses] - Iterable list of classes to ignore elements. + * + * @param {Set} [options.ignoreElements] - Set of elements to ignore. + * + * @returns {FocusableElement} First focusable child element. + */ + static getFirstFocusableElement(element = document, options) + { + const focusableElements = this.getFocusableElements(element, options); + + return focusableElements.length > 0 ? focusableElements[0] : void 0; + } + + /** + * Returns all focusable elements within a specified element. + * + * @param {Element | Document} [element=document] Optional element to start query. + * + * @param {object} [options] - Optional parameters. + * + * @param {boolean} [options.anchorHref=true] - When true anchors must have an HREF. + * + * @param {Iterable} [options.ignoreClasses] - Iterable list of classes to ignore elements. + * + * @param {Set} [options.ignoreElements] - Set of elements to ignore. + * + * @param {string} [options.selectors] - Custom list of focusable selectors for `querySelectorAll`. + * + * @returns {Array} Child keyboard focusable elements. + */ + static getFocusableElements(element = document, { anchorHref = true, ignoreClasses, ignoreElements, selectors } = {}) + { + if (element?.nodeType !== Node.ELEMENT_NODE && element?.nodeType !== Node.DOCUMENT_NODE) + { + throw new TypeError(`'element' is not a HTMLElement, SVGElement, or Document instance.`); + } + + if (typeof anchorHref !== 'boolean') + { + throw new TypeError(`'anchorHref' is not a boolean.`); + } + + if (ignoreClasses !== void 0 && !isIterable(ignoreClasses)) + { + throw new TypeError(`'ignoreClasses' is not an iterable list.`); + } + + if (ignoreElements !== void 0 && !(ignoreElements instanceof Set)) + { + throw new TypeError(`'ignoreElements' is not a Set.`); + } + + if (selectors !== void 0 && typeof selectors !== 'string') + { + throw new TypeError(`'selectors' is not a string.`); + } + + const selectorQuery = selectors ?? this.#getFocusableSelectors(anchorHref); + + const allElements = [...element.querySelectorAll(selectorQuery)]; + + if (ignoreElements && ignoreClasses) + { + return allElements.filter((el) => + { + let hasIgnoreClass = false; + for (const ignoreClass of ignoreClasses) + { + if (el.classList.contains(ignoreClass)) + { + hasIgnoreClass = true; + break; + } + } + + return !hasIgnoreClass && !ignoreElements.has(el) && el.style.display !== 'none' && + el.style.visibility !== 'hidden' && !el.hasAttribute('disabled') && !el.hasAttribute('inert') && + el.getAttribute('aria-hidden') !== 'true'; + }); + } + else if (ignoreClasses) + { + return allElements.filter((el) => + { + let hasIgnoreClass = false; + for (const ignoreClass of ignoreClasses) + { + if (el.classList.contains(ignoreClass)) + { + hasIgnoreClass = true; + break; + } + } + + return !hasIgnoreClass && el.style.display !== 'none' && el.style.visibility !== 'hidden' && + !el.hasAttribute('disabled') && !el.hasAttribute('inert') && el.getAttribute('aria-hidden') !== 'true'; + }); + } + else if (ignoreElements) + { + return allElements.filter((el) => + { + return !ignoreElements.has(el) && el.style.display !== 'none' && el.style.visibility !== 'hidden' && + !el.hasAttribute('disabled') && !el.hasAttribute('inert') && el.getAttribute('aria-hidden') !== 'true'; + }); + } + else + { + return allElements.filter((el) => + { + return el.style.display !== 'none' && el.style.visibility !== 'hidden' && !el.hasAttribute('disabled') && + !el.hasAttribute('inert') && el.getAttribute('aria-hidden') !== 'true'; + }); + } + } + + /** + * Returns the default focusable selectors query. + * + * @param {boolean} [anchorHref=true] - When true anchors must have an HREF. + * + * @returns {string} Focusable selectors for `querySelectorAll`. + */ + static #getFocusableSelectors(anchorHref = true) + { + return `button, [contenteditable=""], [contenteditable="true"], details summary:not([tabindex="-1"]), embed, a${ + anchorHref ? '[href]' : ''}, iframe, object, input:not([type=hidden]), select, textarea, ` + + `[tabindex]:not([tabindex="-1"])`; + } + + /** + * Gets a A11yFocusSource object from the given DOM event allowing for optional X / Y screen space overrides. + * Browsers (Firefox / Chrome) forwards a mouse event for the context menu keyboard button. Provides detection of + * when the context menu event is from the keyboard. Firefox as of (1/23) does not provide the correct screen space + * coordinates, so for keyboard context menu presses coordinates are generated from the centroid point of the + * element. + * + * A default fallback element or selector string may be provided to provide the focus target. If the event comes from + * the keyboard however the source focused element is inserted as the target with the fallback value appended to the + * list of focus targets. When A11yFocusSource is applied by {@link A11yHelper.applyFocusSource} the target focus + * list is iterated through until a connected target is found and focus applied. + * + * @param {object} options - Options + * + * @param {KeyboardEvent | MouseEvent} [options.event] - The source DOM event. + * + * @param {boolean} [options.debug] - When true {@link A11yHelper.applyFocusSource} logs focus target data. + * + * @param {FocusableElement | string} [options.focusEl] - A specific HTMLElement / SVGElement or selector + * string as the focus target. + * + * @param {number} [options.x] - Used when an event isn't provided; integer of event source in screen space. + * + * @param {number} [options.y] - Used when an event isn't provided; integer of event source in screen space. + * + * @returns {A11yFocusSource} A A11yFocusSource object. + * + * @see https://bugzilla.mozilla.org/show_bug.cgi?id=1426671 + * @see https://bugzilla.mozilla.org/show_bug.cgi?id=314314 + * + * TODO: Evaluate / test against touch input devices. + */ + static getFocusSource({ event, x, y, focusEl, debug = false }) + { + if (focusEl !== void 0 && !this.isFocusSource(focusEl)) + { + throw new TypeError( + `A11yHelper.getFocusSource error: 'focusEl' is not a HTMLElement, SVGElement, or string.`); + } + + if (debug !== void 0 && typeof debug !== 'boolean') + { + throw new TypeError(`A11yHelper.getFocusSource error: 'debug' is not a boolean.`); + } + + const debugEnabled = typeof debug === 'boolean' ? this.debug || debug : this.debug; + + // Handle the case when no event is provided and x, y, or focusEl is explicitly defined. + if (event === void 0) + { + if (typeof x !== 'number') + { + throw new TypeError(`A11yHelper.getFocusSource error: 'event' not defined and 'x' is not a number.`); + } + + if (typeof y !== 'number') + { + throw new TypeError(`A11yHelper.getFocusSource error: 'event' not defined and 'y' is not a number.`); + } + + const result = { + debug, + focusEl: focusEl !== void 0 ? [focusEl] : void 0, + x, + y, + }; + + if (debugEnabled) + { + console.debug(`A11yHelper.getFocusSource debug: generated 'focusSource' without event: `, result); + } + + return result; + } + + // Perform duck typing on event constructor name. + if (!A11yHelper.#eventTypesAll.has(event?.constructor?.name)) + { + throw new TypeError( + `A11yHelper.getFocusSource error: 'event' is not a KeyboardEvent, MouseEvent, or PointerEvent.`); + } + + if (x !== void 0 && !Number.isInteger(x)) + { + throw new TypeError(`A11yHelper.getFocusSource error: 'x' is not a number.`); + } + + if (y !== void 0 && !Number.isInteger(y)) + { + throw new TypeError(`A11yHelper.getFocusSource error: 'y' is not a number.`); + } + + /** @type {Element} */ + let targetEl; + + if (event) + { + if (A11yHelper.isFocusable(event.target)) + { + targetEl = event.target; + if (debugEnabled) + { + console.debug(`A11yHelper.getFocusSource debug: 'targetEl' set to event.target: `, targetEl); + } + } + else if (A11yHelper.isFocusable(event.currentTarget)) + { + targetEl = event.currentTarget; + if (debugEnabled) + { + console.debug(`A11yHelper.getFocusSource debug: 'targetEl' set to event.currentTarget: `, targetEl); + } + } + else + { + if (debugEnabled) + { + console.debug( + `A11yHelper.getFocusSource debug: 'event.target' / 'event.currentTarget' are not focusable.`); + console.debug(`A11yHelper.getFocusSource debug: 'event.target': `, event.target); + console.debug(`A11yHelper.getFocusSource debug: 'event.currentTarget': `, event.currentTarget); + } + } + + if (targetEl) + { + if (targetEl?.nodeType !== Node.ELEMENT_NODE && typeof targetEl?.focus !== 'function') + { + throw new TypeError(`A11yHelper.getFocusSource error: 'targetEl' is not an HTMLElement or SVGElement.`); + } + } + } + + const result = { debug }; + + // Perform duck typing on event constructor name. + if (A11yHelper.#eventTypesPointer.has(event?.constructor?.name)) + { + // Firefox currently (1/23) does not correctly determine the location of a keyboard originated + // context menu location, so calculate position from middle of the event target. + // Firefox fires a mouse event for the context menu key. + if (event?.button !== 2 && event.type === 'contextmenu') + { + // Always include x / y coordinates and targetEl may not be defined. + const rectTarget = targetEl ?? event.target; + + const rect = rectTarget.getBoundingClientRect(); + result.source = 'keyboard'; + result.x = x ?? rect.left + (rect.width / 2); + result.y = y ?? rect.top + (rect.height / 2); + result.focusEl = targetEl ? [targetEl] : []; + + if (focusEl) { result.focusEl.push(focusEl); } + } + else + { + result.source = 'pointer'; + result.x = x ?? event.pageX; + result.y = y ?? event.pageY; + result.focusEl = targetEl ? [targetEl] : []; + + if (focusEl) { result.focusEl.push(focusEl); } + } + } + else + { + // Always include x / y coordinates and targetEl may not be defined. + const rectTarget = targetEl ?? event.target; + + const rect = rectTarget.getBoundingClientRect(); + result.source = 'keyboard'; + result.x = x ?? rect.left + (rect.width / 2); + result.y = y ?? rect.top + (rect.height / 2); + result.focusEl = targetEl ? [targetEl] : []; + + if (focusEl) { result.focusEl.push(focusEl); } + } + + if (debugEnabled) + { + console.debug(`A11yHelper.getFocusSource debug: generated 'focusSource' with event: `, result); + } + + return result; + } + + /** + * Returns first focusable element within a specified element. + * + * @param {Element | Document} [element=document] - Optional element to start query. + * + * @param {object} [options] - Optional parameters. + * + * @param {Iterable} [options.ignoreClasses] - Iterable list of classes to ignore elements. + * + * @param {Set} [options.ignoreElements] - Set of elements to ignore. + * + * @returns {FocusableElement} Last focusable child element. + */ + static getLastFocusableElement(element = document, options) + { + const focusableElements = this.getFocusableElements(element, options); + + return focusableElements.length > 0 ? focusableElements[focusableElements.length - 1] : void 0; + } + + /** + * Tests if the given element is focusable. + * + * @param {Element} el - Element to test. + * + * @param {object} [options] - Optional parameters. + * + * @param {boolean} [options.anchorHref=true] - When true anchors must have an HREF. + * + * @param {Iterable} [options.ignoreClasses] - Iterable list of classes to ignore elements. + * + * @returns {boolean} Element is focusable. + */ + static isFocusable(el, { anchorHref = true, ignoreClasses } = {}) + { + if (el === void 0 || el === null || el?.hidden || !el?.isConnected || el?.nodeType !== Node.ELEMENT_NODE || + typeof el?.focus !== 'function') + { + return false; + } + + if (typeof anchorHref !== 'boolean') + { + throw new TypeError(`'anchorHref' is not a boolean.`); + } + + if (ignoreClasses !== void 0 && !isIterable(ignoreClasses)) + { + throw new TypeError(`'ignoreClasses' is not an iterable list.`); + } + + const contenteditableAttr = el.getAttribute('contenteditable'); + const contenteditableFocusable = typeof contenteditableAttr === 'string' && + (contenteditableAttr === '' || contenteditableAttr === 'true'); + + const tabindexAttr = globalThis.parseInt(el.getAttribute('tabindex')); + const tabindexFocusable = Number.isInteger(tabindexAttr) && tabindexAttr >= 0; + + const isAnchor = el instanceof HTMLAnchorElement; + + if (contenteditableFocusable || tabindexFocusable || isAnchor || el instanceof HTMLButtonElement || + el instanceof HTMLDetailsElement || el instanceof HTMLEmbedElement || el instanceof HTMLIFrameElement || + el instanceof HTMLInputElement || el instanceof HTMLObjectElement || el instanceof HTMLSelectElement || + el instanceof HTMLTextAreaElement) + { + if (isAnchor && !tabindexFocusable && anchorHref && typeof el.getAttribute('href') !== 'string') + { + return false; + } + + return el.style.display !== 'none' && el.style.visibility !== 'hidden' && !el.hasAttribute('disabled') && + !el.hasAttribute('inert') && el.getAttribute('aria-hidden') !== 'true'; + } + + return false; + } + + /** + * Convenience method to check if the given data is a valid focus source. + * + * @param {Element | string} data - Either an HTMLElement, SVGElement, or selector string. + * + * @returns {boolean} Is valid focus source. + */ + static isFocusSource(data) + { + return typeof data === 'string' || (data?.nodeType === Node.ELEMENT_NODE && typeof data?.focus === 'function'); + } + + /** + * Tests if the given `element` is a Element node and has a `focus` method. + * + * @param {Element} element - Element to test for focus method. + * + * @returns {boolean} Whether the element has a focus method. + */ + static isFocusTarget(element) + { + return element !== void 0 && element !== null && element?.nodeType === Node.ELEMENT_NODE && + typeof element?.focus === 'function'; + } + + /** + * Perform a parent traversal from the current active element attempting to match the given element to test whether + * current active element is within that element. + * + * @param {Element} element - An element to match in parent traversal from the active element. + * + * @param {Window} [activeWindow=globalThis] The active window to use for the current active element. + * + * @returns {boolean} Whether there is focus within the given element. + */ + static isFocusWithin(element, activeWindow = globalThis) + { + if (element === void 0 || element === null || element?.hidden || !element?.isConnected) { return false; } + + if (Object.prototype.toString.call(activeWindow) !== '[object Window]') { return false; } + + let active = activeWindow.document.activeElement; + + while (active) + { + if (active === element) { return true; } + + active = active.parentElement; + } + + return false; + } +} + +/** + * Provides utility functions for retrieving data about images. + */ +class ImageData +{ + /** + * Loads given URLs into image elements returning those that resolved with width & height dimensions. This is useful + * when the size of an image is necessary before usage. + * + * @param {string | { url?: string } | Iterable} urls - A list of image URLS to load or + * object with an `url` property. + * + * @param {object} [options] - Optional options. + * + * @param {string} [options.accessor='url'] - Accessor string to access child attribute when `urls` entry contains + * objects. + * + * @param {boolean} [options.warn=false] - Log debug warnings when a target URL can not be determined; default: false. + * + * @returns {(Promise<{ + * fulfilled: { url: string, width: number, height: number }[], + * rejected: { url: string }[] + * }>)} An object with `fulfilled` and `rejected` requests. + */ + static async getDimensions(urls, { accessor = 'url', warn = false } = {}) + { + const promises = []; + const fulfilled = []; + const rejected = []; + + const targetURLs = isIterable(urls) ? urls : [urls]; + + for (const url of targetURLs) + { + let targetURL; + + if (typeof url === 'string') + { + targetURL = url; + } + else if (isObject(url)) + { + targetURL = safeAccess(url, accessor); + } + + if (typeof targetURL !== 'string') + { + if (warn) + { + console.warn('ImageData.getDimensions warning: Failed to locate target URL.'); + } + + continue; + } + + promises.push(new Promise((resolve, reject) => + { + const img = new Image(); + img.src = targetURL; + + // Get the actual width / height of the image. + img.onload = () => resolve({ url: targetURL, width: img.naturalWidth, height: img.naturalHeight }); + img.onerror = () => reject({ url: targetURL }); + })); + } + + const promiseResults = await Promise.allSettled(promises); + + for (const result of promiseResults) + { + switch (result.status) + { + case 'fulfilled': + fulfilled.push(result.value); + break; + + case 'rejected': + rejected.push(result.reason); + break; + } + } + + return { fulfilled, rejected }; + } +} + +/** + * Provides a toggle action for `details` HTML elements. The boolean store provided controls animation. + * + * It is not necessary to bind the store to the `open` attribute of the associated details element. + * + * When the action is triggered to close the details element a data attribute `closing` is set to `true`. This allows + * any associated closing transitions to start immediately. + * + * @param {HTMLDetailsElement} details - The details element. + * + * @param {object} opts - Options parameters. + * + * @param {import('svelte/store').Writable} opts.store - A boolean store. + * + * @param {boolean} [opts.animate=true] - When true animate close / open state with WAAPI. + * + * @param {boolean} [opts.clickActive=true] - When false click events are not handled. + * + * @returns {import('svelte/action').ActionReturn} Lifecycle functions. + */ +function toggleDetails(details, { store, animate = true, clickActive = true } = {}) +{ + // Add closing data. Useful for animating chevron immediately while closing. + details.dataset.closing = 'false'; + + /** @type {HTMLElement} */ + const summaryEl = details.querySelector('summary'); + + /** @type {HTMLElement} */ + let contentEl = null; + + // Find the first child that is not a summary element; this is the content element. When animating overflow is + // set to `hidden` to prevent scrollbars from activating. + for (const child of details.children) + { + if (child.tagName !== 'SUMMARY') + { + contentEl = child; + break; + } + } + + /** @type {Animation} */ + let animation; + + /** @type {boolean} */ + let open = details.open; // eslint-disable-line no-shadow + + // The store sets initial open state and handles animation on further changes. + let unsubscribe = subscribeFirstRest(store, (value) => { open = value; details.open = open; }, async (value) => + { + open = value; + + // Await `tick` to allow any conditional logic in the template to complete updating before handling animation. + await tick(); + + handleAnimation(); + }); + + /** + * @param {number} a - + * + * @param {number} b - + * + * @param {boolean} value - + */ + function animateWAAPI(a, b, value) + { + // Must guard when `b - a === 0`; add a small epsilon and wrap with Math.max. + const duration = Math.max(0, 30 * Math.log(Math.abs(b - a) + Number.EPSILON)); + + if (animate) + { + details.style.overflow = 'hidden'; + if (contentEl) { contentEl.style.overflow = 'hidden'; } + + animation = details.animate( + { + height: [`${a}px`, `${b}px`] + }, + { + duration, + easing: 'ease-out' + } + ); + + animation.onfinish = () => + { + details.open = value; + details.dataset.closing = 'false'; + details.style.overflow = null; + if (contentEl) { contentEl.style.overflow = null; } + }; + } + else + { + details.open = value; + details.dataset.closing = 'false'; + details.style.overflow = null; + if (contentEl) { contentEl.style.overflow = null; } + } + } + + /** + * Handles animation coordination based on current state. + */ + function handleAnimation() + { + if (open) + { + const a = details.offsetHeight; + if (animation) { animation.cancel(); } + details.open = true; + const b = details.offsetHeight; + + animateWAAPI(a, b, true); + } + else + { + const a = details.offsetHeight; + if (animation) { animation.cancel(); } + const b = summaryEl.offsetHeight; + + details.dataset.closing = 'true'; + + animateWAAPI(a, b, false); + } + } + + /** + * @param {MouseEvent} e - A mouse event. + */ + function handleClick(e) + { + if (clickActive) + { + e.preventDefault(); + + // Simply set the store to the opposite of current open state and the callback above handles animation. + store.set(!open); + } + } + + summaryEl.addEventListener('click', handleClick); + + return { + update(options) + { + if (isWritableStore(options.store) && options.store !== store) + { + if (typeof unsubscribe === 'function') { unsubscribe(); } + store = options.store; + + unsubscribe = subscribeFirstRest(store, (value) => { open = value; details.open = open; }, async (value) => + { + open = value; + + // Await `tick` to allow any conditional logic in the template to complete updating before handling + // animation. + await tick(); + + handleAnimation(); + }); + } + + if (typeof options.animate === 'boolean') { animate = options.animate; } + + if (typeof options.clickActive === 'boolean') { clickActive = options.clickActive; } + }, + destroy() + { + unsubscribe(); + summaryEl.removeEventListener('click', handleClick); + } + }; +} + +const subscriber_queue = []; + +/** + * Creates a `Readable` store that allows reading by subscription. + * + * https://svelte.dev/docs/svelte-store#readable + * @template T + * @param {T} [value] initial value + * @param {import('./public.js').StartStopNotifier} [start] + * @returns {import('./public.js').Readable} + */ +function readable(value, start) { + return { + subscribe: writable(value, start).subscribe + }; +} + +/** + * Create a `Writable` store that allows both updating and reading by subscription. + * + * https://svelte.dev/docs/svelte-store#writable + * @template T + * @param {T} [value] initial value + * @param {import('./public.js').StartStopNotifier} [start] + * @returns {import('./public.js').Writable} + */ +function writable(value, start = noop) { + /** @type {import('./public.js').Unsubscriber} */ + let stop; + /** @type {Set>} */ + const subscribers = new Set(); + /** @param {T} new_value + * @returns {void} + */ + function set(new_value) { + if (safe_not_equal(value, new_value)) { + value = new_value; + if (stop) { + // store is ready + const run_queue = !subscriber_queue.length; + for (const subscriber of subscribers) { + subscriber[1](); + subscriber_queue.push(subscriber, value); + } + if (run_queue) { + for (let i = 0; i < subscriber_queue.length; i += 2) { + subscriber_queue[i][0](subscriber_queue[i + 1]); + } + subscriber_queue.length = 0; + } + } + } + } + + /** + * @param {import('./public.js').Updater} fn + * @returns {void} + */ + function update(fn) { + set(fn(value)); + } + + /** + * @param {import('./public.js').Subscriber} run + * @param {import('./private.js').Invalidator} [invalidate] + * @returns {import('./public.js').Unsubscriber} + */ + function subscribe(run, invalidate = noop) { + /** @type {import('./private.js').SubscribeInvalidateTuple} */ + const subscriber = [run, invalidate]; + subscribers.add(subscriber); + if (subscribers.size === 1) { + stop = start(set, update) || noop; + } + run(value); + return () => { + subscribers.delete(subscriber); + if (subscribers.size === 0 && stop) { + stop(); + stop = null; + } + }; + } + return { set, update, subscribe }; +} + +/** + * Derived value store by synchronizing one or more readable stores and + * applying an aggregation function over its input values. + * + * https://svelte.dev/docs/svelte-store#derived + * @template {import('./private.js').Stores} S + * @template T + * @overload + * @param {S} stores - input stores + * @param {(values: import('./private.js').StoresValues, set: (value: T) => void, update: (fn: import('./public.js').Updater) => void) => import('./public.js').Unsubscriber | void} fn - function callback that aggregates the values + * @param {T} [initial_value] - initial value + * @returns {import('./public.js').Readable} + */ + +/** + * Derived value store by synchronizing one or more readable stores and + * applying an aggregation function over its input values. + * + * https://svelte.dev/docs/svelte-store#derived + * @template {import('./private.js').Stores} S + * @template T + * @overload + * @param {S} stores - input stores + * @param {(values: import('./private.js').StoresValues) => T} fn - function callback that aggregates the values + * @param {T} [initial_value] - initial value + * @returns {import('./public.js').Readable} + */ + +/** + * @template {import('./private.js').Stores} S + * @template T + * @param {S} stores + * @param {Function} fn + * @param {T} [initial_value] + * @returns {import('./public.js').Readable} + */ +function derived(stores, fn, initial_value) { + const single = !Array.isArray(stores); + /** @type {Array>} */ + const stores_array = single ? [stores] : stores; + if (!stores_array.every(Boolean)) { + throw new Error('derived() expects stores as input, got a falsy value'); + } + const auto = fn.length < 2; + return readable(initial_value, (set, update) => { + let started = false; + const values = []; + let pending = 0; + let cleanup = noop; + const sync = () => { + if (pending) { + return; + } + cleanup(); + const result = fn(single ? values[0] : values, set, update); + if (auto) { + set(result); + } else { + cleanup = is_function(result) ? result : noop; + } + }; + const unsubscribers = stores_array.map((store, i) => + subscribe( + store, + (value) => { + values[i] = value; + pending &= ~(1 << i); + if (started) { + sync(); + } + }, + () => { + pending |= 1 << i; + } + ) + ); + started = true; + sync(); + return function stop() { + run_all(unsubscribers); + cleanup(); + // We need to set this to false because callbacks can still happen despite having unsubscribed: + // Callbacks might already be placed in the queue which doesn't know it should no longer + // invoke this derived store. + started = false; + }; + }); +} + +/** + * Generates derived, readable, writable helper functions wrapping the given Storage API provided with any additional + * customization for data serialization. By default, JSON serialization is used. + * + * @param {object} opts - Generator options. + * + * @param {Storage} opts.storage - The web storage source. + * + * @param {(value: any, ...rest: any[]) => string} [opts.serialize] - Replace with custom serialization; + * default: `JSON.stringify`. + * + * @param {(value: string, ...rest: any[]) => any} [opts.deserialize] - Replace with custom deserialization; + * default: `JSON.parse`. + * + * @returns {StorageStores} A complete set of store helper functions and associated storage API instance and + * serialization strategy. + */ +function storeGenerator({ storage, serialize = JSON.stringify, deserialize = JSON.parse }) { + function isSimpleDeriver(deriver) { + return deriver.length < 2; + } + function storageReadable(key, value, start) { + return { + subscribe: storageWritable(key, value, start).subscribe + }; + } + function storageWritable(key, value, start) { + function wrap_start(ogSet) { + return start(function wrap_set(new_value) { + if (storage) { + storage.setItem(key, serialize(new_value)); + } + return ogSet(new_value); + }, function wrap_update(fn) { + set(fn(get_store_value(ogStore))); + }); + } + if (storage) { + const storageValue = storage.getItem(key); + try { + if (storageValue) { + value = deserialize(storageValue); + } + } + catch (err) { /**/ } + storage.setItem(key, serialize(value)); + } + const ogStore = writable(value, start ? wrap_start : void 0); + function set(new_value) { + if (storage) { + storage.setItem(key, serialize(new_value)); + } + ogStore.set(new_value); + } + function update(fn) { + set(fn(get_store_value(ogStore))); + } + function subscribe(run, invalidate) { + return ogStore.subscribe(run, invalidate); + } + return { set, update, subscribe }; + } + function storageDerived(key, stores, fn, initial_value) { + const single = !Array.isArray(stores); + const stores_array = single ? [stores] : stores; + if (storage && storage.getItem(key)) { + try { + initial_value = deserialize(storage.getItem(key)); + } + catch (err) { /**/ } + } + return storageReadable(key, initial_value, (set, update) => { + let inited = false; + const values = []; + let pending = 0; + let cleanup; + const sync = () => { + if (pending) { + return; + } + cleanup?.(); + const input = single ? values[0] : values; + if (isSimpleDeriver(fn)) { + set(fn(input)); + } + else { + const result = fn(input, set, update); + if (typeof result === 'function') { + cleanup = result; + } + } + }; + const unsubscribers = stores_array.map((store, i) => store.subscribe((value) => { + values[i] = value; + pending &= ~(1 << i); + if (inited) { + sync(); + } + }, () => { pending |= (1 << i); })); + inited = true; + sync(); + return function stop() { + // Equivalent to run_all from Svelte internals. + unsubscribers.forEach((unsubscriber) => unsubscriber()); + cleanup?.(); + }; + }); + } + return { + readable: storageReadable, + writable: storageWritable, + derived: storageDerived, + storage, + serialize, + deserialize + }; +} + +/** + * Provides all Storage API enabled `localStorage` store helper functions. Data is serialized as JSON. + */ +const localStores = storeGenerator({ storage: globalThis?.localStorage }); + +/** + * Provides all Storage API enabled `sessionStorage` store helper functions. Data is serialized as JSON. + */ +const sessionStores = storeGenerator({ storage: globalThis?.sessionStorage }); + +/** + * Provides the base Storage API store manager. It is recommended to use {@link TJSLocalStorage} & + * {@link TJSSessionStorage} for standard browser local and session storage use cases. TJSWebStorage exists + * to provide additional customization options for custom Storage API compatible storage instances and custom + * serialization configuration. + */ +class TJSWebStorage +{ + /** @type {import('./').StorageStores} */ + #storageStores; + + /** + * @type {(Map any, + * serialize?: (value: any, ...rest: any[]) => string + * }>)} + */ + #stores = new Map(); + + /** + * @param {import('./').StorageStores} storageStores - Provides a complete set of + * storage API store helper functions and the associated storage API instance and serializations strategy. + */ + constructor(storageStores) + { + this.#storageStores = storageStores; + } + + /** + * Creates a new store for the given key. + * + * @template T + * + * @param {string} key - Key to lookup in stores map. + * + * @param {T} [defaultValue] - A default value to set for the store. + * + * @param {import('./').StorageStores} [storageStores] - Additional store creation options. + * + * @returns {import('svelte/store').Writable} The new store. + */ + #createStore(key, defaultValue = void 0, storageStores) + { + try + { + const value = this.#storageStores.storage.getItem(key); + if (value !== null) + { + const deserialize = storageStores?.deserialize ?? this.#storageStores.deserialize; + defaultValue = deserialize(value); + } + } + catch (err) { /**/ } + + const writable = storageStores?.writable ?? this.#storageStores.writable; + + return writable(key, defaultValue); + } + + /** + * @param {string} key - Storage key. + * + * @returns {(value: string, ...rest: any[]) => any} Deserialize function. + */ + #getDeserialize(key) + { + return this.#stores.get(key)?.deserialize ?? this.#storageStores.deserialize; + } + + /** + * @param {string} key - Storage key. + * + * @returns {(value: any, ...rest: any[]) => string} Serialize function. + */ + #getSerialize(key) + { + return this.#stores.get(key)?.serialize ?? this.#storageStores.serialize; + } + + /** + * Gets a store from the `stores` Map or creates a new store for the key and a given default value. + * + * @template T + * + * @param {string} key - Key to lookup in stores map. + * + * @param {T} [defaultValue] - A default value to set for the store. + * + * @param {import('./').StorageStores} [storageStores] - Additional store creation options. + * + * @returns {import('svelte/store').Writable} The store for the given key. + */ + #getStore(key, defaultValue = void 0, storageStores) + { + const storeEntry = this.#stores.get(key); + if (storeEntry) { return storeEntry.store; } + + const store = this.#createStore(key, defaultValue, storageStores); + + // Set any key specific storage helper details. + this.#stores.set(key, { + store, + deserialize: storageStores?.deserialize, + serialize: storageStores?.serialize + }); + + return store; + } + + /** + * Get value from the storage API. + * + * @param {string} key - Key to lookup in storage API. + * + * @param {*} [defaultValue] - A default value to return if key not present in session storage. + * + * @returns {*} Value from session storage or if not defined any default value provided. + */ + getItem(key, defaultValue) + { + let value = defaultValue; + + const storageValue = this.#storageStores.storage.getItem(key); + + if (storageValue !== null) + { + try + { + value = this.#getDeserialize(key)(storageValue); + } + catch (err) + { + value = defaultValue; + } + } + else if (defaultValue !== void 0) + { + try + { + const newValue = this.#getSerialize(key)(defaultValue); + + // If there is no existing storage value and defaultValue is defined the storage value needs to be set. + this.#storageStores.storage.setItem(key, newValue); + } + catch (err) { /* */ } + } + + return value; + } + + /** + * Returns the backing Svelte store for the given key; potentially sets a default value if the key + * is not already set. + * + * @template T + * + * @param {string} key - Key to lookup in storage API. + * + * @param {T} [defaultValue] - A default value to return if key not present in session storage. + * + * @param {import('./').StorageStores} [storageStores] - Additional store creation options. + * + * @returns {import('svelte/store').Writable} The Svelte store for this key. + */ + getStore(key, defaultValue, storageStores) + { + return this.#getStore(key, defaultValue, storageStores); + } + + /** + * Returns whether a store has already been created for the given key. + * + * @param {string} key - Key to lookup in storage API. + */ + hasStore(key) + { + return this.#stores.has(key); + } + + /** + * Sets the value for the given key in storage API. + * + * @param {string} key - Key to lookup in storage API. + * + * @param {*} value - A value to set for this key. + */ + setItem(key, value) + { + const store = this.#getStore(key); + store.set(value); + } + + /** + * Convenience method to swap a boolean value stored in storage API updating the associated store value. + * + * @param {string} key - Key to lookup in storage API. + * + * @param {boolean} [defaultValue] - A default value to return if key not present in session storage. + * + * @returns {boolean} The boolean swap for the given key. + */ + swapItemBoolean(key, defaultValue) + { + const store = this.#getStore(key, defaultValue); + + let currentValue = false; + + try + { + currentValue = !!this.#getDeserialize(key)(this.#storageStores.storage.getItem(key)); + } + catch (err) { /**/ } + + const newValue = typeof currentValue === 'boolean' ? !currentValue : false; + + store.set(newValue); + return newValue; + } + + // Iterators ------------------------------------------------------------------------------------------------------ + + /** + * @template T + * + * Returns an iterable for the session storage keys and stores. + * + * @param {RegExp} [regex] - Optional regular expression to filter by storage keys. + * + * @returns {IterableIterator<[string, import('svelte/store').Writable]>} Iterable iterator of keys and stores. + * @yields {import('svelte/store').Writable} + */ + *entries(regex = void 0) + { + if (regex !== void 0 && !(regex instanceof RegExp)) { throw new TypeError(`'regex' is not a RegExp`); } + + if (!this.#stores.size) { return void 0; } + + if (regex) + { + for (const key of this.#stores.keys()) + { + if (regex.test(key)) { yield [key, this.getStore(key)]; } + } + } + else + { + for (const key of this.#stores.keys()) { yield [key, this.getStore(key)]; } + } + } + + /** + * Returns an iterable for the session storage keys from existing stores. + * + * @param {RegExp} [regex] - Optional regular expression to filter by storage keys. + * + * @returns {IterableIterator} Iterable iterator of session storage keys. + * @yields {string} + */ + *keys(regex = void 0) + { + if (regex !== void 0 && !(regex instanceof RegExp)) { throw new TypeError(`'regex' is not a RegExp`); } + + if (!this.#stores.size) { return void 0; } + + if (regex) + { + for (const key of this.#stores.keys()) + { + if (regex.test(key)) { yield key; } + } + } + else + { + for (const key of this.#stores.keys()) { yield key; } + } + } + + /** + * @template T + * + * Returns an iterable for the session storage stores. + * + * @param {RegExp} [regex] - Optional regular expression to filter by storage keys. + * + * @returns {IterableIterator>} Iterable iterator of stores. + * @yields {import('svelte/store').Writable} + */ + *stores(regex = void 0) + { + if (regex !== void 0 && !(regex instanceof RegExp)) { throw new TypeError(`'regex' is not a RegExp`); } + + if (!this.#stores.size) { return void 0; } + + if (regex) + { + for (const key of this.#stores.keys()) + { + if (regex.test(key)) { yield this.getStore(key); } + } + } + else + { + for (const key of this.#stores.keys()) { yield this.getStore(key); } + } + } +} + +/** + * Provides a {@link TJSWebStorage} instance for standard browser local storage use cases. + */ +class TJSLocalStorage extends TJSWebStorage +{ + constructor() + { + super(localStores); + } +} + +/** + * Provides a {@link TJSWebStorage} instance for standard browser session storage use cases. + */ +class TJSSessionStorage extends TJSWebStorage +{ + constructor() + { + super(sessionStores); + } +} + +/** + * Provides reactive management of the default theme details elements for session storage and animation controlled by + * local storage settings state. The `main section` and `On This Page` detail elements are paired with a shared key + * such that open / closed state is synchronized. + */ +class DetailsAccordion +{ + /** + * Stores the `toggleDetails` action return / update functions. + * + * @type {import('svelte/action').ActionReturn[]} + */ + static #toggleDetailsActionReturns = []; + + /** + * @type {TJSSessionStorage} + */ + static #detailsSessionStorage = new TJSSessionStorage(); + + /** + * Stores the `On This Page` storage key. + * + * @type {string} + */ + static #onThisPageKey; + + /** + * @returns {TJSSessionStorage} The session storage manager for all details elements. + */ + static get sessionStorage() { return this.#detailsSessionStorage; } + + /** + * @param {DMTComponentData} dmtComponentData - DMT component data. + */ + static initialize(dmtComponentData) + { + globalThis.requestAnimationFrame(() => + { + // Initialize detail element control / handling. + this.#initializeDetails(dmtComponentData.storagePrepend); + + // For any of the setting filter inputs options for source code visibility. When state changes always open + // the `methods` details element. + for (const filterInput of document.querySelectorAll('.tsd-filter-input input')) + { + filterInput.addEventListener('change', () => + { + const methodsKey = `${dmtComponentData.storagePrepend}-accordion-section-otp-Methods`; + + if (this.#detailsSessionStorage.hasStore(methodsKey)) + { + this.#detailsSessionStorage.getStore(methodsKey)?.set(true); + } + }); + } + + // Subscribe to the DMT theme animation setting changing the enabled state for all details elements. + dmtComponentData.settingStores.themeAnimate.subscribe((enabled) => this.#setEnabled(enabled)); + }); + } + + /** + * Opens `On This Page` and potentially focuses summary element. + * + * @param {object} [options] - Optional parameters. + * + * @param {boolean} [options.focus=true] - Focus first internal element. + */ + static openOnThisPage({ focus = true } = {}) + { + /** @type {HTMLDetailsElement} */ + const detailsEl = globalThis.document.querySelector('details.tsd-page-navigation'); + if (detailsEl) + { + const summaryEl = detailsEl.querySelector('summary'); + + if (summaryEl) + { + if (this.#detailsSessionStorage.hasStore(this.#onThisPageKey)) + { + this.#detailsSessionStorage.getStore(this.#onThisPageKey).set(true); + } + + if (focus) { setTimeout(() => summaryEl.focus({ focusVisible: true }), 0); } + } + } + } + + // Internal implementation ---------------------------------------------------------------------------------------- + + static #initializeDetails(storagePrepend) + { + const detailElList = /** @type {NodeListOf} */ document.querySelectorAll( + 'details.tsd-accordion'); + + const detailElMap = new Map(); + + // Add the toggleDetails actions to all default theme detail elements storing the update action. + for (const detailEl of detailElList) + { + const summaryEl = detailEl.querySelector('summary'); + + let key; + + if (summaryEl) + { + key = `${storagePrepend}-accordion-${ + summaryEl.dataset.key ?? + summaryEl.textContent?.trim?.()?.replace(/\s+/g, "-").toLowerCase() + }`; + } + + if (key === `${storagePrepend}-accordion-on-this-page`) { this.#onThisPageKey = key; } + + if (typeof key === 'string' && key.length) { detailElMap.set(key, detailEl); } + } + + // Find matching accordion pairs between `main section` and `On This Page`. + const regex = new RegExp(`${storagePrepend}-accordion-(?section-|tsd-otp-)(?.*)`); + + /** + * @type {Map>} + */ + const pairMaps = new Map(); + + for (const [key, detailEl] of detailElMap) + { + const match = regex.exec(key); + + if (match) + { + // Found a paired detail element. Create unique shared key and store the element. + const pairKey = `${storagePrepend}-accordion-section-otp-${match.groups.key}`; + const pairSet = pairMaps.get(pairKey) ?? new Set(); + + pairSet.add(detailEl); + pairMaps.set(pairKey, pairSet); + } + else + { + // Otherwise hook up a "one off" details element. + const store = this.#detailsSessionStorage.getStore(key, detailEl.open); + this.#toggleDetailsActionReturns.push(toggleDetails(detailEl, { store })); + } + } + + const urlHash = globalThis.location.hash; + + // Hook up paired details elements with the same store / shared key. + for (const [key, detailElSet] of pairMaps) + { + const store = this.#detailsSessionStorage.getStore(key, true); + + // If there is a URL hash check if any child element of details element matches the hash and set the backing + // session store open. This handles the case if the section is closed and the page is reloaded with a hash in + // the closed section ensuring that scrolling to the hash occurs. + if (urlHash) + { + for (const detailEl of detailElSet) + { + const forceOpen = Array.from(detailEl.querySelectorAll('*')).find((child) => `#${child.id}` === urlHash); + if (forceOpen) { store.set(true); } + } + } + + for (const detailEl of detailElSet) + { + this.#toggleDetailsActionReturns.push(toggleDetails(detailEl, { store })); + } + } + + // Add class to provide transition for svg chevron. This is manually added to avoid transform on page load. + setTimeout(() => + { + for (const detailEl of detailElMap.values()) + { + const svgEl = detailEl.querySelector('summary svg'); + if (svgEl) { svgEl.classList.add('dmt-summary-svg'); } + } + }, 500); + } + + /** + * Enables / disables animation for the default theme details elements. + * + * @param {boolean} animate - Current animation state. + */ + static #setEnabled(animate) + { + // Update the toggleDetails actions. + for (const actionReturn of this.#toggleDetailsActionReturns) { actionReturn?.update({ animate }); } + } +} + +/** + * Provides the following global keyboard commands: + * - : Focus main content + * - : Expand / collapse all navigation folders. + * - : Open / close the help panel. + * - : Go to home page / main index.html + * - : If there is a `modules.html` index then go to it. + * - : Scroll to current page in navigation panel and focus it. + * - : If available, focus first anchor in `On This Page` container. + * - : Open main search. + * + * @param {DMTComponentData} dmtComponentData - component data. + */ +function keyCommands(dmtComponentData) +{ + const { + baseURL, + dmtSessionStorage, + pageIndex, + navigation, + stateStores, + storagePrepend } = dmtComponentData; + + // Direct focus target. + globalThis.document.addEventListener('keydown', (event) => + { + if (!event.altKey || event.repeat) { return; } + + switch (event.code) + { + case 'KeyC': + { + const mainContentEl = document.querySelector('.col-content'); + if (mainContentEl) + { + const focusableEl = A11yHelper.getFirstFocusableElement(mainContentEl); + if (focusableEl) { focusableEl.focus({ focusVisible: true }); } + } + event.preventDefault(); + break; + } + + case 'KeyD': + { + // Open / focus document index. + const documentKey = `${storagePrepend}-document-index`; + + if (dmtSessionStorage.hasStore(documentKey)) + { + dmtSessionStorage.getStore(documentKey).set(true); + + // Wait for content to display. + setTimeout(() => + { + /** @type {HTMLDetailsElement} */ + const sectionEl = globalThis.document.querySelector('section.dmt-document-index'); + if (sectionEl) + { + const anchorEl = sectionEl.querySelector('a'); + if (anchorEl) { anchorEl.focus({ focusVisible: true }); } + } + }, 0); + } + + event.preventDefault(); + break; + } + + case 'KeyE': + // Only open / close source folders in source navigation tree state. + navigation.treeState.source.swapFoldersAllOpen(); + + event.preventDefault(); + break; + + case 'KeyH': + stateStores.swapHelpPanelVisible(); + event.preventDefault(); + break; + + case 'KeyI': + globalThis.location.href = `${baseURL}index.html`; + event.preventDefault(); + break; + + case 'KeyM': + if (typeof pageIndex.modules === 'string') + { + globalThis.location.href = `${baseURL}${pageIndex.modules}`; + } + event.preventDefault(); + break; + + case 'KeyN': + { + // Ensure current path is open and focus current path navigation entry. + navigation.treeState.ensureCurrentPath({ focus: true }); + + event.preventDefault(); + break; + } + + case 'KeyO': + { + DetailsAccordion.openOnThisPage(); + event.preventDefault(); + break; + } + + case 'KeyS': + stateStores.mainSearchVisible.set(true); + event.preventDefault(); + break; + + case 'KeyY': + if (typeof pageIndex.hierarchy === 'string') + { + globalThis.location.href = `${baseURL}${pageIndex.hierarchy}`; + } + event.preventDefault(); + break; + } + }); +} + +/** + * This function registers pointer event listeners to programmatically focus the scrolling element beneath the input + * device. This allows keyboard control of the appropriate scrolling container. However, due to this theme being an + * augmentation of the default theme there are some layout aspects we can't control. There isn't a clean separation + * between the left side navigation, main container, and new `On This Page` content scrolling element. In particular + * when entering the `.col-content` element the main `.container-main` element is focused. Due to the left hand + * navigation and `On This Page` element being children of the .container-main` element when programmatically focusing + * a reflow will be triggered. This can't be solved without a rework of the HTML layout. Since this theme is an + * augmentation of the default theme there is only so much that can be done. + * + * The target scrolling elements are set to have a `tabindex` of `-1` in {@link PageRenderer.#augmentGlobal}. There are + * styles in `dmt-theme.scss` to set the outline of the scroll containers to transparent for `:focus-visible`. + * + * While it's nice to have a layout that doesn't reflow so often in practice this is not a performance issue despite the + * warnings that will post in the developer console. This can be fixed with a more hands on rework of the layout which + * is beyond the scope of this theme currently. In other words don't freak out if you see what looks like reflow / + * layout thrashing. It is due to the code below / manual programmatic focusing which serves a purpose and makes for a + * really nice fluid keyboard control. It also allows intuitive start of explicit focus traversal. + */ +function scrollActivation() +{ + // Direct focus target. + const navContainerEl = globalThis.document.querySelector('div.dmt-navigation-content'); + + // Direct focus target / will be null when not on page. + const onThisPageInnerEl = globalThis.document.querySelector('details.tsd-page-navigation .tsd-accordion-details'); + + // Ambient focus target for colContentEl. + const mainContainerEl = globalThis.document.querySelector('div.container.container-main'); + + // Focus targets that activate mainContainerEl. + const colContentEl = globalThis.document.querySelector('div.col-content'); + + /** + * Allow a focus change to occur if any explicitly focused element is one of the following.`null` handles the case + * when there is no current explicitly focused element / result from `querySelector(':focus-visible')`. + * + * @type {Set} + */ + const focusContainers = new Set([mainContainerEl, navContainerEl, onThisPageInnerEl, null]); + + // Direct focus targets ------------------------------------------------------------------------------------------- + + if (navContainerEl) + { + navContainerEl.addEventListener('pointerenter', (event) => + { + event.preventDefault(); + event.stopImmediatePropagation(); + + const explicitlyFocusedEl = globalThis.document.querySelector(':focus-visible'); + + // Abort if the explicitly focused element is not on of the target elements tracked. + if (globalThis.document.activeElement !== navContainerEl && focusContainers.has(explicitlyFocusedEl)) + { + globalThis.requestAnimationFrame(() => navContainerEl.focus({ preventScroll: true })); + } + }); + } + + // Will be null when not on page. + if (onThisPageInnerEl) + { + onThisPageInnerEl.addEventListener('pointerenter', (event) => + { + event.preventDefault(); + event.stopImmediatePropagation(); + + const explicitlyFocusedEl = globalThis.document.querySelector(':focus-visible'); + + // Abort if the explicitly focused element is not on of the target elements tracked. + if (globalThis.document.activeElement !== onThisPageInnerEl && focusContainers.has(explicitlyFocusedEl)) + { + globalThis.requestAnimationFrame(() => onThisPageInnerEl.focus({ preventScroll: true })); + } + }); + } + + // Indirect focus targets / activates mainContainerEl --------------------------------------------------------------- + + if (colContentEl) + { + colContentEl.addEventListener('pointerenter', (event) => + { + event.preventDefault(); + event.stopImmediatePropagation(); + + const explicitlyFocusedEl = globalThis.document.querySelector(':focus-visible'); + + if (globalThis.document.activeElement !== mainContainerEl && focusContainers.has(explicitlyFocusedEl)) + { + globalThis.requestAnimationFrame(() => mainContainerEl.focus({ preventScroll: true })); + } + }); + } +} + +/** + * Awaits `requestAnimationFrame` calls by the counter specified. This allows asynchronous applications for direct / + * inline style modification amongst other direct animation techniques. + * + * @param {number} [cntr=1] - A positive integer greater than 0 for amount of requestAnimationFrames to wait. + * + * @returns {Promise} Returns time of last `requestAnimationFrame` callback. + */ +async function nextAnimationFrame(cntr = 1) +{ + if (!Number.isInteger(cntr) || cntr < 1) + { + throw new TypeError(`nextAnimationFrame error: 'cntr' must be a positive integer greater than 0.`); + } + + let currentTime; + + // Await count of `rAF` callbacks. + for (;--cntr >= 0;) { currentTime = await new Promise((resolve) => requestAnimationFrame(resolve)); } + + return currentTime; +} + +/** + * Provides a basic mechanism to walk and query the TypeDoc `NavigationElement` tree structure. + */ +let NavigationTree$1 = class NavigationTree +{ + /** + * Searches the navigation index for the given path URL and performs the given operation on each tree node from the + * path if found. + * + * @param {import('typedoc').NavigationElement[] } tree - The root tree node to walk. + * + * @param {string} pathURL - The path URL to locate. + * + * @param {import('./types').TreeOperation} operation - Tree entry operation to apply. + * + * @returns {boolean} If the path is found and operation is applied. + */ + static searchPath(tree, pathURL, operation) + { + if (!tree?.length) { return false; } + + // Scan all top level entries first. + for (const entry of tree) + { + if (Array.isArray(entry.children)) { continue; } + + // If the path is found at the top level do nothing and return early. + if (entry?.path === pathURL) { return true; } + } + + // Depth first search for path executing `operation` if found. + for (const entry of tree) + { + if (!Array.isArray(entry.children)) { continue; } + + if (this.#searchPath(entry, pathURL, operation)) { return true; } + } + + return false; + } + + /** + * Recursively walks the navigation index / tree for just tree nodes invoking the given operation. + * + * @param {import('typedoc').NavigationElement[] } tree - The root tree node to walk. + * + * @param {import('./types').TreeOperation} operation - Tree entry operation to apply. + */ + static walk(tree, operation) + { + // Depth first search for path setting a new variable `opened` for all leaves up to path entry. + for (const entry of tree) + { + if (!Array.isArray(entry.children)) { continue; } + + this.#walkPath(entry, void 0, operation); + } + } + + /** + * Recursively walks the navigation index / tree for just tree nodes invoking the given operation from the given + * `entry`. + * + * @param {import('typedoc').NavigationElement} entry - The current entry. + * + * @param {import('./types').TreeOperation} operation - Tree entry operation to apply. + */ + static walkFrom(entry, operation) + { + this.#walkPath(entry, void 0, operation); + } + + // Internal implementation ---------------------------------------------------------------------------------------- + + /** + * Helper function to recursively search for the path and perform the operation given for each tree node. + * + * @param {import('typedoc').NavigationElement} entry - Current NavigationElement. + * + * @param {string} pathURL - The path URL to locate. + * + * @param {import('./types').TreeOperation} operation - Tree entry operation to apply. + * + * @returns {boolean} Whether the path URL matched an entry in this branch. + */ + static #searchPath(entry, pathURL, operation) + { + // If the path matches, return true to indicate the path has been found. + if (entry.path === pathURL) { return true; } + + // If the entry has children, continue the search recursively. + if (Array.isArray(entry.children)) + { + for (const child of entry.children) + { + const found = this.#searchPath(child, pathURL, operation); + if (found) + { + operation({ entry }); + return true; + } + } + } + + // If the path has not been found in this branch, return false. + return false; + } + + /** + * Walks the navigation index / tree for each path recursively. + * + * @param {import('typedoc').NavigationElement} entry - The current entry. + * + * @param {import('typedoc').NavigationElement} parentEntry - The parent entry. + * + * @param {import('./types').TreeOperation} operation - Tree entry operation to apply. + */ + static #walkPath(entry, parentEntry, operation) + { + // If the entry has children, continue the search recursively. + if (Array.isArray(entry.children)) + { + for (const child of entry.children) { this.#walkPath(child, entry, operation); } + } + + operation({ entry, parentEntry }); + } +}; + +/** + * Provides the ability to control and retrieve data for a navigation tree. Each tree has an independent session + * storage manager for all folder open / close state. + */ +class TreeState +{ + /** @type {import('typedoc').NavigationElement[]} */ + #elementIndex; + + /** + * When true there are folders / node entries with children. + * + * @type {boolean} + */ + #hasFolders = false; + + /** + * The navigation session storage store manager. + * + * @type {import('#runtime/svelte/store/web-storage').TJSSessionStorage} + */ + #sessionStorage; + + /** + * Update function for current tree entry path URL. + * + * @type {(url: string, treeName: string) => void} setCurrentPathURL + */ + #setCurrentPathURL; + + /** + * The prepend string for session storage keys. + * + * @type {string} + */ + #storagePrepend; + + /** + * A derived store with the open / close state of all session stores. + * + * @type {import('svelte/store').Readable} + */ + #storeFoldersAllOpen; + + /** + * Stores the tree name. + * + * @type {string} + */ + #treeName; + + /** + * @param {object} options - Options; + * + * @param {string} options.currentPathURL - The initial current path URL. + * + * @param {(url: string, treeName: string) => void} options.setCurrentPathURL - Update function for current tree + * entry path URL. + * + * @param {import('typedoc').NavigationElement[]} options.elementIndex - Navigation element data. + * + * @param {string} options.storagePrepend - The session storage key prepend. + * + * @param {string} options.treeName - The tree name. + */ + constructor({ currentPathURL, setCurrentPathURL, elementIndex, storagePrepend, treeName }) + { + this.#setCurrentPathURL = setCurrentPathURL; + this.#elementIndex = elementIndex; + this.#storagePrepend = storagePrepend; + this.#treeName = treeName; + + this.#sessionStorage = new TJSSessionStorage(); + + this.#setInitialState(currentPathURL); + + this.#createDerivedStores(); + } + + /** + * @returns {import('#frontend/types').DMTNavigationElement[]} The tree element index. + */ + get elementIndex() { return this.#elementIndex; } + + /** + * @returns {boolean} If there is navigation element data available. + */ + get hasData() { return this.#elementIndex?.length > 0; } + + /** + * @returns {boolean} When true there are folders / node entries with children. + */ + get hasFolders() { return this.#hasFolders; } + + /** + * @returns {import('#runtime/svelte/store/web-storage').TJSSessionStorage} The tree folder open / close session + * storage instance. + */ + get sessionStorage() { return this.#sessionStorage; } + + /** + * @returns {import('svelte/store').Readable} A derived store with the open / close state of all session + * stores. + */ + get storeFoldersAllOpen() + { + return this.#storeFoldersAllOpen; + } + + /** + * Finds the child nodes that match the given path URL by a depth first search and recursively finds any associated + * `storageKey` associated with parent tree nodes and sets the session state to open. + * + * @param {string} pathURL - The path URL to locate. + * + * @param {object} [opts] - Optional parameters. + * + * @param {boolean} [opts.setCurrent=true] - If the path is found in the index set it to the current path. + * + * @returns {boolean} If entry for path URL is found and operation applied. + */ + ensureCurrentPath(pathURL, { setCurrent = true } = {}) + { + /** + * Sets `opened` for all entry tree nodes from the path URL given. + * + * @type {import('#shared/types').TreeOperation} + */ + const operation = ({ entry }) => + { + if (entry.storageKey) { this.#sessionStorage.setItem(entry.storageKey, true); } + }; + + const result = NavigationTree$1.searchPath(this.elementIndex, pathURL, operation); + + if (result && setCurrent) { this.#setCurrentPathURL(pathURL, this.#treeName); } + + return result; + } + + /** + * Sets all session storage stores from the given entry. This supports `Alt-` action to open / close all + * child folders. + * + * @param {import('#frontend/types').DMTNavigationElement} fromEntry - The entry to start traversing tree. + * + * @param {boolean} state - New state. + */ + setChildFolderState(fromEntry, state) + { + /** + * @type {import('#shared/types').TreeOperation} + */ + const operation = ({ entry }) => + { + if (entry.storageKey) { this.#sessionStorage.setItem(entry.storageKey, state); } + }; + + NavigationTree$1.walkFrom(fromEntry, operation); + } + + /** + * Closes or opens all tree folders / session store state. + * + * @param {boolean} state - New open / close state. + */ + setFoldersAllOpen(state) + { + for (const store of this.sessionStorage.stores()) { store.set(state); } + } + + /** + * Swaps the current open / close state for all folders / session store state. + */ + swapFoldersAllOpen() + { + this.setFoldersAllOpen(!get_store_value(this.storeFoldersAllOpen)); + } + + // Internal implementation ---------------------------------------------------------------------------------------- + + /** + * Creates derived stores after the navigation tree / index state has been initialized. + */ + #createDerivedStores() + { + // Create a derived store from all session storage stores; on any update reduce all values and set state + // to whether all folders are opened or not. + this.#storeFoldersAllOpen = derived([...this.sessionStorage.stores()], + (stores, set) => set(!!stores.reduce((previous, current) => previous & current, true))); + } + + /** + * Finds the child nodes that match the given path URL by a depth first search and sets the entries session storage + * key to true / opened for all entry tree nodes from the path URL given. This overrides any stored values from + * session storage on initial render ensuring that the current entry is always visible. + * + * @param {string} pathURL - The path URL to locate. + * + * @returns {boolean} If entry for path URL is found and operation applied. + */ + #initializeCurrentPath(pathURL) + { + /** + * Sets entry session storage to true / opened for all entry tree nodes from the path URL given. + * + * @type {import('#shared/types').TreeOperation} + */ + const operation = ({ entry }) => + { + if (entry.storageKey) { this.#sessionStorage.setItem(entry.storageKey, true); } + }; + + return NavigationTree$1.searchPath(this.elementIndex, pathURL, operation); + } + + /** + * Walks the navigation index tree generating session storage / `storageKey` in all tree nodes. + */ + #initializeTree() + { + let topLevelFolders = 0; + + /** + * @type {import('#shared/types').TreeOperation} + */ + const operation = ({ entry, parentEntry }) => + { + if (!parentEntry) { topLevelFolders++; } + + // Set storage key to DMTNavigationEntry. + const parentPath = parentEntry ? parentEntry.path ?? parentEntry.text : ''; + entry.storageKey = `${this.#storagePrepend}-${entry.path ?? `${parentPath}-${entry.text}`}`; + + // Pre-create the session storage stores. + this.#sessionStorage.getStore(entry.storageKey, false); + }; + + NavigationTree$1.walk(this.#elementIndex, operation); + + this.#hasFolders = topLevelFolders > 0; + } + + /** + * Handles setting the initial open state and scrolling the main content div to any hash fragment. + * + * @param {string} currentPathURL - The initial current path URL. + */ + #setInitialState(currentPathURL) + { + this.#initializeTree(); + + // Attempt to set initial current path; there may be a hash fragment. + const initialResult = this.#initializeCurrentPath(currentPathURL); + + if (initialResult) + { + this.#setCurrentPathURL(currentPathURL, this.#treeName); + } + else if (currentPathURL.includes('#')) // Handle the case of a hash fragment. + { + const match = currentPathURL.split('#'); + + // Try setting initial result again with the path URL without the hash fragment. + if (!initialResult) + { + const noHashURL = match[0]; + if (noHashURL && this.#initializeCurrentPath(noHashURL)) + { + this.#setCurrentPathURL(noHashURL, this.#treeName); + } + } + } + } +} + +/** + * Provides the ability to access each navigation tree in addition to managing state for initial opened state for + * entries in any tree and ensuring opened state when URL hash changes occur. + */ +class TreeStateControl +{ + /** + * Stores the active tree name set in `setCurrentPathURL`. + * + * @type {string} + */ + #activeTreeName = ''; + + /** + * The current tree state entry path URL. + * + * @type {string} + */ + #currentPathURL; + + /** + * @type {NavigationData} + */ + #navData; + + /** + * The current tree state entry path URL store. + * + * @type {import('svelte/store').Readable} + */ + #storeCurrentPathURL; + + /** + * @type {import('svelte/store').Updater} + */ + #storeCurrentPathURLUpdate; + + /** + * Markdown document tree state control. + * + * @type {TreeState} + */ + #treeMarkdown; + + /** + * Source tree state control. + * + * @type {TreeState} + */ + #treeSource; + + /** + * @param {NavigationData} navData - NavigationData instance. + * + * @param {DMTComponentData} dmtComponentData - DMT component data. + * + * @param {DMTNavigationIndex} navigationIndex - BCMP navigation index. + */ + constructor(navData, dmtComponentData, navigationIndex) + { + this.#navData = navData; + + this.#currentPathURL = dmtComponentData.initialPathURL; + + const { subscribe, update } = writable(this.#currentPathURL); + + this.#storeCurrentPathURL = Object.freeze({ subscribe }); + this.#storeCurrentPathURLUpdate = update; + + // Retrieve the storage prepend string from global DMT options or use a default key. + const storagePrepend = dmtComponentData.storagePrepend; + + const setCurrentPathURLBound = this.#setCurrentPathURL.bind(this); + + this.#treeMarkdown = new TreeState({ + currentPathURL: this.#currentPathURL, + setCurrentPathURL: setCurrentPathURLBound, + elementIndex: navigationIndex?.markdown ?? [], + storagePrepend: `${storagePrepend}-markdown`, + treeName: 'markdown' + }); + + this.#treeSource = new TreeState({ + currentPathURL: this.#currentPathURL, + setCurrentPathURL: setCurrentPathURLBound, + elementIndex: navigationIndex?.source ?? [], + storagePrepend: `${storagePrepend}-source`, + treeName: 'source' + }); + + // Modify all content links with hash fragments. + this.#hashAnchorLinks(); + + globalThis.addEventListener('hashchange', this.#onHashchange.bind(this)); + } + + /** + * @returns {string} The currently active tree name. + */ + get activeTreeName() + { + return this.#activeTreeName; + } + + /** + * @returns {string} The current tree state entry path URL. + */ + get currentPathURL() + { + return this.#currentPathURL; + } + + /** + * @returns {TreeState} The Markdown document tree state. + */ + get markdown() + { + return this.#treeMarkdown; + } + + /** + * @returns {TreeState} The source code tree state. + */ + get source() + { + return this.#treeSource; + } + + /** + * @returns {import('svelte/store').Readable} The current tree state entry path URL store. + */ + get storeCurrentPathURL() + { + return this.#storeCurrentPathURL; + } + + /** + * Ensures that the current or given path from any navigation tree is open. + * + * @param {object} [options] - Options. + * + * @param {string} [options.pathURL] A new tree entry path URL to select and ensure open. + * + * @param {boolean} [options.focus=false] - Attempt to manually focus the current path entry. + */ + ensureCurrentPath({ pathURL = this.#currentPathURL, focus = false } = {}) + { + let result = false; + + result |= this.#treeMarkdown.ensureCurrentPath(pathURL); + result |= this.#treeSource.ensureCurrentPath(pathURL); + + // Wait for the next animation frame as this will ensure multiple levels of tree nodes opening. + if (result && focus) + { + nextAnimationFrame().then(() => document.querySelector('nav.tsd-navigation')?.querySelector( + `a[href*="${pathURL}"]`)?.focus({ focusVisible: true })); + } + } + + // Internal implementation ---------------------------------------------------------------------------------------- + + /** + * Create custom click handlers for all main content anchors that have a hash fragment. `hashAnchorClick` will + * ensure that the Navigation entry is visible when clicked even if the main URL hash fragment doesn't change. + */ + #hashAnchorLinks() + { + const thisTreeControl = this; + + /** + * Handle any clicks on content anchors with a hash ensuring that the clicked upon anchor is always visible in the + * navigation tree. + * + * @param {PointerEvent} event - + * + * @this {HTMLAnchorElement} + */ + function hashAnchorClick(event) + { + event.preventDefault(); // Prevent the default anchor click behavior. + + const fullURLNoHash = globalThis.location.href.split('#')[0]; + const anchorURLNoHash = this.href.split('#')[0]; + + // If the main URLs or hash differ then set the window location. The `onHashchange` function will trigger. + if (fullURLNoHash !== anchorURLNoHash || globalThis.location.hash !== this.hash) + { + globalThis.location.href = this.href; + return; + } + + // Otherwise a link is clicked and the URL / hash reference is the same as the current page. Ensure that + // the navigation tree shows the current entry. + + const pathURL = this.href.replace(thisTreeControl.#navData.baseURL, ''); + + if (!thisTreeControl.ensureCurrentPath({ pathURL }) && pathURL.includes('#')) + { + // Handle the case where the hash fragment is not in the navigation index. Attempt to ensure current path + // without the hash fragment. + const match = pathURL.split('#'); + + // No hash URL + if (match[0]) + { + thisTreeControl.ensureCurrentPath({ pathURL: match[0] }); + } + } + } + + // Find all anchor links in the main content body and page navigation. + const hashAnchors = document.querySelectorAll( + 'div.col-content a[href*="#"], details.tsd-page-navigation a[href*="#"]'); + + // Add custom hash anchor click handling. + for (const anchorEl of hashAnchors) { anchorEl.addEventListener('click', hashAnchorClick); } + } + + /** + * Updates the session storage state opening all tree nodes to the new URL path. This is added as a listener for + * `hashchange` on `window`. + * + * @param {HashChangeEvent} event - A HashChange event. + */ + #onHashchange(event) + { + const pathURL = event.newURL.replace(this.#navData.baseURL, ''); + + // Ensure any tree nodes are open for `newURLPath`. + if (!this.ensureCurrentPath({ pathURL }) && pathURL.includes('#')) + { + // Handle the case where the hash fragment is not in the navigation index. Attempt to ensure current path + // without the hash fragment. + const noHashURL = pathURL.split('#')[0]; + if (noHashURL) { this.ensureCurrentPath({ pathURL: noHashURL }); } + } + } + + /** + * Sets the current path URL local data and store. + * + * @param {string} pathURL - New current path URL. + * + * @param {string} treeName - The active tree name. + */ + #setCurrentPathURL(pathURL, treeName) + { + switch (treeName) + { + case 'markdown': + case 'source': + this.#activeTreeName = treeName; + break; + default: + this.#activeTreeName = ''; + } + + this.#currentPathURL = pathURL; + this.#storeCurrentPathURLUpdate(() => pathURL); + } +} + +/** + * Provides state and control for all navigation / tree components. + */ +class NavigationData +{ + /** + * Tree state control. + * + * @type {TreeStateControl} + */ + #treeStateControl; + + /** + * @param {DMTComponentData} dmtComponentData - Global component data. + * + * @param {DMTNavigationIndex} navigationIndex - BCMP navigation index. + */ + constructor(dmtComponentData, navigationIndex) + { + this.#treeStateControl = new TreeStateControl(this, dmtComponentData, navigationIndex); + } + + /** + * @returns {TreeStateControl} The tree state control. + */ + get treeState() + { + return this.#treeStateControl; + } +} + +var lunr = {exports: {}}; + /** * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 * Copyright (C) 2020 Oliver Nightingale * @license MIT - */ls=cs,function(){var e,t,n,r,o,s,i,a,l,c,u,f,d,h,p,g,m,y,v,b,w,x,$,S,k,E,T,L,A,C=function(e){var t=new C.Builder;return t.pipeline.add(C.trimmer,C.stopWordFilter,C.stemmer),t.searchPipeline.add(C.stemmer),e.call(t,t),t.build()};C.version="2.3.9", -/*! + */ + +(function (module, exports) { +(function(){ + + /** + * A convenience function for configuring and constructing + * a new lunr Index. + * + * A lunr.Builder instance is created and the pipeline setup + * with a trimmer, stop word filter and stemmer. + * + * This builder object is yielded to the configuration function + * that is passed as a parameter, allowing the list of fields + * and other builder parameters to be customised. + * + * All documents _must_ be added within the passed config function. + * + * @example + * var idx = lunr(function () { + * this.field('title') + * this.field('body') + * this.ref('id') + * + * documents.forEach(function (doc) { + * this.add(doc) + * }, this) + * }) + * + * @see {@link lunr.Builder} + * @see {@link lunr.Pipeline} + * @see {@link lunr.trimmer} + * @see {@link lunr.stopWordFilter} + * @see {@link lunr.stemmer} + * @namespace {function} lunr + */ + var lunr = function (config) { + var builder = new lunr.Builder; + + builder.pipeline.add( + lunr.trimmer, + lunr.stopWordFilter, + lunr.stemmer + ); + + builder.searchPipeline.add( + lunr.stemmer + ); + + config.call(builder, builder); + return builder.build() + }; + + lunr.version = "2.3.9"; + /*! * lunr.utils * Copyright (C) 2020 Oliver Nightingale */ -C.utils={},C.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),C.utils.asString=function(e){return null==e?"":e.toString()},C.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),n=Object.keys(e),r=0;r0){var l=C.utils.clone(t)||{};l.position=[i,a],l.index=o.length,o.push(new C.Token(n.slice(i,s),l))}i=s+1}}return o},C.tokenizer.separator=/[\s\-]+/, -/*! + + /** + * A function for splitting a string into tokens ready to be inserted into + * the search index. Uses `lunr.tokenizer.separator` to split strings, change + * the value of this property to change how strings are split into tokens. + * + * This tokenizer will convert its parameter to a string by calling `toString` and + * then will split this string on the character in `lunr.tokenizer.separator`. + * Arrays will have their elements converted to strings and wrapped in a lunr.Token. + * + * Optional metadata can be passed to the tokenizer, this metadata will be cloned and + * added as metadata to every token that is created from the object to be tokenized. + * + * @static + * @param {?(string|object|object[])} obj - The object to convert into tokens + * @param {?object} metadata - Optional metadata to associate with every token + * @returns {lunr.Token[]} + * @see {@link lunr.Pipeline} + */ + lunr.tokenizer = function (obj, metadata) { + if (obj == null || obj == undefined) { + return [] + } + + if (Array.isArray(obj)) { + return obj.map(function (t) { + return new lunr.Token( + lunr.utils.asString(t).toLowerCase(), + lunr.utils.clone(metadata) + ) + }) + } + + var str = obj.toString().toLowerCase(), + len = str.length, + tokens = []; + + for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) { + var char = str.charAt(sliceEnd), + sliceLength = sliceEnd - sliceStart; + + if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) { + + if (sliceLength > 0) { + var tokenMetadata = lunr.utils.clone(metadata) || {}; + tokenMetadata["position"] = [sliceStart, sliceLength]; + tokenMetadata["index"] = tokens.length; + + tokens.push( + new lunr.Token ( + str.slice(sliceStart, sliceEnd), + tokenMetadata + ) + ); + } + + sliceStart = sliceEnd + 1; + } + + } + + return tokens + }; + + /** + * The separator used to split a string into tokens. Override this property to change the behaviour of + * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens. + * + * @static + * @see lunr.tokenizer + */ + lunr.tokenizer.separator = /[\s\-]+/; + /*! * lunr.Pipeline * Copyright (C) 2020 Oliver Nightingale */ -C.Pipeline=function(){this._stack=[]},C.Pipeline.registeredFunctions=Object.create(null),C.Pipeline.registerFunction=function(e,t){t in this.registeredFunctions&&C.utils.warn("Overwriting existing registered function: "+t),e.label=t,C.Pipeline.registeredFunctions[e.label]=e},C.Pipeline.warnIfFunctionNotRegistered=function(e){e.label&&e.label in this.registeredFunctions||C.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},C.Pipeline.load=function(e){var t=new C.Pipeline;return e.forEach((function(e){var n=C.Pipeline.registeredFunctions[e];if(!n)throw new Error("Cannot load unregistered function: "+e);t.add(n)})),t},C.Pipeline.prototype.add=function(){Array.prototype.slice.call(arguments).forEach((function(e){C.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)}),this)},C.Pipeline.prototype.after=function(e,t){C.Pipeline.warnIfFunctionNotRegistered(t);var n=this._stack.indexOf(e);if(-1==n)throw new Error("Cannot find existingFn");n+=1,this._stack.splice(n,0,t)},C.Pipeline.prototype.before=function(e,t){C.Pipeline.warnIfFunctionNotRegistered(t);var n=this._stack.indexOf(e);if(-1==n)throw new Error("Cannot find existingFn");this._stack.splice(n,0,t)},C.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},C.Pipeline.prototype.run=function(e){for(var t=this._stack.length,n=0;n1&&(se&&(n=o),s!=e);)r=n-t,o=t+Math.floor(r/2),s=this.elements[2*o];return s==e||s>e?2*o:sa?c+=2:i==a&&(t+=n[l+1]*r[c+1],l+=2,c+=2);return t},C.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},C.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,n=0;t 1) { + if (pivotIndex < index) { + start = pivotPoint; + } + + if (pivotIndex > index) { + end = pivotPoint; + } + + if (pivotIndex == index) { + break + } + + sliceLength = end - start; + pivotPoint = start + Math.floor(sliceLength / 2); + pivotIndex = this.elements[pivotPoint * 2]; + } + + if (pivotIndex == index) { + return pivotPoint * 2 + } + + if (pivotIndex > index) { + return pivotPoint * 2 + } + + if (pivotIndex < index) { + return (pivotPoint + 1) * 2 + } + }; + + /** + * Inserts an element at an index within the vector. + * + * Does not allow duplicates, will throw an error if there is already an entry + * for this index. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + */ + lunr.Vector.prototype.insert = function (insertIdx, val) { + this.upsert(insertIdx, val, function () { + throw "duplicate index" + }); + }; + + /** + * Inserts or updates an existing index within the vector. + * + * @param {Number} insertIdx - The index at which the element should be inserted. + * @param {Number} val - The value to be inserted into the vector. + * @param {function} fn - A function that is called for updates, the existing value and the + * requested value are passed as arguments + */ + lunr.Vector.prototype.upsert = function (insertIdx, val, fn) { + this._magnitude = 0; + var position = this.positionForIndex(insertIdx); + + if (this.elements[position] == insertIdx) { + this.elements[position + 1] = fn(this.elements[position + 1], val); + } else { + this.elements.splice(position, 0, insertIdx, val); + } + }; + + /** + * Calculates the magnitude of this vector. + * + * @returns {Number} + */ + lunr.Vector.prototype.magnitude = function () { + if (this._magnitude) return this._magnitude + + var sumOfSquares = 0, + elementsLength = this.elements.length; + + for (var i = 1; i < elementsLength; i += 2) { + var val = this.elements[i]; + sumOfSquares += val * val; + } + + return this._magnitude = Math.sqrt(sumOfSquares) + }; + + /** + * Calculates the dot product of this vector and another vector. + * + * @param {lunr.Vector} otherVector - The vector to compute the dot product with. + * @returns {Number} + */ + lunr.Vector.prototype.dot = function (otherVector) { + var dotProduct = 0, + a = this.elements, b = otherVector.elements, + aLen = a.length, bLen = b.length, + aVal = 0, bVal = 0, + i = 0, j = 0; + + while (i < aLen && j < bLen) { + aVal = a[i], bVal = b[j]; + if (aVal < bVal) { + i += 2; + } else if (aVal > bVal) { + j += 2; + } else if (aVal == bVal) { + dotProduct += a[i + 1] * b[j + 1]; + i += 2; + j += 2; + } + } + + return dotProduct + }; + + /** + * Calculates the similarity between this vector and another vector. + * + * @param {lunr.Vector} otherVector - The other vector to calculate the + * similarity with. + * @returns {Number} + */ + lunr.Vector.prototype.similarity = function (otherVector) { + return this.dot(otherVector) / this.magnitude() || 0 + }; + + /** + * Converts the vector to an array of the elements within the vector. + * + * @returns {Number[]} + */ + lunr.Vector.prototype.toArray = function () { + var output = new Array (this.elements.length / 2); + + for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) { + output[j] = this.elements[i]; + } + + return output + }; + + /** + * A JSON serializable representation of the vector. + * + * @returns {Number[]} + */ + lunr.Vector.prototype.toJSON = function () { + return this.elements + }; + /* eslint-disable */ + /*! * lunr.stemmer * Copyright (C) 2020 Oliver Nightingale * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt */ -C.stemmer=(e={ational:"ate",tional:"tion",enci:"ence",anci:"ance",izer:"ize",bli:"ble",alli:"al",entli:"ent",eli:"e",ousli:"ous",ization:"ize",ation:"ate",ator:"ate",alism:"al",iveness:"ive",fulness:"ful",ousness:"ous",aliti:"al",iviti:"ive",biliti:"ble",logi:"log"},t={icate:"ic",ative:"",alize:"al",iciti:"ic",ical:"ic",ful:"",ness:""},s="^("+(r="[^aeiou][^aeiouy]*")+")?"+(o=(n="[aeiouy]")+"[aeiou]*")+r+"("+o+")?$",i="^("+r+")?"+o+r+o+r,a="^("+r+")?"+n,l=new RegExp("^("+r+")?"+o+r),c=new RegExp(i),u=new RegExp(s),f=new RegExp(a),d=/^(.+?)(ss|i)es$/,h=/^(.+?)([^s])s$/,p=/^(.+?)eed$/,g=/^(.+?)(ed|ing)$/,m=/.$/,y=/(at|bl|iz)$/,v=new RegExp("([^aeiouylsz])\\1$"),b=new RegExp("^"+r+n+"[^aeiouwxy]$"),w=/^(.+?[^aeiou])y$/,x=/^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/,$=/^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/,S=/^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/,k=/^(.+?)(s|t)(ion)$/,E=/^(.+?)e$/,T=/ll$/,L=new RegExp("^"+r+n+"[^aeiouwxy]$"),A=function(n){var r,o,s,i,a,A,C;if(n.length<3)return n;if("y"==(s=n.substr(0,1))&&(n=s.toUpperCase()+n.substr(1)),a=h,(i=d).test(n)?n=n.replace(i,"$1$2"):a.test(n)&&(n=n.replace(a,"$1$2")),a=g,(i=p).test(n)){var I=i.exec(n);(i=l).test(I[1])&&(i=m,n=n.replace(i,""))}else a.test(n)&&(r=(I=a.exec(n))[1],(a=f).test(r)&&(A=v,C=b,(a=y).test(n=r)?n+="e":A.test(n)?(i=m,n=n.replace(i,"")):C.test(n)&&(n+="e")));return(i=w).test(n)&&(n=(r=(I=i.exec(n))[1])+"i"),(i=x).test(n)&&(r=(I=i.exec(n))[1],o=I[2],(i=l).test(r)&&(n=r+e[o])),(i=$).test(n)&&(r=(I=i.exec(n))[1],o=I[2],(i=l).test(r)&&(n=r+t[o])),a=k,(i=S).test(n)?(r=(I=i.exec(n))[1],(i=c).test(r)&&(n=r)):a.test(n)&&(r=(I=a.exec(n))[1]+I[2],(a=c).test(r)&&(n=r)),(i=E).test(n)&&(r=(I=i.exec(n))[1],a=u,A=L,((i=c).test(r)||a.test(r)&&!A.test(r))&&(n=r)),a=c,(i=T).test(n)&&a.test(n)&&(i=m,n=n.replace(i,"")),"y"==s&&(n=s.toLowerCase()+n.substr(1)),n},function(e){return e.update(A)}),C.Pipeline.registerFunction(C.stemmer,"stemmer"), -/*! + + /** + * lunr.stemmer is an english language stemmer, this is a JavaScript + * implementation of the PorterStemmer taken from http://tartarus.org/~martin + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token - The string to stem + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + * @function + */ + lunr.stemmer = (function(){ + var step2list = { + "ational" : "ate", + "tional" : "tion", + "enci" : "ence", + "anci" : "ance", + "izer" : "ize", + "bli" : "ble", + "alli" : "al", + "entli" : "ent", + "eli" : "e", + "ousli" : "ous", + "ization" : "ize", + "ation" : "ate", + "ator" : "ate", + "alism" : "al", + "iveness" : "ive", + "fulness" : "ful", + "ousness" : "ous", + "aliti" : "al", + "iviti" : "ive", + "biliti" : "ble", + "logi" : "log" + }, + + step3list = { + "icate" : "ic", + "ative" : "", + "alize" : "al", + "iciti" : "ic", + "ical" : "ic", + "ful" : "", + "ness" : "" + }, + + c = "[^aeiou]", // consonant + v = "[aeiouy]", // vowel + C = c + "[^aeiouy]*", // consonant sequence + V = v + "[aeiou]*", // vowel sequence + + mgr0 = "^(" + C + ")?" + V + C, // [C]VC... is m>0 + meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$", // [C]VC[V] is m=1 + mgr1 = "^(" + C + ")?" + V + C + V + C, // [C]VCVC... is m>1 + s_v = "^(" + C + ")?" + v; // vowel in stem + + var re_mgr0 = new RegExp(mgr0); + var re_mgr1 = new RegExp(mgr1); + var re_meq1 = new RegExp(meq1); + var re_s_v = new RegExp(s_v); + + var re_1a = /^(.+?)(ss|i)es$/; + var re2_1a = /^(.+?)([^s])s$/; + var re_1b = /^(.+?)eed$/; + var re2_1b = /^(.+?)(ed|ing)$/; + var re_1b_2 = /.$/; + var re2_1b_2 = /(at|bl|iz)$/; + var re3_1b_2 = new RegExp("([^aeiouylsz])\\1$"); + var re4_1b_2 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var re_1c = /^(.+?[^aeiou])y$/; + var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; + + var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; + + var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; + var re2_4 = /^(.+?)(s|t)(ion)$/; + + var re_5 = /^(.+?)e$/; + var re_5_1 = /ll$/; + var re3_5 = new RegExp("^" + C + v + "[^aeiouwxy]$"); + + var porterStemmer = function porterStemmer(w) { + var stem, + suffix, + firstch, + re, + re2, + re3, + re4; + + if (w.length < 3) { return w; } + + firstch = w.substr(0,1); + if (firstch == "y") { + w = firstch.toUpperCase() + w.substr(1); + } + + // Step 1a + re = re_1a; + re2 = re2_1a; + + if (re.test(w)) { w = w.replace(re,"$1$2"); } + else if (re2.test(w)) { w = w.replace(re2,"$1$2"); } + + // Step 1b + re = re_1b; + re2 = re2_1b; + if (re.test(w)) { + var fp = re.exec(w); + re = re_mgr0; + if (re.test(fp[1])) { + re = re_1b_2; + w = w.replace(re,""); + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1]; + re2 = re_s_v; + if (re2.test(stem)) { + w = stem; + re2 = re2_1b_2; + re3 = re3_1b_2; + re4 = re4_1b_2; + if (re2.test(w)) { w = w + "e"; } + else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,""); } + else if (re4.test(w)) { w = w + "e"; } + } + } + + // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say) + re = re_1c; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + w = stem + "i"; + } + + // Step 2 + re = re_2; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step2list[suffix]; + } + } + + // Step 3 + re = re_3; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + suffix = fp[2]; + re = re_mgr0; + if (re.test(stem)) { + w = stem + step3list[suffix]; + } + } + + // Step 4 + re = re_4; + re2 = re2_4; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + if (re.test(stem)) { + w = stem; + } + } else if (re2.test(w)) { + var fp = re2.exec(w); + stem = fp[1] + fp[2]; + re2 = re_mgr1; + if (re2.test(stem)) { + w = stem; + } + } + + // Step 5 + re = re_5; + if (re.test(w)) { + var fp = re.exec(w); + stem = fp[1]; + re = re_mgr1; + re2 = re_meq1; + re3 = re3_5; + if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) { + w = stem; + } + } + + re = re_5_1; + re2 = re_mgr1; + if (re.test(w) && re2.test(w)) { + re = re_1b_2; + w = w.replace(re,""); + } + + // and turn initial Y back to y + + if (firstch == "y") { + w = firstch.toLowerCase() + w.substr(1); + } + + return w; + }; + + return function (token) { + return token.update(porterStemmer); + } + })(); + + lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer'); + /*! * lunr.stopWordFilter * Copyright (C) 2020 Oliver Nightingale */ -C.generateStopWordFilter=function(e){var t=e.reduce((function(e,t){return e[t]=t,e}),{});return function(e){if(e&&t[e.toString()]!==e.toString())return e}},C.stopWordFilter=C.generateStopWordFilter(["a","able","about","across","after","all","almost","also","am","among","an","and","any","are","as","at","be","because","been","but","by","can","cannot","could","dear","did","do","does","either","else","ever","every","for","from","get","got","had","has","have","he","her","hers","him","his","how","however","i","if","in","into","is","it","its","just","least","let","like","likely","may","me","might","most","must","my","neither","no","nor","not","of","off","often","on","only","or","other","our","own","rather","said","say","says","she","should","since","so","some","than","that","the","their","them","then","there","these","they","this","tis","to","too","twas","us","wants","was","we","were","what","when","where","which","while","who","whom","why","will","with","would","yet","you","your"]),C.Pipeline.registerFunction(C.stopWordFilter,"stopWordFilter"), -/*! + + /** + * lunr.generateStopWordFilter builds a stopWordFilter function from the provided + * list of stop words. + * + * The built in lunr.stopWordFilter is built using this generator and can be used + * to generate custom stopWordFilters for applications or non English languages. + * + * @function + * @param {Array} token The token to pass through the filter + * @returns {lunr.PipelineFunction} + * @see lunr.Pipeline + * @see lunr.stopWordFilter + */ + lunr.generateStopWordFilter = function (stopWords) { + var words = stopWords.reduce(function (memo, stopWord) { + memo[stopWord] = stopWord; + return memo + }, {}); + + return function (token) { + if (token && words[token.toString()] !== token.toString()) return token + } + }; + + /** + * lunr.stopWordFilter is an English language stop word list filter, any words + * contained in the list will not be passed through the filter. + * + * This is intended to be used in the Pipeline. If the token does not pass the + * filter then undefined will be returned. + * + * @function + * @implements {lunr.PipelineFunction} + * @params {lunr.Token} token - A token to check for being a stop word. + * @returns {lunr.Token} + * @see {@link lunr.Pipeline} + */ + lunr.stopWordFilter = lunr.generateStopWordFilter([ + 'a', + 'able', + 'about', + 'across', + 'after', + 'all', + 'almost', + 'also', + 'am', + 'among', + 'an', + 'and', + 'any', + 'are', + 'as', + 'at', + 'be', + 'because', + 'been', + 'but', + 'by', + 'can', + 'cannot', + 'could', + 'dear', + 'did', + 'do', + 'does', + 'either', + 'else', + 'ever', + 'every', + 'for', + 'from', + 'get', + 'got', + 'had', + 'has', + 'have', + 'he', + 'her', + 'hers', + 'him', + 'his', + 'how', + 'however', + 'i', + 'if', + 'in', + 'into', + 'is', + 'it', + 'its', + 'just', + 'least', + 'let', + 'like', + 'likely', + 'may', + 'me', + 'might', + 'most', + 'must', + 'my', + 'neither', + 'no', + 'nor', + 'not', + 'of', + 'off', + 'often', + 'on', + 'only', + 'or', + 'other', + 'our', + 'own', + 'rather', + 'said', + 'say', + 'says', + 'she', + 'should', + 'since', + 'so', + 'some', + 'than', + 'that', + 'the', + 'their', + 'them', + 'then', + 'there', + 'these', + 'they', + 'this', + 'tis', + 'to', + 'too', + 'twas', + 'us', + 'wants', + 'was', + 'we', + 'were', + 'what', + 'when', + 'where', + 'which', + 'while', + 'who', + 'whom', + 'why', + 'will', + 'with', + 'would', + 'yet', + 'you', + 'your' + ]); + + lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter'); + /*! * lunr.trimmer * Copyright (C) 2020 Oliver Nightingale */ -C.trimmer=function(e){return e.update((function(e){return e.replace(/^\W+/,"").replace(/\W+$/,"")}))},C.Pipeline.registerFunction(C.trimmer,"trimmer"), -/*! + + /** + * lunr.trimmer is a pipeline function for trimming non word + * characters from the beginning and end of tokens before they + * enter the index. + * + * This implementation may not work correctly for non latin + * characters and should either be removed or adapted for use + * with languages with non-latin characters. + * + * @static + * @implements {lunr.PipelineFunction} + * @param {lunr.Token} token The token to pass through the filter + * @returns {lunr.Token} + * @see lunr.Pipeline + */ + lunr.trimmer = function (token) { + return token.update(function (s) { + return s.replace(/^\W+/, '').replace(/\W+$/, '') + }) + }; + + lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer'); + /*! * lunr.TokenSet * Copyright (C) 2020 Oliver Nightingale */ -C.TokenSet=function(){this.final=!1,this.edges={},this.id=C.TokenSet._nextId,C.TokenSet._nextId+=1},C.TokenSet._nextId=1,C.TokenSet.fromArray=function(e){for(var t=new C.TokenSet.Builder,n=0,r=e.length;n0){var s,i=o.str.charAt(0);i in o.node.edges?s=o.node.edges[i]:(s=new C.TokenSet,o.node.edges[i]=s),1==o.str.length&&(s.final=!0),r.push({node:s,editsRemaining:o.editsRemaining,str:o.str.slice(1)})}if(0!=o.editsRemaining){if("*"in o.node.edges)var a=o.node.edges["*"];else a=new C.TokenSet,o.node.edges["*"]=a;if(0==o.str.length&&(a.final=!0),r.push({node:a,editsRemaining:o.editsRemaining-1,str:o.str}),o.str.length>1&&r.push({node:o.node,editsRemaining:o.editsRemaining-1,str:o.str.slice(1)}),1==o.str.length&&(o.node.final=!0),o.str.length>=1){if("*"in o.node.edges)var l=o.node.edges["*"];else l=new C.TokenSet,o.node.edges["*"]=l;1==o.str.length&&(l.final=!0),r.push({node:l,editsRemaining:o.editsRemaining-1,str:o.str.slice(1)})}if(o.str.length>1){var c,u=o.str.charAt(0),f=o.str.charAt(1);f in o.node.edges?c=o.node.edges[f]:(c=new C.TokenSet,o.node.edges[f]=c),1==o.str.length&&(c.final=!0),r.push({node:c,editsRemaining:o.editsRemaining-1,str:u+o.str.slice(2)})}}}return n},C.TokenSet.fromString=function(e){for(var t=new C.TokenSet,n=t,r=0,o=e.length;r=e;t--){var n=this.uncheckedNodes[t],r=n.child.toString();r in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[r]:(n.child._str=r,this.minimizedNodes[r]=n.child),this.uncheckedNodes.pop()}}, -/*! + + /** + * A token set is used to store the unique list of all tokens + * within an index. Token sets are also used to represent an + * incoming query to the index, this query token set and index + * token set are then intersected to find which tokens to look + * up in the inverted index. + * + * A token set can hold multiple tokens, as in the case of the + * index token set, or it can hold a single token as in the + * case of a simple query token set. + * + * Additionally token sets are used to perform wildcard matching. + * Leading, contained and trailing wildcards are supported, and + * from this edit distance matching can also be provided. + * + * Token sets are implemented as a minimal finite state automata, + * where both common prefixes and suffixes are shared between tokens. + * This helps to reduce the space used for storing the token set. + * + * @constructor + */ + lunr.TokenSet = function () { + this.final = false; + this.edges = {}; + this.id = lunr.TokenSet._nextId; + lunr.TokenSet._nextId += 1; + }; + + /** + * Keeps track of the next, auto increment, identifier to assign + * to a new tokenSet. + * + * TokenSets require a unique identifier to be correctly minimised. + * + * @private + */ + lunr.TokenSet._nextId = 1; + + /** + * Creates a TokenSet instance from the given sorted array of words. + * + * @param {String[]} arr - A sorted array of strings to create the set from. + * @returns {lunr.TokenSet} + * @throws Will throw an error if the input array is not sorted. + */ + lunr.TokenSet.fromArray = function (arr) { + var builder = new lunr.TokenSet.Builder; + + for (var i = 0, len = arr.length; i < len; i++) { + builder.insert(arr[i]); + } + + builder.finish(); + return builder.root + }; + + /** + * Creates a token set from a query clause. + * + * @private + * @param {Object} clause - A single clause from lunr.Query. + * @param {string} clause.term - The query clause term. + * @param {number} [clause.editDistance] - The optional edit distance for the term. + * @returns {lunr.TokenSet} + */ + lunr.TokenSet.fromClause = function (clause) { + if ('editDistance' in clause) { + return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance) + } else { + return lunr.TokenSet.fromString(clause.term) + } + }; + + /** + * Creates a token set representing a single string with a specified + * edit distance. + * + * Insertions, deletions, substitutions and transpositions are each + * treated as an edit distance of 1. + * + * Increasing the allowed edit distance will have a dramatic impact + * on the performance of both creating and intersecting these TokenSets. + * It is advised to keep the edit distance less than 3. + * + * @param {string} str - The string to create the token set from. + * @param {number} editDistance - The allowed edit distance to match. + * @returns {lunr.Vector} + */ + lunr.TokenSet.fromFuzzyString = function (str, editDistance) { + var root = new lunr.TokenSet; + + var stack = [{ + node: root, + editsRemaining: editDistance, + str: str + }]; + + while (stack.length) { + var frame = stack.pop(); + + // no edit + if (frame.str.length > 0) { + var char = frame.str.charAt(0), + noEditNode; + + if (char in frame.node.edges) { + noEditNode = frame.node.edges[char]; + } else { + noEditNode = new lunr.TokenSet; + frame.node.edges[char] = noEditNode; + } + + if (frame.str.length == 1) { + noEditNode.final = true; + } + + stack.push({ + node: noEditNode, + editsRemaining: frame.editsRemaining, + str: frame.str.slice(1) + }); + } + + if (frame.editsRemaining == 0) { + continue + } + + // insertion + if ("*" in frame.node.edges) { + var insertionNode = frame.node.edges["*"]; + } else { + var insertionNode = new lunr.TokenSet; + frame.node.edges["*"] = insertionNode; + } + + if (frame.str.length == 0) { + insertionNode.final = true; + } + + stack.push({ + node: insertionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str + }); + + // deletion + // can only do a deletion if we have enough edits remaining + // and if there are characters left to delete in the string + if (frame.str.length > 1) { + stack.push({ + node: frame.node, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }); + } + + // deletion + // just removing the last character from the str + if (frame.str.length == 1) { + frame.node.final = true; + } + + // substitution + // can only do a substitution if we have enough edits remaining + // and if there are characters left to substitute + if (frame.str.length >= 1) { + if ("*" in frame.node.edges) { + var substitutionNode = frame.node.edges["*"]; + } else { + var substitutionNode = new lunr.TokenSet; + frame.node.edges["*"] = substitutionNode; + } + + if (frame.str.length == 1) { + substitutionNode.final = true; + } + + stack.push({ + node: substitutionNode, + editsRemaining: frame.editsRemaining - 1, + str: frame.str.slice(1) + }); + } + + // transposition + // can only do a transposition if there are edits remaining + // and there are enough characters to transpose + if (frame.str.length > 1) { + var charA = frame.str.charAt(0), + charB = frame.str.charAt(1), + transposeNode; + + if (charB in frame.node.edges) { + transposeNode = frame.node.edges[charB]; + } else { + transposeNode = new lunr.TokenSet; + frame.node.edges[charB] = transposeNode; + } + + if (frame.str.length == 1) { + transposeNode.final = true; + } + + stack.push({ + node: transposeNode, + editsRemaining: frame.editsRemaining - 1, + str: charA + frame.str.slice(2) + }); + } + } + + return root + }; + + /** + * Creates a TokenSet from a string. + * + * The string may contain one or more wildcard characters (*) + * that will allow wildcard matching when intersecting with + * another TokenSet. + * + * @param {string} str - The string to create a TokenSet from. + * @returns {lunr.TokenSet} + */ + lunr.TokenSet.fromString = function (str) { + var node = new lunr.TokenSet, + root = node; + + /* + * Iterates through all characters within the passed string + * appending a node for each character. + * + * When a wildcard character is found then a self + * referencing edge is introduced to continually match + * any number of any characters. + */ + for (var i = 0, len = str.length; i < len; i++) { + var char = str[i], + final = (i == len - 1); + + if (char == "*") { + node.edges[char] = node; + node.final = final; + + } else { + var next = new lunr.TokenSet; + next.final = final; + + node.edges[char] = next; + node = next; + } + } + + return root + }; + + /** + * Converts this TokenSet into an array of strings + * contained within the TokenSet. + * + * This is not intended to be used on a TokenSet that + * contains wildcards, in these cases the results are + * undefined and are likely to cause an infinite loop. + * + * @returns {string[]} + */ + lunr.TokenSet.prototype.toArray = function () { + var words = []; + + var stack = [{ + prefix: "", + node: this + }]; + + while (stack.length) { + var frame = stack.pop(), + edges = Object.keys(frame.node.edges), + len = edges.length; + + if (frame.node.final) { + /* In Safari, at this point the prefix is sometimes corrupted, see: + * https://github.com/olivernn/lunr.js/issues/279 Calling any + * String.prototype method forces Safari to "cast" this string to what + * it's supposed to be, fixing the bug. */ + frame.prefix.charAt(0); + words.push(frame.prefix); + } + + for (var i = 0; i < len; i++) { + var edge = edges[i]; + + stack.push({ + prefix: frame.prefix.concat(edge), + node: frame.node.edges[edge] + }); + } + } + + return words + }; + + /** + * Generates a string representation of a TokenSet. + * + * This is intended to allow TokenSets to be used as keys + * in objects, largely to aid the construction and minimisation + * of a TokenSet. As such it is not designed to be a human + * friendly representation of the TokenSet. + * + * @returns {string} + */ + lunr.TokenSet.prototype.toString = function () { + // NOTE: Using Object.keys here as this.edges is very likely + // to enter 'hash-mode' with many keys being added + // + // avoiding a for-in loop here as it leads to the function + // being de-optimised (at least in V8). From some simple + // benchmarks the performance is comparable, but allowing + // V8 to optimize may mean easy performance wins in the future. + + if (this._str) { + return this._str + } + + var str = this.final ? '1' : '0', + labels = Object.keys(this.edges).sort(), + len = labels.length; + + for (var i = 0; i < len; i++) { + var label = labels[i], + node = this.edges[label]; + + str = str + label + node.id; + } + + return str + }; + + /** + * Returns a new TokenSet that is the intersection of + * this TokenSet and the passed TokenSet. + * + * This intersection will take into account any wildcards + * contained within the TokenSet. + * + * @param {lunr.TokenSet} b - An other TokenSet to intersect with. + * @returns {lunr.TokenSet} + */ + lunr.TokenSet.prototype.intersect = function (b) { + var output = new lunr.TokenSet, + frame = undefined; + + var stack = [{ + qNode: b, + output: output, + node: this + }]; + + while (stack.length) { + frame = stack.pop(); + + // NOTE: As with the #toString method, we are using + // Object.keys and a for loop instead of a for-in loop + // as both of these objects enter 'hash' mode, causing + // the function to be de-optimised in V8 + var qEdges = Object.keys(frame.qNode.edges), + qLen = qEdges.length, + nEdges = Object.keys(frame.node.edges), + nLen = nEdges.length; + + for (var q = 0; q < qLen; q++) { + var qEdge = qEdges[q]; + + for (var n = 0; n < nLen; n++) { + var nEdge = nEdges[n]; + + if (nEdge == qEdge || qEdge == '*') { + var node = frame.node.edges[nEdge], + qNode = frame.qNode.edges[qEdge], + final = node.final && qNode.final, + next = undefined; + + if (nEdge in frame.output.edges) { + // an edge already exists for this character + // no need to create a new node, just set the finality + // bit unless this node is already final + next = frame.output.edges[nEdge]; + next.final = next.final || final; + + } else { + // no edge exists yet, must create one + // set the finality bit and insert it + // into the output + next = new lunr.TokenSet; + next.final = final; + frame.output.edges[nEdge] = next; + } + + stack.push({ + qNode: qNode, + output: next, + node: node + }); + } + } + } + } + + return output + }; + lunr.TokenSet.Builder = function () { + this.previousWord = ""; + this.root = new lunr.TokenSet; + this.uncheckedNodes = []; + this.minimizedNodes = {}; + }; + + lunr.TokenSet.Builder.prototype.insert = function (word) { + var node, + commonPrefix = 0; + + if (word < this.previousWord) { + throw new Error ("Out of order word insertion") + } + + for (var i = 0; i < word.length && i < this.previousWord.length; i++) { + if (word[i] != this.previousWord[i]) break + commonPrefix++; + } + + this.minimize(commonPrefix); + + if (this.uncheckedNodes.length == 0) { + node = this.root; + } else { + node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child; + } + + for (var i = commonPrefix; i < word.length; i++) { + var nextNode = new lunr.TokenSet, + char = word[i]; + + node.edges[char] = nextNode; + + this.uncheckedNodes.push({ + parent: node, + char: char, + child: nextNode + }); + + node = nextNode; + } + + node.final = true; + this.previousWord = word; + }; + + lunr.TokenSet.Builder.prototype.finish = function () { + this.minimize(0); + }; + + lunr.TokenSet.Builder.prototype.minimize = function (downTo) { + for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) { + var node = this.uncheckedNodes[i], + childKey = node.child.toString(); + + if (childKey in this.minimizedNodes) { + node.parent.edges[node.char] = this.minimizedNodes[childKey]; + } else { + // Cache the key for this node since + // we know it can't change anymore + node.child._str = childKey; + + this.minimizedNodes[childKey] = node.child; + } + + this.uncheckedNodes.pop(); + } + }; + /*! * lunr.Index * Copyright (C) 2020 Oliver Nightingale */ -C.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},C.Index.prototype.search=function(e){return this.query((function(t){new C.QueryParser(e,t).parse()}))},C.Index.prototype.query=function(e){for(var t=new C.Query(this.fields),n=Object.create(null),r=Object.create(null),o=Object.create(null),s=Object.create(null),i=Object.create(null),a=0;a} attrs.fieldVectors - Field vectors + * @param {lunr.TokenSet} attrs.tokenSet - An set of all corpus tokens. + * @param {string[]} attrs.fields - The names of indexed document fields. + * @param {lunr.Pipeline} attrs.pipeline - The pipeline to use for search terms. + */ + lunr.Index = function (attrs) { + this.invertedIndex = attrs.invertedIndex; + this.fieldVectors = attrs.fieldVectors; + this.tokenSet = attrs.tokenSet; + this.fields = attrs.fields; + this.pipeline = attrs.pipeline; + }; + + /** + * A result contains details of a document matching a search query. + * @typedef {Object} lunr.Index~Result + * @property {string} ref - The reference of the document this result represents. + * @property {number} score - A number between 0 and 1 representing how similar this document is to the query. + * @property {lunr.MatchData} matchData - Contains metadata about this match including which term(s) caused the match. + */ + + /** + * Although lunr provides the ability to create queries using lunr.Query, it also provides a simple + * query language which itself is parsed into an instance of lunr.Query. + * + * For programmatically building queries it is advised to directly use lunr.Query, the query language + * is best used for human entered text rather than program generated text. + * + * At its simplest queries can just be a single term, e.g. `hello`, multiple terms are also supported + * and will be combined with OR, e.g `hello world` will match documents that contain either 'hello' + * or 'world', though those that contain both will rank higher in the results. + * + * Wildcards can be included in terms to match one or more unspecified characters, these wildcards can + * be inserted anywhere within the term, and more than one wildcard can exist in a single term. Adding + * wildcards will increase the number of documents that will be found but can also have a negative + * impact on query performance, especially with wildcards at the beginning of a term. + * + * Terms can be restricted to specific fields, e.g. `title:hello`, only documents with the term + * hello in the title field will match this query. Using a field not present in the index will lead + * to an error being thrown. + * + * Modifiers can also be added to terms, lunr supports edit distance and boost modifiers on terms. A term + * boost will make documents matching that term score higher, e.g. `foo^5`. Edit distance is also supported + * to provide fuzzy matching, e.g. 'hello~2' will match documents with hello with an edit distance of 2. + * Avoid large values for edit distance to improve query performance. + * + * Each term also supports a presence modifier. By default a term's presence in document is optional, however + * this can be changed to either required or prohibited. For a term's presence to be required in a document the + * term should be prefixed with a '+', e.g. `+foo bar` is a search for documents that must contain 'foo' and + * optionally contain 'bar'. Conversely a leading '-' sets the terms presence to prohibited, i.e. it must not + * appear in a document, e.g. `-foo bar` is a search for documents that do not contain 'foo' but may contain 'bar'. + * + * To escape special characters the backslash character '\' can be used, this allows searches to include + * characters that would normally be considered modifiers, e.g. `foo\~2` will search for a term "foo~2" instead + * of attempting to apply a boost of 2 to the search term "foo". + * + * @typedef {string} lunr.Index~QueryString + * @example Simple single term query + * hello + * @example Multiple term query + * hello world + * @example term scoped to a field + * title:hello + * @example term with a boost of 10 + * hello^10 + * @example term with an edit distance of 2 + * hello~2 + * @example terms with presence modifiers + * -foo +bar baz + */ + + /** + * Performs a search against the index using lunr query syntax. + * + * Results will be returned sorted by their score, the most relevant results + * will be returned first. For details on how the score is calculated, please see + * the {@link https://lunrjs.com/guides/searching.html#scoring|guide}. + * + * For more programmatic querying use lunr.Index#query. + * + * @param {lunr.Index~QueryString} queryString - A string containing a lunr query. + * @throws {lunr.QueryParseError} If the passed query string cannot be parsed. + * @returns {lunr.Index~Result[]} + */ + lunr.Index.prototype.search = function (queryString) { + return this.query(function (query) { + var parser = new lunr.QueryParser(queryString, query); + parser.parse(); + }) + }; + + /** + * A query builder callback provides a query object to be used to express + * the query to perform on the index. + * + * @callback lunr.Index~queryBuilder + * @param {lunr.Query} query - The query object to build up. + * @this lunr.Query + */ + + /** + * Performs a query against the index using the yielded lunr.Query object. + * + * If performing programmatic queries against the index, this method is preferred + * over lunr.Index#search so as to avoid the additional query parsing overhead. + * + * A query object is yielded to the supplied function which should be used to + * express the query to be run against the index. + * + * Note that although this function takes a callback parameter it is _not_ an + * asynchronous operation, the callback is just yielded a query object to be + * customized. + * + * @param {lunr.Index~queryBuilder} fn - A function that is used to build the query. + * @returns {lunr.Index~Result[]} + */ + lunr.Index.prototype.query = function (fn) { + // for each query clause + // * process terms + // * expand terms from token set + // * find matching documents and metadata + // * get document vectors + // * score documents + + var query = new lunr.Query(this.fields), + matchingFields = Object.create(null), + queryVectors = Object.create(null), + termFieldCache = Object.create(null), + requiredMatches = Object.create(null), + prohibitedMatches = Object.create(null); + + /* + * To support field level boosts a query vector is created per + * field. An empty vector is eagerly created to support negated + * queries. + */ + for (var i = 0; i < this.fields.length; i++) { + queryVectors[this.fields[i]] = new lunr.Vector; + } + + fn.call(query, query); + + for (var i = 0; i < query.clauses.length; i++) { + /* + * Unless the pipeline has been disabled for this term, which is + * the case for terms with wildcards, we need to pass the clause + * term through the search pipeline. A pipeline returns an array + * of processed terms. Pipeline functions may expand the passed + * term, which means we may end up performing multiple index lookups + * for a single query term. + */ + var clause = query.clauses[i], + terms = null, + clauseMatches = lunr.Set.empty; + + if (clause.usePipeline) { + terms = this.pipeline.runString(clause.term, { + fields: clause.fields + }); + } else { + terms = [clause.term]; + } + + for (var m = 0; m < terms.length; m++) { + var term = terms[m]; + + /* + * Each term returned from the pipeline needs to use the same query + * clause object, e.g. the same boost and or edit distance. The + * simplest way to do this is to re-use the clause object but mutate + * its term property. + */ + clause.term = term; + + /* + * From the term in the clause we create a token set which will then + * be used to intersect the indexes token set to get a list of terms + * to lookup in the inverted index + */ + var termTokenSet = lunr.TokenSet.fromClause(clause), + expandedTerms = this.tokenSet.intersect(termTokenSet).toArray(); + + /* + * If a term marked as required does not exist in the tokenSet it is + * impossible for the search to return any matches. We set all the field + * scoped required matches set to empty and stop examining any further + * clauses. + */ + if (expandedTerms.length === 0 && clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k]; + requiredMatches[field] = lunr.Set.empty; + } + + break + } + + for (var j = 0; j < expandedTerms.length; j++) { + /* + * For each term get the posting and termIndex, this is required for + * building the query vector. + */ + var expandedTerm = expandedTerms[j], + posting = this.invertedIndex[expandedTerm], + termIndex = posting._index; + + for (var k = 0; k < clause.fields.length; k++) { + /* + * For each field that this query term is scoped by (by default + * all fields are in scope) we need to get all the document refs + * that have this term in that field. + * + * The posting is the entry in the invertedIndex for the matching + * term from above. + */ + var field = clause.fields[k], + fieldPosting = posting[field], + matchingDocumentRefs = Object.keys(fieldPosting), + termField = expandedTerm + "/" + field, + matchingDocumentsSet = new lunr.Set(matchingDocumentRefs); + + /* + * if the presence of this term is required ensure that the matching + * documents are added to the set of required matches for this clause. + * + */ + if (clause.presence == lunr.Query.presence.REQUIRED) { + clauseMatches = clauseMatches.union(matchingDocumentsSet); + + if (requiredMatches[field] === undefined) { + requiredMatches[field] = lunr.Set.complete; + } + } + + /* + * if the presence of this term is prohibited ensure that the matching + * documents are added to the set of prohibited matches for this field, + * creating that set if it does not yet exist. + */ + if (clause.presence == lunr.Query.presence.PROHIBITED) { + if (prohibitedMatches[field] === undefined) { + prohibitedMatches[field] = lunr.Set.empty; + } + + prohibitedMatches[field] = prohibitedMatches[field].union(matchingDocumentsSet); + + /* + * Prohibited matches should not be part of the query vector used for + * similarity scoring and no metadata should be extracted so we continue + * to the next field + */ + continue + } + + /* + * The query field vector is populated using the termIndex found for + * the term and a unit value with the appropriate boost applied. + * Using upsert because there could already be an entry in the vector + * for the term we are working with. In that case we just add the scores + * together. + */ + queryVectors[field].upsert(termIndex, clause.boost, function (a, b) { return a + b }); + + /** + * If we've already seen this term, field combo then we've already collected + * the matching documents and metadata, no need to go through all that again + */ + if (termFieldCache[termField]) { + continue + } + + for (var l = 0; l < matchingDocumentRefs.length; l++) { + /* + * All metadata for this term/field/document triple + * are then extracted and collected into an instance + * of lunr.MatchData ready to be returned in the query + * results + */ + var matchingDocumentRef = matchingDocumentRefs[l], + matchingFieldRef = new lunr.FieldRef (matchingDocumentRef, field), + metadata = fieldPosting[matchingDocumentRef], + fieldMatch; + + if ((fieldMatch = matchingFields[matchingFieldRef]) === undefined) { + matchingFields[matchingFieldRef] = new lunr.MatchData (expandedTerm, field, metadata); + } else { + fieldMatch.add(expandedTerm, field, metadata); + } + + } + + termFieldCache[termField] = true; + } + } + } + + /** + * If the presence was required we need to update the requiredMatches field sets. + * We do this after all fields for the term have collected their matches because + * the clause terms presence is required in _any_ of the fields not _all_ of the + * fields. + */ + if (clause.presence === lunr.Query.presence.REQUIRED) { + for (var k = 0; k < clause.fields.length; k++) { + var field = clause.fields[k]; + requiredMatches[field] = requiredMatches[field].intersect(clauseMatches); + } + } + } + + /** + * Need to combine the field scoped required and prohibited + * matching documents into a global set of required and prohibited + * matches + */ + var allRequiredMatches = lunr.Set.complete, + allProhibitedMatches = lunr.Set.empty; + + for (var i = 0; i < this.fields.length; i++) { + var field = this.fields[i]; + + if (requiredMatches[field]) { + allRequiredMatches = allRequiredMatches.intersect(requiredMatches[field]); + } + + if (prohibitedMatches[field]) { + allProhibitedMatches = allProhibitedMatches.union(prohibitedMatches[field]); + } + } + + var matchingFieldRefs = Object.keys(matchingFields), + results = [], + matches = Object.create(null); + + /* + * If the query is negated (contains only prohibited terms) + * we need to get _all_ fieldRefs currently existing in the + * index. This is only done when we know that the query is + * entirely prohibited terms to avoid any cost of getting all + * fieldRefs unnecessarily. + * + * Additionally, blank MatchData must be created to correctly + * populate the results. + */ + if (query.isNegated()) { + matchingFieldRefs = Object.keys(this.fieldVectors); + + for (var i = 0; i < matchingFieldRefs.length; i++) { + var matchingFieldRef = matchingFieldRefs[i]; + var fieldRef = lunr.FieldRef.fromString(matchingFieldRef); + matchingFields[matchingFieldRef] = new lunr.MatchData; + } + } + + for (var i = 0; i < matchingFieldRefs.length; i++) { + /* + * Currently we have document fields that match the query, but we + * need to return documents. The matchData and scores are combined + * from multiple fields belonging to the same document. + * + * Scores are calculated by field, using the query vectors created + * above, and combined into a final document score using addition. + */ + var fieldRef = lunr.FieldRef.fromString(matchingFieldRefs[i]), + docRef = fieldRef.docRef; + + if (!allRequiredMatches.contains(docRef)) { + continue + } + + if (allProhibitedMatches.contains(docRef)) { + continue + } + + var fieldVector = this.fieldVectors[fieldRef], + score = queryVectors[fieldRef.fieldName].similarity(fieldVector), + docMatch; + + if ((docMatch = matches[docRef]) !== undefined) { + docMatch.score += score; + docMatch.matchData.combine(matchingFields[fieldRef]); + } else { + var match = { + ref: docRef, + score: score, + matchData: matchingFields[fieldRef] + }; + matches[docRef] = match; + results.push(match); + } + } + + /* + * Sort the results objects by score, highest first. + */ + return results.sort(function (a, b) { + return b.score - a.score + }) + }; + + /** + * Prepares the index for JSON serialization. + * + * The schema for this JSON blob will be described in a + * separate JSON schema file. + * + * @returns {Object} + */ + lunr.Index.prototype.toJSON = function () { + var invertedIndex = Object.keys(this.invertedIndex) + .sort() + .map(function (term) { + return [term, this.invertedIndex[term]] + }, this); + + var fieldVectors = Object.keys(this.fieldVectors) + .map(function (ref) { + return [ref, this.fieldVectors[ref].toJSON()] + }, this); + + return { + version: lunr.version, + fields: this.fields, + fieldVectors: fieldVectors, + invertedIndex: invertedIndex, + pipeline: this.pipeline.toJSON() + } + }; + + /** + * Loads a previously serialized lunr.Index + * + * @param {Object} serializedIndex - A previously serialized lunr.Index + * @returns {lunr.Index} + */ + lunr.Index.load = function (serializedIndex) { + var attrs = {}, + fieldVectors = {}, + serializedVectors = serializedIndex.fieldVectors, + invertedIndex = Object.create(null), + serializedInvertedIndex = serializedIndex.invertedIndex, + tokenSetBuilder = new lunr.TokenSet.Builder, + pipeline = lunr.Pipeline.load(serializedIndex.pipeline); + + if (serializedIndex.version != lunr.version) { + lunr.utils.warn("Version mismatch when loading serialised index. Current version of lunr '" + lunr.version + "' does not match serialized index '" + serializedIndex.version + "'"); + } + + for (var i = 0; i < serializedVectors.length; i++) { + var tuple = serializedVectors[i], + ref = tuple[0], + elements = tuple[1]; + + fieldVectors[ref] = new lunr.Vector(elements); + } + + for (var i = 0; i < serializedInvertedIndex.length; i++) { + var tuple = serializedInvertedIndex[i], + term = tuple[0], + posting = tuple[1]; + + tokenSetBuilder.insert(term); + invertedIndex[term] = posting; + } + + tokenSetBuilder.finish(); + + attrs.fields = serializedIndex.fields; + + attrs.fieldVectors = fieldVectors; + attrs.invertedIndex = invertedIndex; + attrs.tokenSet = tokenSetBuilder.root; + attrs.pipeline = pipeline; + + return new lunr.Index(attrs) + }; + /*! * lunr.Builder * Copyright (C) 2020 Oliver Nightingale */ -C.Builder=function(){this._ref="id",this._fields=Object.create(null),this._documents=Object.create(null),this.invertedIndex=Object.create(null),this.fieldTermFrequencies={},this.fieldLengths={},this.tokenizer=C.tokenizer,this.pipeline=new C.Pipeline,this.searchPipeline=new C.Pipeline,this.documentCount=0,this._b=.75,this._k1=1.2,this.termIndex=0,this.metadataWhitelist=[]},C.Builder.prototype.ref=function(e){this._ref=e},C.Builder.prototype.field=function(e,t){if(/\//.test(e))throw new RangeError("Field '"+e+"' contains illegal character '/'");this._fields[e]=t||{}},C.Builder.prototype.b=function(e){this._b=e<0?0:e>1?1:e},C.Builder.prototype.k1=function(e){this._k1=e},C.Builder.prototype.add=function(e,t){var n=e[this._ref],r=Object.keys(this._fields);this._documents[n]=t||{},this.documentCount+=1;for(var o=0;o=this.length)return C.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},C.QueryLexer.prototype.width=function(){return this.pos-this.start},C.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},C.QueryLexer.prototype.backup=function(){this.pos-=1},C.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=C.QueryLexer.EOS&&this.backup()},C.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(C.QueryLexer.TERM)),e.ignore(),e.more())return C.QueryLexer.lexText},C.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(C.QueryLexer.EDIT_DISTANCE),C.QueryLexer.lexText},C.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(C.QueryLexer.BOOST),C.QueryLexer.lexText},C.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(C.QueryLexer.TERM)},C.QueryLexer.termSeparator=C.tokenizer.separator,C.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==C.QueryLexer.EOS)return C.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return C.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(C.QueryLexer.TERM),C.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(C.QueryLexer.TERM),C.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(C.QueryLexer.PRESENCE),C.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(C.QueryLexer.PRESENCE),C.QueryLexer.lexText;if(t.match(C.QueryLexer.termSeparator))return C.QueryLexer.lexTerm}else e.escapeCharacter()}},C.QueryParser=function(e,t){this.lexer=new C.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},C.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=C.QueryParser.parseClause;e;)e=e(this);return this.query},C.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},C.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},C.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},C.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case C.QueryLexer.PRESENCE:return C.QueryParser.parsePresence;case C.QueryLexer.FIELD:return C.QueryParser.parseField;case C.QueryLexer.TERM:return C.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+t.type;throw t.str.length>=1&&(n+=" with value '"+t.str+"'"),new C.QueryParseError(n,t.start,t.end)}},C.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=C.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=C.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+t.str+"'";throw new C.QueryParseError(n,t.start,t.end)}var r=e.peekLexeme();if(null==r)throw n="expecting term or field, found nothing",new C.QueryParseError(n,t.start,t.end);switch(r.type){case C.QueryLexer.FIELD:return C.QueryParser.parseField;case C.QueryLexer.TERM:return C.QueryParser.parseTerm;default:throw n="expecting term or field, found '"+r.type+"'",new C.QueryParseError(n,r.start,r.end)}}},C.QueryParser.parseField=function(e){var t=e.consumeLexeme();if(null!=t){if(-1==e.query.allFields.indexOf(t.str)){var n=e.query.allFields.map((function(e){return"'"+e+"'"})).join(", "),r="unrecognised field '"+t.str+"', possible fields: "+n;throw new C.QueryParseError(r,t.start,t.end)}e.currentClause.fields=[t.str];var o=e.peekLexeme();if(null==o)throw r="expecting term, found nothing",new C.QueryParseError(r,t.start,t.end);if(o.type===C.QueryLexer.TERM)return C.QueryParser.parseTerm;throw r="expecting term, found '"+o.type+"'",new C.QueryParseError(r,o.start,o.end)}},C.QueryParser.parseTerm=function(e){var t=e.consumeLexeme();if(null!=t){e.currentClause.term=t.str.toLowerCase(),-1!=t.str.indexOf("*")&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(null!=n)switch(n.type){case C.QueryLexer.TERM:return e.nextClause(),C.QueryParser.parseTerm;case C.QueryLexer.FIELD:return e.nextClause(),C.QueryParser.parseField;case C.QueryLexer.EDIT_DISTANCE:return C.QueryParser.parseEditDistance;case C.QueryLexer.BOOST:return C.QueryParser.parseBoost;case C.QueryLexer.PRESENCE:return e.nextClause(),C.QueryParser.parsePresence;default:var r="Unexpected lexeme type '"+n.type+"'";throw new C.QueryParseError(r,n.start,n.end)}else e.nextClause()}},C.QueryParser.parseEditDistance=function(e){var t=e.consumeLexeme();if(null!=t){var n=parseInt(t.str,10);if(isNaN(n)){var r="edit distance must be numeric";throw new C.QueryParseError(r,t.start,t.end)}e.currentClause.editDistance=n;var o=e.peekLexeme();if(null!=o)switch(o.type){case C.QueryLexer.TERM:return e.nextClause(),C.QueryParser.parseTerm;case C.QueryLexer.FIELD:return e.nextClause(),C.QueryParser.parseField;case C.QueryLexer.EDIT_DISTANCE:return C.QueryParser.parseEditDistance;case C.QueryLexer.BOOST:return C.QueryParser.parseBoost;case C.QueryLexer.PRESENCE:return e.nextClause(),C.QueryParser.parsePresence;default:throw r="Unexpected lexeme type '"+o.type+"'",new C.QueryParseError(r,o.start,o.end)}else e.nextClause()}},C.QueryParser.parseBoost=function(e){var t=e.consumeLexeme();if(null!=t){var n=parseInt(t.str,10);if(isNaN(n)){var r="boost must be numeric";throw new C.QueryParseError(r,t.start,t.end)}e.currentClause.boost=n;var o=e.peekLexeme();if(null!=o)switch(o.type){case C.QueryLexer.TERM:return e.nextClause(),C.QueryParser.parseTerm;case C.QueryLexer.FIELD:return e.nextClause(),C.QueryParser.parseField;case C.QueryLexer.EDIT_DISTANCE:return C.QueryParser.parseEditDistance;case C.QueryLexer.BOOST:return C.QueryParser.parseBoost;case C.QueryLexer.PRESENCE:return e.nextClause(),C.QueryParser.parsePresence;default:throw r="Unexpected lexeme type '"+o.type+"'",new C.QueryParseError(r,o.start,o.end)}else e.nextClause()}},ls.exports=C}();var us=cs.exports;globalThis.dmtInflateAndUnpack=function(e,{inflateOptions:t}={}){return Z(Ke(e,t))},globalThis.dmtInflateAndUnpackB64=function(e,{inflateOptions:t}={}){return Z(Ke(st(it(e)),t))};const fs="string"==typeof globalThis.dmtComponentDataBCMP?globalThis.dmtInflateAndUnpackB64(globalThis.dmtComponentDataBCMP):{};fs.baseURL=import.meta.url.replace(/assets\/dmt\/dmt-components.js/,""),fs.dmtURL=import.meta.url.replace(/dmt-components.js/,""),fs.initialPathURL=globalThis.location.href.replace(fs.baseURL,"");const ds=(fs.initialPathURL.match(/\//)??[]).length;fs.basePath="../".repeat(ds),fs.navigationData=new class{basePath;baseURL;currentPathURL;storeCurrentPathURL;dmtSessionStorage;index;initialPathURL;state;storagePrepend;storeHelpPanelOpen=Hn(!1);storeSessionAllOpen;storeTopLevelNodes=Hn(0);constructor(e){this.basePath=e.basePath,this.baseURL=e.baseURL,this.initialPathURL=e.initialPathURL,this.index=e.navigationIndex,this.storagePrepend=e.storagePrepend??"docs-unnamed",this.dmtSessionStorage=new Gn,this.currentPathURL=this.initialPathURL,this.storeCurrentPathURL=Hn(this.initialPathURL),this.state=new ko(this),this.#k()}#k(){this.storeSessionAllOpen=Vn([...this.dmtSessionStorage.stores()],((e,t)=>t(!!e.reduce(((e,t)=>e&t),!0))))}setStoresAllOpen(e){for(const t of this.dmtSessionStorage.stores())t.set(e)}setCurrentPathURL(e){this.currentPathURL=e,this.storeCurrentPathURL.set(e)}}(fs),fs.dmtLocalStorage=new class extends Jn{constructor(){super(Wn)}};const hs=new Io({target:document.querySelector(".tsd-navigation.settings .tsd-accordion-details"),props:{dmtComponentData:fs}}),ps=document.querySelector("nav#tsd-sidebar-links");ps&&ps.remove();const gs=document.querySelector("nav.tsd-navigation");if(gs&&gs.firstChild)for(;gs.firstChild;)gs.removeChild(gs.firstChild);const ms=new So({target:document.querySelector("nav.tsd-navigation"),props:{dmtComponentData:fs}}),ys=new Uo({target:document.querySelector("#dmt-toolbar"),props:{dmtComponentData:fs}});globalThis.dmtComponents={dmtSettings:hs,navigation:ms,toolbar:ys},fs.search&&(!async function(){const e=import.meta.url.replace(/\/dmt-components.js/,""),t=await fetch(`${e}/dmt-search.cmp`);if(!t.ok)return console.warn("[typedoc-theme-default-modern] Could not load search index."),!1;try{const e=await t.arrayBuffer(),n=globalThis.dmtInflateAndUnpack(new Uint8Array(e));globalThis.dmtSearchMainRows=n.rows,globalThis.dmtSearchMainIndex=us.Index.load(n.index)}catch(e){return console.warn("[typedoc-theme-default-modern] Could not load search index."),console.error(e),!1}}(),globalThis.dmtComponents.searchMain=new as({target:document.querySelector("#dmt-search-main"),props:{dmtComponentData:fs}})),function(e){const{hasModulesIndex:t,navigationData:n}=e;globalThis.document.addEventListener("keydown",(e=>{if(e.altKey&&!e.repeat)switch(e.code){case"KeyC":{const t=document.querySelector(".col-content");if(t){const e=Xn.getFirstFocusableElement(t);e&&e.focus({focusVisible:!0})}e.preventDefault();break}case"KeyE":n.setStoresAllOpen(!vt(n.storeSessionAllOpen)),e.preventDefault();break;case"KeyH":n.storeHelpPanelOpen.set(!vt(n.storeHelpPanelOpen)),e.preventDefault();break;case"KeyI":window.location.href=`${n.baseURL}index.html`,e.preventDefault();break;case"KeyM":t&&(window.location.href=`${n.baseURL}modules.html`),e.preventDefault();break;case"KeyN":{const t=n.currentPathURL;n.state.ensureCurrentPath(n.currentPathURL),er().then((()=>document.querySelector("nav.tsd-navigation")?.querySelector(`a[href*="${t}"]`)?.focus({focusVisible:!0}))),e.preventDefault();break}case"KeyO":{const t=globalThis.document.querySelector("details.tsd-page-navigation");if(t){const e=t.querySelector("a");e&&(t.open=!0,setTimeout((()=>e.focus({focusVisible:!0})),0))}e.preventDefault();break}}}))}(fs),function(){const e=globalThis.document.querySelector("div.dmt-navigation-content"),t=globalThis.document.querySelector("details.tsd-page-navigation .tsd-accordion-details"),n=globalThis.document.querySelector("div.container.container-main"),r=globalThis.document.querySelector("div.col-content"),o=new Set([n,e,t,null]);e&&e.addEventListener("pointerenter",(t=>{t.preventDefault(),t.stopImmediatePropagation();const n=globalThis.document.querySelector(":focus-visible");globalThis.document.activeElement!==e&&o.has(n)&&globalThis.requestAnimationFrame((()=>e.focus({preventScroll:!0})))})),t&&t.addEventListener("pointerenter",(e=>{e.preventDefault(),e.stopImmediatePropagation();const n=globalThis.document.querySelector(":focus-visible");globalThis.document.activeElement!==t&&o.has(n)&&globalThis.requestAnimationFrame((()=>t.focus({preventScroll:!0})))})),r&&r.addEventListener("pointerenter",(e=>{e.preventDefault(),e.stopImmediatePropagation();const t=globalThis.document.querySelector(":focus-visible");globalThis.document.activeElement!==n&&o.has(t)&&globalThis.requestAnimationFrame((()=>n.focus({preventScroll:!0})))}))}(),globalThis.requestAnimationFrame((()=>{const e=document.createElement("style");e.innerHTML="body { visibility: visible; }",document.head.appendChild(e)})); + + /** + * lunr.Builder performs indexing on a set of documents and + * returns instances of lunr.Index ready for querying. + * + * All configuration of the index is done via the builder, the + * fields to index, the document reference, the text processing + * pipeline and document scoring parameters are all set on the + * builder before indexing. + * + * @constructor + * @property {string} _ref - Internal reference to the document reference field. + * @property {string[]} _fields - Internal reference to the document fields to index. + * @property {object} invertedIndex - The inverted index maps terms to document fields. + * @property {object} documentTermFrequencies - Keeps track of document term frequencies. + * @property {object} documentLengths - Keeps track of the length of documents added to the index. + * @property {lunr.tokenizer} tokenizer - Function for splitting strings into tokens for indexing. + * @property {lunr.Pipeline} pipeline - The pipeline performs text processing on tokens before indexing. + * @property {lunr.Pipeline} searchPipeline - A pipeline for processing search terms before querying the index. + * @property {number} documentCount - Keeps track of the total number of documents indexed. + * @property {number} _b - A parameter to control field length normalization, setting this to 0 disabled normalization, 1 fully normalizes field lengths, the default value is 0.75. + * @property {number} _k1 - A parameter to control how quickly an increase in term frequency results in term frequency saturation, the default value is 1.2. + * @property {number} termIndex - A counter incremented for each unique term, used to identify a terms position in the vector space. + * @property {array} metadataWhitelist - A list of metadata keys that have been whitelisted for entry in the index. + */ + lunr.Builder = function () { + this._ref = "id"; + this._fields = Object.create(null); + this._documents = Object.create(null); + this.invertedIndex = Object.create(null); + this.fieldTermFrequencies = {}; + this.fieldLengths = {}; + this.tokenizer = lunr.tokenizer; + this.pipeline = new lunr.Pipeline; + this.searchPipeline = new lunr.Pipeline; + this.documentCount = 0; + this._b = 0.75; + this._k1 = 1.2; + this.termIndex = 0; + this.metadataWhitelist = []; + }; + + /** + * Sets the document field used as the document reference. Every document must have this field. + * The type of this field in the document should be a string, if it is not a string it will be + * coerced into a string by calling toString. + * + * The default ref is 'id'. + * + * The ref should _not_ be changed during indexing, it should be set before any documents are + * added to the index. Changing it during indexing can lead to inconsistent results. + * + * @param {string} ref - The name of the reference field in the document. + */ + lunr.Builder.prototype.ref = function (ref) { + this._ref = ref; + }; + + /** + * A function that is used to extract a field from a document. + * + * Lunr expects a field to be at the top level of a document, if however the field + * is deeply nested within a document an extractor function can be used to extract + * the right field for indexing. + * + * @callback fieldExtractor + * @param {object} doc - The document being added to the index. + * @returns {?(string|object|object[])} obj - The object that will be indexed for this field. + * @example Extracting a nested field + * function (doc) { return doc.nested.field } + */ + + /** + * Adds a field to the list of document fields that will be indexed. Every document being + * indexed should have this field. Null values for this field in indexed documents will + * not cause errors but will limit the chance of that document being retrieved by searches. + * + * All fields should be added before adding documents to the index. Adding fields after + * a document has been indexed will have no effect on already indexed documents. + * + * Fields can be boosted at build time. This allows terms within that field to have more + * importance when ranking search results. Use a field boost to specify that matches within + * one field are more important than other fields. + * + * @param {string} fieldName - The name of a field to index in all documents. + * @param {object} attributes - Optional attributes associated with this field. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this field. + * @param {fieldExtractor} [attributes.extractor] - Function to extract a field from a document. + * @throws {RangeError} fieldName cannot contain unsupported characters '/' + */ + lunr.Builder.prototype.field = function (fieldName, attributes) { + if (/\//.test(fieldName)) { + throw new RangeError ("Field '" + fieldName + "' contains illegal character '/'") + } + + this._fields[fieldName] = attributes || {}; + }; + + /** + * A parameter to tune the amount of field length normalisation that is applied when + * calculating relevance scores. A value of 0 will completely disable any normalisation + * and a value of 1 will fully normalise field lengths. The default is 0.75. Values of b + * will be clamped to the range 0 - 1. + * + * @param {number} number - The value to set for this tuning parameter. + */ + lunr.Builder.prototype.b = function (number) { + if (number < 0) { + this._b = 0; + } else if (number > 1) { + this._b = 1; + } else { + this._b = number; + } + }; + + /** + * A parameter that controls the speed at which a rise in term frequency results in term + * frequency saturation. The default value is 1.2. Setting this to a higher value will give + * slower saturation levels, a lower value will result in quicker saturation. + * + * @param {number} number - The value to set for this tuning parameter. + */ + lunr.Builder.prototype.k1 = function (number) { + this._k1 = number; + }; + + /** + * Adds a document to the index. + * + * Before adding fields to the index the index should have been fully setup, with the document + * ref and all fields to index already having been specified. + * + * The document must have a field name as specified by the ref (by default this is 'id') and + * it should have all fields defined for indexing, though null or undefined values will not + * cause errors. + * + * Entire documents can be boosted at build time. Applying a boost to a document indicates that + * this document should rank higher in search results than other documents. + * + * @param {object} doc - The document to add to the index. + * @param {object} attributes - Optional attributes associated with this document. + * @param {number} [attributes.boost=1] - Boost applied to all terms within this document. + */ + lunr.Builder.prototype.add = function (doc, attributes) { + var docRef = doc[this._ref], + fields = Object.keys(this._fields); + + this._documents[docRef] = attributes || {}; + this.documentCount += 1; + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i], + extractor = this._fields[fieldName].extractor, + field = extractor ? extractor(doc) : doc[fieldName], + tokens = this.tokenizer(field, { + fields: [fieldName] + }), + terms = this.pipeline.run(tokens), + fieldRef = new lunr.FieldRef (docRef, fieldName), + fieldTerms = Object.create(null); + + this.fieldTermFrequencies[fieldRef] = fieldTerms; + this.fieldLengths[fieldRef] = 0; + + // store the length of this field for this document + this.fieldLengths[fieldRef] += terms.length; + + // calculate term frequencies for this field + for (var j = 0; j < terms.length; j++) { + var term = terms[j]; + + if (fieldTerms[term] == undefined) { + fieldTerms[term] = 0; + } + + fieldTerms[term] += 1; + + // add to inverted index + // create an initial posting if one doesn't exist + if (this.invertedIndex[term] == undefined) { + var posting = Object.create(null); + posting["_index"] = this.termIndex; + this.termIndex += 1; + + for (var k = 0; k < fields.length; k++) { + posting[fields[k]] = Object.create(null); + } + + this.invertedIndex[term] = posting; + } + + // add an entry for this term/fieldName/docRef to the invertedIndex + if (this.invertedIndex[term][fieldName][docRef] == undefined) { + this.invertedIndex[term][fieldName][docRef] = Object.create(null); + } + + // store all whitelisted metadata about this token in the + // inverted index + for (var l = 0; l < this.metadataWhitelist.length; l++) { + var metadataKey = this.metadataWhitelist[l], + metadata = term.metadata[metadataKey]; + + if (this.invertedIndex[term][fieldName][docRef][metadataKey] == undefined) { + this.invertedIndex[term][fieldName][docRef][metadataKey] = []; + } + + this.invertedIndex[term][fieldName][docRef][metadataKey].push(metadata); + } + } + + } + }; + + /** + * Calculates the average document length for this index + * + * @private + */ + lunr.Builder.prototype.calculateAverageFieldLengths = function () { + + var fieldRefs = Object.keys(this.fieldLengths), + numberOfFields = fieldRefs.length, + accumulator = {}, + documentsWithField = {}; + + for (var i = 0; i < numberOfFields; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + field = fieldRef.fieldName; + + documentsWithField[field] || (documentsWithField[field] = 0); + documentsWithField[field] += 1; + + accumulator[field] || (accumulator[field] = 0); + accumulator[field] += this.fieldLengths[fieldRef]; + } + + var fields = Object.keys(this._fields); + + for (var i = 0; i < fields.length; i++) { + var fieldName = fields[i]; + accumulator[fieldName] = accumulator[fieldName] / documentsWithField[fieldName]; + } + + this.averageFieldLength = accumulator; + }; + + /** + * Builds a vector space model of every document using lunr.Vector + * + * @private + */ + lunr.Builder.prototype.createFieldVectors = function () { + var fieldVectors = {}, + fieldRefs = Object.keys(this.fieldTermFrequencies), + fieldRefsLength = fieldRefs.length, + termIdfCache = Object.create(null); + + for (var i = 0; i < fieldRefsLength; i++) { + var fieldRef = lunr.FieldRef.fromString(fieldRefs[i]), + fieldName = fieldRef.fieldName, + fieldLength = this.fieldLengths[fieldRef], + fieldVector = new lunr.Vector, + termFrequencies = this.fieldTermFrequencies[fieldRef], + terms = Object.keys(termFrequencies), + termsLength = terms.length; + + + var fieldBoost = this._fields[fieldName].boost || 1, + docBoost = this._documents[fieldRef.docRef].boost || 1; + + for (var j = 0; j < termsLength; j++) { + var term = terms[j], + tf = termFrequencies[term], + termIndex = this.invertedIndex[term]._index, + idf, score, scoreWithPrecision; + + if (termIdfCache[term] === undefined) { + idf = lunr.idf(this.invertedIndex[term], this.documentCount); + termIdfCache[term] = idf; + } else { + idf = termIdfCache[term]; + } + + score = idf * ((this._k1 + 1) * tf) / (this._k1 * (1 - this._b + this._b * (fieldLength / this.averageFieldLength[fieldName])) + tf); + score *= fieldBoost; + score *= docBoost; + scoreWithPrecision = Math.round(score * 1000) / 1000; + // Converts 1.23456789 to 1.234. + // Reducing the precision so that the vectors take up less + // space when serialised. Doing it now so that they behave + // the same before and after serialisation. Also, this is + // the fastest approach to reducing a number's precision in + // JavaScript. + + fieldVector.insert(termIndex, scoreWithPrecision); + } + + fieldVectors[fieldRef] = fieldVector; + } + + this.fieldVectors = fieldVectors; + }; + + /** + * Creates a token set of all tokens in the index using lunr.TokenSet + * + * @private + */ + lunr.Builder.prototype.createTokenSet = function () { + this.tokenSet = lunr.TokenSet.fromArray( + Object.keys(this.invertedIndex).sort() + ); + }; + + /** + * Builds the index, creating an instance of lunr.Index. + * + * This completes the indexing process and should only be called + * once all documents have been added to the index. + * + * @returns {lunr.Index} + */ + lunr.Builder.prototype.build = function () { + this.calculateAverageFieldLengths(); + this.createFieldVectors(); + this.createTokenSet(); + + return new lunr.Index({ + invertedIndex: this.invertedIndex, + fieldVectors: this.fieldVectors, + tokenSet: this.tokenSet, + fields: Object.keys(this._fields), + pipeline: this.searchPipeline + }) + }; + + /** + * Applies a plugin to the index builder. + * + * A plugin is a function that is called with the index builder as its context. + * Plugins can be used to customise or extend the behaviour of the index + * in some way. A plugin is just a function, that encapsulated the custom + * behaviour that should be applied when building the index. + * + * The plugin function will be called with the index builder as its argument, additional + * arguments can also be passed when calling use. The function will be called + * with the index builder as its context. + * + * @param {Function} plugin The plugin to apply. + */ + lunr.Builder.prototype.use = function (fn) { + var args = Array.prototype.slice.call(arguments, 1); + args.unshift(this); + fn.apply(this, args); + }; + /** + * Contains and collects metadata about a matching document. + * A single instance of lunr.MatchData is returned as part of every + * lunr.Index~Result. + * + * @constructor + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + * @property {object} metadata - A cloned collection of metadata associated with this document. + * @see {@link lunr.Index~Result} + */ + lunr.MatchData = function (term, field, metadata) { + var clonedMetadata = Object.create(null), + metadataKeys = Object.keys(metadata || {}); + + // Cloning the metadata to prevent the original + // being mutated during match data combination. + // Metadata is kept in an array within the inverted + // index so cloning the data can be done with + // Array#slice + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i]; + clonedMetadata[key] = metadata[key].slice(); + } + + this.metadata = Object.create(null); + + if (term !== undefined) { + this.metadata[term] = Object.create(null); + this.metadata[term][field] = clonedMetadata; + } + }; + + /** + * An instance of lunr.MatchData will be created for every term that matches a + * document. However only one instance is required in a lunr.Index~Result. This + * method combines metadata from another instance of lunr.MatchData with this + * objects metadata. + * + * @param {lunr.MatchData} otherMatchData - Another instance of match data to merge with this one. + * @see {@link lunr.Index~Result} + */ + lunr.MatchData.prototype.combine = function (otherMatchData) { + var terms = Object.keys(otherMatchData.metadata); + + for (var i = 0; i < terms.length; i++) { + var term = terms[i], + fields = Object.keys(otherMatchData.metadata[term]); + + if (this.metadata[term] == undefined) { + this.metadata[term] = Object.create(null); + } + + for (var j = 0; j < fields.length; j++) { + var field = fields[j], + keys = Object.keys(otherMatchData.metadata[term][field]); + + if (this.metadata[term][field] == undefined) { + this.metadata[term][field] = Object.create(null); + } + + for (var k = 0; k < keys.length; k++) { + var key = keys[k]; + + if (this.metadata[term][field][key] == undefined) { + this.metadata[term][field][key] = otherMatchData.metadata[term][field][key]; + } else { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(otherMatchData.metadata[term][field][key]); + } + + } + } + } + }; + + /** + * Add metadata for a term/field pair to this instance of match data. + * + * @param {string} term - The term this match data is associated with + * @param {string} field - The field in which the term was found + * @param {object} metadata - The metadata recorded about this term in this field + */ + lunr.MatchData.prototype.add = function (term, field, metadata) { + if (!(term in this.metadata)) { + this.metadata[term] = Object.create(null); + this.metadata[term][field] = metadata; + return + } + + if (!(field in this.metadata[term])) { + this.metadata[term][field] = metadata; + return + } + + var metadataKeys = Object.keys(metadata); + + for (var i = 0; i < metadataKeys.length; i++) { + var key = metadataKeys[i]; + + if (key in this.metadata[term][field]) { + this.metadata[term][field][key] = this.metadata[term][field][key].concat(metadata[key]); + } else { + this.metadata[term][field][key] = metadata[key]; + } + } + }; + /** + * A lunr.Query provides a programmatic way of defining queries to be performed + * against a {@link lunr.Index}. + * + * Prefer constructing a lunr.Query using the {@link lunr.Index#query} method + * so the query object is pre-initialized with the right index fields. + * + * @constructor + * @property {lunr.Query~Clause[]} clauses - An array of query clauses. + * @property {string[]} allFields - An array of all available fields in a lunr.Index. + */ + lunr.Query = function (allFields) { + this.clauses = []; + this.allFields = allFields; + }; + + /** + * Constants for indicating what kind of automatic wildcard insertion will be used when constructing a query clause. + * + * This allows wildcards to be added to the beginning and end of a term without having to manually do any string + * concatenation. + * + * The wildcard constants can be bitwise combined to select both leading and trailing wildcards. + * + * @constant + * @default + * @property {number} wildcard.NONE - The term will have no wildcards inserted, this is the default behaviour + * @property {number} wildcard.LEADING - Prepend the term with a wildcard, unless a leading wildcard already exists + * @property {number} wildcard.TRAILING - Append a wildcard to the term, unless a trailing wildcard already exists + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with trailing wildcard + * query.term('foo', { wildcard: lunr.Query.wildcard.TRAILING }) + * @example query term with leading and trailing wildcard + * query.term('foo', { + * wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING + * }) + */ + + lunr.Query.wildcard = new String ("*"); + lunr.Query.wildcard.NONE = 0; + lunr.Query.wildcard.LEADING = 1; + lunr.Query.wildcard.TRAILING = 2; + + /** + * Constants for indicating what kind of presence a term must have in matching documents. + * + * @constant + * @enum {number} + * @see lunr.Query~Clause + * @see lunr.Query#clause + * @see lunr.Query#term + * @example query term with required presence + * query.term('foo', { presence: lunr.Query.presence.REQUIRED }) + */ + lunr.Query.presence = { + /** + * Term's presence in a document is optional, this is the default value. + */ + OPTIONAL: 1, + + /** + * Term's presence in a document is required, documents that do not contain + * this term will not be returned. + */ + REQUIRED: 2, + + /** + * Term's presence in a document is prohibited, documents that do contain + * this term will not be returned. + */ + PROHIBITED: 3 + }; + + /** + * A single clause in a {@link lunr.Query} contains a term and details on how to + * match that term against a {@link lunr.Index}. + * + * @typedef {Object} lunr.Query~Clause + * @property {string[]} fields - The fields in an index this clause should be matched against. + * @property {number} [boost=1] - Any boost that should be applied when matching this clause. + * @property {number} [editDistance] - Whether the term should have fuzzy matching applied, and how fuzzy the match should be. + * @property {boolean} [usePipeline] - Whether the term should be passed through the search pipeline. + * @property {number} [wildcard=lunr.Query.wildcard.NONE] - Whether the term should have wildcards appended or prepended. + * @property {number} [presence=lunr.Query.presence.OPTIONAL] - The terms presence in any matching documents. + */ + + /** + * Adds a {@link lunr.Query~Clause} to this query. + * + * Unless the clause contains the fields to be matched all fields will be matched. In addition + * a default boost of 1 is applied to the clause. + * + * @param {lunr.Query~Clause} clause - The clause to add to this query. + * @see lunr.Query~Clause + * @returns {lunr.Query} + */ + lunr.Query.prototype.clause = function (clause) { + if (!('fields' in clause)) { + clause.fields = this.allFields; + } + + if (!('boost' in clause)) { + clause.boost = 1; + } + + if (!('usePipeline' in clause)) { + clause.usePipeline = true; + } + + if (!('wildcard' in clause)) { + clause.wildcard = lunr.Query.wildcard.NONE; + } + + if ((clause.wildcard & lunr.Query.wildcard.LEADING) && (clause.term.charAt(0) != lunr.Query.wildcard)) { + clause.term = "*" + clause.term; + } + + if ((clause.wildcard & lunr.Query.wildcard.TRAILING) && (clause.term.slice(-1) != lunr.Query.wildcard)) { + clause.term = "" + clause.term + "*"; + } + + if (!('presence' in clause)) { + clause.presence = lunr.Query.presence.OPTIONAL; + } + + this.clauses.push(clause); + + return this + }; + + /** + * A negated query is one in which every clause has a presence of + * prohibited. These queries require some special processing to return + * the expected results. + * + * @returns boolean + */ + lunr.Query.prototype.isNegated = function () { + for (var i = 0; i < this.clauses.length; i++) { + if (this.clauses[i].presence != lunr.Query.presence.PROHIBITED) { + return false + } + } + + return true + }; + + /** + * Adds a term to the current query, under the covers this will create a {@link lunr.Query~Clause} + * to the list of clauses that make up this query. + * + * The term is used as is, i.e. no tokenization will be performed by this method. Instead conversion + * to a token or token-like string should be done before calling this method. + * + * The term will be converted to a string by calling `toString`. Multiple terms can be passed as an + * array, each term in the array will share the same options. + * + * @param {object|object[]} term - The term(s) to add to the query. + * @param {object} [options] - Any additional properties to add to the query clause. + * @returns {lunr.Query} + * @see lunr.Query#clause + * @see lunr.Query~Clause + * @example adding a single term to a query + * query.term("foo") + * @example adding a single term to a query and specifying search fields, term boost and automatic trailing wildcard + * query.term("foo", { + * fields: ["title"], + * boost: 10, + * wildcard: lunr.Query.wildcard.TRAILING + * }) + * @example using lunr.tokenizer to convert a string to tokens before using them as terms + * query.term(lunr.tokenizer("foo bar")) + */ + lunr.Query.prototype.term = function (term, options) { + if (Array.isArray(term)) { + term.forEach(function (t) { this.term(t, lunr.utils.clone(options)); }, this); + return this + } + + var clause = options || {}; + clause.term = term.toString(); + + this.clause(clause); + + return this + }; + lunr.QueryParseError = function (message, start, end) { + this.name = "QueryParseError"; + this.message = message; + this.start = start; + this.end = end; + }; + + lunr.QueryParseError.prototype = new Error; + lunr.QueryLexer = function (str) { + this.lexemes = []; + this.str = str; + this.length = str.length; + this.pos = 0; + this.start = 0; + this.escapeCharPositions = []; + }; + + lunr.QueryLexer.prototype.run = function () { + var state = lunr.QueryLexer.lexText; + + while (state) { + state = state(this); + } + }; + + lunr.QueryLexer.prototype.sliceString = function () { + var subSlices = [], + sliceStart = this.start, + sliceEnd = this.pos; + + for (var i = 0; i < this.escapeCharPositions.length; i++) { + sliceEnd = this.escapeCharPositions[i]; + subSlices.push(this.str.slice(sliceStart, sliceEnd)); + sliceStart = sliceEnd + 1; + } + + subSlices.push(this.str.slice(sliceStart, this.pos)); + this.escapeCharPositions.length = 0; + + return subSlices.join('') + }; + + lunr.QueryLexer.prototype.emit = function (type) { + this.lexemes.push({ + type: type, + str: this.sliceString(), + start: this.start, + end: this.pos + }); + + this.start = this.pos; + }; + + lunr.QueryLexer.prototype.escapeCharacter = function () { + this.escapeCharPositions.push(this.pos - 1); + this.pos += 1; + }; + + lunr.QueryLexer.prototype.next = function () { + if (this.pos >= this.length) { + return lunr.QueryLexer.EOS + } + + var char = this.str.charAt(this.pos); + this.pos += 1; + return char + }; + + lunr.QueryLexer.prototype.width = function () { + return this.pos - this.start + }; + + lunr.QueryLexer.prototype.ignore = function () { + if (this.start == this.pos) { + this.pos += 1; + } + + this.start = this.pos; + }; + + lunr.QueryLexer.prototype.backup = function () { + this.pos -= 1; + }; + + lunr.QueryLexer.prototype.acceptDigitRun = function () { + var char, charCode; + + do { + char = this.next(); + charCode = char.charCodeAt(0); + } while (charCode > 47 && charCode < 58) + + if (char != lunr.QueryLexer.EOS) { + this.backup(); + } + }; + + lunr.QueryLexer.prototype.more = function () { + return this.pos < this.length + }; + + lunr.QueryLexer.EOS = 'EOS'; + lunr.QueryLexer.FIELD = 'FIELD'; + lunr.QueryLexer.TERM = 'TERM'; + lunr.QueryLexer.EDIT_DISTANCE = 'EDIT_DISTANCE'; + lunr.QueryLexer.BOOST = 'BOOST'; + lunr.QueryLexer.PRESENCE = 'PRESENCE'; + + lunr.QueryLexer.lexField = function (lexer) { + lexer.backup(); + lexer.emit(lunr.QueryLexer.FIELD); + lexer.ignore(); + return lunr.QueryLexer.lexText + }; + + lunr.QueryLexer.lexTerm = function (lexer) { + if (lexer.width() > 1) { + lexer.backup(); + lexer.emit(lunr.QueryLexer.TERM); + } + + lexer.ignore(); + + if (lexer.more()) { + return lunr.QueryLexer.lexText + } + }; + + lunr.QueryLexer.lexEditDistance = function (lexer) { + lexer.ignore(); + lexer.acceptDigitRun(); + lexer.emit(lunr.QueryLexer.EDIT_DISTANCE); + return lunr.QueryLexer.lexText + }; + + lunr.QueryLexer.lexBoost = function (lexer) { + lexer.ignore(); + lexer.acceptDigitRun(); + lexer.emit(lunr.QueryLexer.BOOST); + return lunr.QueryLexer.lexText + }; + + lunr.QueryLexer.lexEOS = function (lexer) { + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM); + } + }; + + // This matches the separator used when tokenising fields + // within a document. These should match otherwise it is + // not possible to search for some tokens within a document. + // + // It is possible for the user to change the separator on the + // tokenizer so it _might_ clash with any other of the special + // characters already used within the search string, e.g. :. + // + // This means that it is possible to change the separator in + // such a way that makes some words unsearchable using a search + // string. + lunr.QueryLexer.termSeparator = lunr.tokenizer.separator; + + lunr.QueryLexer.lexText = function (lexer) { + while (true) { + var char = lexer.next(); + + if (char == lunr.QueryLexer.EOS) { + return lunr.QueryLexer.lexEOS + } + + // Escape character is '\' + if (char.charCodeAt(0) == 92) { + lexer.escapeCharacter(); + continue + } + + if (char == ":") { + return lunr.QueryLexer.lexField + } + + if (char == "~") { + lexer.backup(); + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM); + } + return lunr.QueryLexer.lexEditDistance + } + + if (char == "^") { + lexer.backup(); + if (lexer.width() > 0) { + lexer.emit(lunr.QueryLexer.TERM); + } + return lunr.QueryLexer.lexBoost + } + + // "+" indicates term presence is required + // checking for length to ensure that only + // leading "+" are considered + if (char == "+" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE); + return lunr.QueryLexer.lexText + } + + // "-" indicates term presence is prohibited + // checking for length to ensure that only + // leading "-" are considered + if (char == "-" && lexer.width() === 1) { + lexer.emit(lunr.QueryLexer.PRESENCE); + return lunr.QueryLexer.lexText + } + + if (char.match(lunr.QueryLexer.termSeparator)) { + return lunr.QueryLexer.lexTerm + } + } + }; + + lunr.QueryParser = function (str, query) { + this.lexer = new lunr.QueryLexer (str); + this.query = query; + this.currentClause = {}; + this.lexemeIdx = 0; + }; + + lunr.QueryParser.prototype.parse = function () { + this.lexer.run(); + this.lexemes = this.lexer.lexemes; + + var state = lunr.QueryParser.parseClause; + + while (state) { + state = state(this); + } + + return this.query + }; + + lunr.QueryParser.prototype.peekLexeme = function () { + return this.lexemes[this.lexemeIdx] + }; + + lunr.QueryParser.prototype.consumeLexeme = function () { + var lexeme = this.peekLexeme(); + this.lexemeIdx += 1; + return lexeme + }; + + lunr.QueryParser.prototype.nextClause = function () { + var completedClause = this.currentClause; + this.query.clause(completedClause); + this.currentClause = {}; + }; + + lunr.QueryParser.parseClause = function (parser) { + var lexeme = parser.peekLexeme(); + + if (lexeme == undefined) { + return + } + + switch (lexeme.type) { + case lunr.QueryLexer.PRESENCE: + return lunr.QueryParser.parsePresence + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expected either a field or a term, found " + lexeme.type; + + if (lexeme.str.length >= 1) { + errorMessage += " with value '" + lexeme.str + "'"; + } + + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + }; + + lunr.QueryParser.parsePresence = function (parser) { + var lexeme = parser.consumeLexeme(); + + if (lexeme == undefined) { + return + } + + switch (lexeme.str) { + case "-": + parser.currentClause.presence = lunr.Query.presence.PROHIBITED; + break + case "+": + parser.currentClause.presence = lunr.Query.presence.REQUIRED; + break + default: + var errorMessage = "unrecognised presence operator'" + lexeme.str + "'"; + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + var nextLexeme = parser.peekLexeme(); + + if (nextLexeme == undefined) { + var errorMessage = "expecting term or field, found nothing"; + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.FIELD: + return lunr.QueryParser.parseField + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term or field, found '" + nextLexeme.type + "'"; + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } + }; + + lunr.QueryParser.parseField = function (parser) { + var lexeme = parser.consumeLexeme(); + + if (lexeme == undefined) { + return + } + + if (parser.query.allFields.indexOf(lexeme.str) == -1) { + var possibleFields = parser.query.allFields.map(function (f) { return "'" + f + "'" }).join(', '), + errorMessage = "unrecognised field '" + lexeme.str + "', possible fields: " + possibleFields; + + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.fields = [lexeme.str]; + + var nextLexeme = parser.peekLexeme(); + + if (nextLexeme == undefined) { + var errorMessage = "expecting term, found nothing"; + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + return lunr.QueryParser.parseTerm + default: + var errorMessage = "expecting term, found '" + nextLexeme.type + "'"; + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } + }; + + lunr.QueryParser.parseTerm = function (parser) { + var lexeme = parser.consumeLexeme(); + + if (lexeme == undefined) { + return + } + + parser.currentClause.term = lexeme.str.toLowerCase(); + + if (lexeme.str.indexOf("*") != -1) { + parser.currentClause.usePipeline = false; + } + + var nextLexeme = parser.peekLexeme(); + + if (nextLexeme == undefined) { + parser.nextClause(); + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause(); + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause(); + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause(); + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'"; + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } + }; + + lunr.QueryParser.parseEditDistance = function (parser) { + var lexeme = parser.consumeLexeme(); + + if (lexeme == undefined) { + return + } + + var editDistance = parseInt(lexeme.str, 10); + + if (isNaN(editDistance)) { + var errorMessage = "edit distance must be numeric"; + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.editDistance = editDistance; + + var nextLexeme = parser.peekLexeme(); + + if (nextLexeme == undefined) { + parser.nextClause(); + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause(); + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause(); + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause(); + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'"; + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } + }; + + lunr.QueryParser.parseBoost = function (parser) { + var lexeme = parser.consumeLexeme(); + + if (lexeme == undefined) { + return + } + + var boost = parseInt(lexeme.str, 10); + + if (isNaN(boost)) { + var errorMessage = "boost must be numeric"; + throw new lunr.QueryParseError (errorMessage, lexeme.start, lexeme.end) + } + + parser.currentClause.boost = boost; + + var nextLexeme = parser.peekLexeme(); + + if (nextLexeme == undefined) { + parser.nextClause(); + return + } + + switch (nextLexeme.type) { + case lunr.QueryLexer.TERM: + parser.nextClause(); + return lunr.QueryParser.parseTerm + case lunr.QueryLexer.FIELD: + parser.nextClause(); + return lunr.QueryParser.parseField + case lunr.QueryLexer.EDIT_DISTANCE: + return lunr.QueryParser.parseEditDistance + case lunr.QueryLexer.BOOST: + return lunr.QueryParser.parseBoost + case lunr.QueryLexer.PRESENCE: + parser.nextClause(); + return lunr.QueryParser.parsePresence + default: + var errorMessage = "Unexpected lexeme type '" + nextLexeme.type + "'"; + throw new lunr.QueryParseError (errorMessage, nextLexeme.start, nextLexeme.end) + } + } + + /** + * export the module via AMD, CommonJS or as a browser global + * Export code from https://github.com/umdjs/umd/blob/master/returnExports.js + */ + ;(function (root, factory) { + { + /** + * Node. Does not work with strict CommonJS, but + * only CommonJS-like enviroments that support module.exports, + * like Node. + */ + module.exports = factory(); + } + }(this, function () { + /** + * Just return a value to define the module export. + * This example returns an object, but the module + * can return a function as the exported value. + */ + return lunr + })); + })(); +} (lunr)); + +var lunrExports = lunr.exports; + +/** + * Loads main search index. + * + * @returns {Promise} Did the search index load. + */ +async function loadMainSearchData() +{ + const dmtURL = import.meta.url.replace(/\/dmt-components.js/, ''); + + const response = await fetch(`${dmtURL}/dmt-search.cmp`); + + if (!response.ok) + { + console.warn(`[typedoc-theme-default-modern] Could not load search index.`); + return false; + } + + try + { + const arrayBuffer = await response.arrayBuffer(); + + /** @type {{ rows: SearchDocument[], index: [] }} */ + const data = globalThis.dmtInflateAndUnpack(new Uint8Array(arrayBuffer)); + + globalThis.dmtSearchMainRows = data.rows; + globalThis.dmtSearchMainIndex = lunrExports.Index.load(data.index); + } + catch (err) + { + console.warn(`[typedoc-theme-default-modern] Could not load search index.`); + console.error(err); + return false; + } + + return true; +} + +/** + * Note: The Lunr processing code in this source file is taken from the TypeDoc project and slightly modified to match + * the abbreviated fields in the DMT main search index data; {@link SearchDocument}. + * + * @see https://github.com/TypeStrong/typedoc/blob/master/src/lib/output/themes/default/assets/typedoc/components/Search.ts + */ + +/** + * @param {string} query - A search query. + * + * @param {object} options - Options. + * + * @param {string} options.basePath - The current relative base path. + * + * @param {boolean} [options.showModuleIcon=true] - Include SVG icon / kind in results for modules. + * + * @param {boolean} [options.searchFullName=false] - Always include parent reflection full name. + * + * @param {number} [options.searchLimit=10] - Limit search results to the given value. + * + * @returns {ProcessedSearchDocument[]} Processed query results. + */ +function processMainSearchQuery(query, { basePath, showModuleIcon = true, searchFullName = false, + searchLimit = 10 } = {}) +{ + if (!globalThis.dmtSearchMainIndex || !globalThis.dmtSearchMainRows) { return []; } + + const searchText = query.trim(); + + if (searchText.length === 0) { return []; } + + const indexResults = globalThis.dmtSearchMainIndex.search(`*${searchText}*`); + + /** @type {ProcessedSearchDocument[]} */ + const processedDocuments = []; + + for (let i = 0; i < indexResults.length; i++) + { + const item = indexResults[i]; + const row = globalThis.dmtSearchMainRows[Number(item.ref)]; + let boost = 1; + + // Boost by exact match on name. + if (row.n.toLowerCase().startsWith(searchText.toLowerCase())) // name + { + boost *= 1 + 1 / (1 + Math.abs(row.n.length - searchText.length)); // name + } + + item.score *= boost; + } + + indexResults.sort((a, b) => b.score - a.score); + + for (let c = Math.min(searchLimit, indexResults.length), i = 0; i < c; i++) + { + const indexResult = indexResults[i]; + const index = Number(indexResult.ref); + const row = globalThis.dmtSearchMainRows[index]; + + // Bold the matched part of the query in the search results + let name = boldMatches(row.n, searchText); // name + + // TypeDoc may set this variable for debugging. + if (globalThis?.DEBUG_SEARCH_WEIGHTS) { name += ` (score: ${indexResult.score.toFixed(2)})`; } + + // parent; always include parent full name when `searchFullName` option is true otherwise avoid showing module / + // package parents. + if (row.p && (searchFullName || row.pk !== 2)) + { + name = `${boldMatches( + row.p, + searchText + )}.${name}`; + } + + // Don't include kind when theme option `showModuleIcon` is false and result is a `Module`. + const kind = !showModuleIcon && row.k === 2 ? void 0 : row.k; + + processedDocuments.push({ + id: index, + kind, + classes: row.c ?? '', // classes + href: `${basePath}${row.u}`, // URL + name + }); + } + + return processedDocuments; +} + +/** + * @param {string} text - + * + * @param {string} search - + * + * @returns {string} Text w/ bold matches. + */ +function boldMatches(text, search) +{ + if (search === '') { return text; } + + const lowerText = text.toLocaleLowerCase(); + const lowerSearch = search.toLocaleLowerCase(); + + const parts = []; + + let lastIndex = 0; + let index = lowerText.indexOf(lowerSearch); + + while (index !== -1) + { + parts.push( + escapeHtml(text.substring(lastIndex, index)), + `${escapeHtml( + text.substring(index, index + lowerSearch.length) + )}` + ); + + lastIndex = index + lowerSearch.length; + index = lowerText.indexOf(lowerSearch, lastIndex); + } + + parts.push(escapeHtml(text.substring(lastIndex))); + + return parts.join(''); +} + +const SPECIAL_HTML = { + "&": "&", + "<": "<", + ">": ">", + "'": "'", + '"': """, +}; + +/** + * @param {string} text - + * + * @returns {string} Escaped text. + */ +function escapeHtml(text) +{ + return text.replace(/[&<>"']/g, (match) => SPECIAL_HTML[match]); +} + +/** + * @typedef {object} ProcessedSearchDocument Provides parsed presentation data for a SearchDocument found in a query. + * + * @property {number} id A unique ID. + * + * @property {import('typedoc').ReflectionKind} kind The reflection kind. + * + * @property {string} classes Any particular classes to apply regarding properties like private / inherited, etc. + * + * @property {string} href The document link. + * + * @property {string} name The document name HTML content. + */ + +/** + * Creates the DMTToolbarIconLinks store for `IconLinks.svelte`. To facilitate the dynamic toolbar icon links the + * user and service links are combined and image dimensions are calculated and cached in session storage. + * + * @param {DMTComponentData} dmtComponentData - + * + * @param {DMTComponentDataBCMP} dmtComponentDataBCMP - + * + * @returns {import('svelte/store').Writable} Toolbar icon links + * store. + */ +function createStoreToolbarIconLinks(dmtComponentData, dmtComponentDataBCMP) +{ + const iconLinks = { icons: [], totalWidth: 0 }; + + const allIcons = []; + + // Combine user and service icons. + allIcons.push(...(dmtComponentDataBCMP?.iconLinks?.user ?? [])); + allIcons.push(...(dmtComponentDataBCMP?.iconLinks?.service ?? [])); + + for (const entry of allIcons) + { + iconLinks.icons.push({ + iconURL: typeof entry.dmtPath === 'string' ? `${dmtComponentData.dmtURL}${entry.dmtPath}` : entry.iconURL, + title: entry.title, + url: entry.url + }); + } + + const store = writable(iconLinks); + + const key = `${dmtComponentData.storagePrepend}-toolbar-iconlinks-width`; + + if (iconLinks.icons.length === 0) + { + // For good measure remove the key when there are no icons. + globalThis.sessionStorage.removeItem(key); + } + else + { + const existingWidth = dmtComponentData.dmtSessionStorage.getItem(key); + + // First attempt to load cached image widths. + if (Number.isFinite(existingWidth) && existingWidth > 0) + { + iconLinks.totalWidth = existingWidth; + } + else + { + // Attempt to load and cache image widths. + ImageData.getDimensions(iconLinks.icons, { accessor: 'iconURL' }).then(({ fulfilled, rejected }) => + { + if (rejected.length) + { + globalThis.sessionStorage.removeItem(key); + } + else + { + store.update((iconLinks) => + { + for (const entry of fulfilled) + { + // Scale the image to the height of the toolbar images. See: IconLinks.svelte `img` style. + const scaledWidth = (24 / entry.height) * entry.width; + + // Add scaled width and anchor element margin. See: IconLinks.svelte `a` style. + iconLinks.totalWidth += scaledWidth + 8; + } + + // Add the gap between icons. See: IconLinks.svelte `section` style. + iconLinks.totalWidth += StyleParse.remPixels(0.35) * (fulfilled.length - 1); + + return iconLinks; + }); + + dmtComponentData.dmtSessionStorage.setItem(key, Math.floor(iconLinks.totalWidth)); + } + }); + } + } + + return store; +} + +/** + * @type {DMTLocalConstants} Defines all the local storage static constants. + */ +const localConstants = { + dmtThemeAnimate: 'docs-dmt-theme-animate' +}; + +/** + * @typedef {object} DMTLocalConstants Local storage constants. + * + * @property {string} dmtThemeAnimate Stores the current theme animation state. + */ + +/** + * Loads and wraps the binary compressed message pack data bundle for all Svelte components. + */ +class DMTComponentData +{ + /** + * Calculated stores for various components. + * + * @type {DMTComponentStores} + */ + #componentStores; + + /** + * The unpacked raw data bundle. + * + * @type {DMTComponentDataBCMP} + */ + #dmtComponentDataBCMP; + + /** + * Data that is derived at runtime. + * ``` + * - basepath: Relative path to the documentation root from current page. + * - baseURL: Full base URL to documentation root. + * ``` + * + * @type {({ + * basePath: string, + * baseURL: string, + * dmtURL: string, + * initialPathURL: string, + * })} + */ + #localData; + + /** + * The navigation tree data / control. + * + * @type {NavigationData} + */ + #navigationData; + + /** + * Additional DMT theme setting stores. + * + * @type {DMTSettingStores} + */ + #settingStores; + + /** + * Shared state stores between components / key handling system. + * + * @type {DMTStateStores} + */ + #stateStores; + + /** + * Application wide local / session web storage store managers. + * + * @type {{ session: TJSSessionStorage, local: TJSLocalStorage }} + */ + #storage = { + local: new TJSLocalStorage(), + session: new TJSSessionStorage() + }; + + /** + * @param {string} importMetaURL - Base `import.meta.url`. + */ + constructor(importMetaURL) + { + // Unpack the global component data. + this.#dmtComponentDataBCMP = /** @type {DMTComponentDataBCMP} */ + (typeof globalThis.dmtComponentDataBCMP === 'string' ? + globalThis.dmtInflateAndUnpackB64(globalThis.dmtComponentDataBCMP) : {}); + + // Setup additional runtime component data --------------------------------------------------------------------- + + const baseURL = importMetaURL.replace(/assets\/dmt\/dmt-components.js/, ''); + const dmtURL = importMetaURL.replace(/dmt-components.js/, ''); + const initialPathURL = globalThis.location.href.replace(baseURL, ''); + + // Find the path URL match without any additional URL fragment. + const depth = (initialPathURL.match(/\//) ?? []).length; + const basePath = '../'.repeat(depth); + + // Initialize local runtime resources. + this.#localData = { + basePath, + baseURL, + dmtURL, + initialPathURL + }; + + this.#navigationData = new NavigationData(this, this.#dmtComponentDataBCMP.navigationIndex); + + this.#componentStores = Object.freeze({ + toolbarIconLinks: createStoreToolbarIconLinks(this, this.#dmtComponentDataBCMP) + }); + + this.#settingStores = Object.freeze({ + // Ensure that the setting / animate local storage store is initialized with A11y motion preference. + themeAnimate: this.#storage.local.getStore(localConstants.dmtThemeAnimate, !A11yHelper.prefersReducedMotion) + }); + + this.#stateStores = Object.freeze({ + helpPanelVisible: writable(false), + mainSearchVisible: writable(false), + + swapHelpPanelVisible: () => this.#stateStores.helpPanelVisible.set(!get_store_value(this.#stateStores.helpPanelVisible)) + }); + } + + // Local runtime data --------------------------------------------------------------------------------------------- + + /** + * @returns {string} Relative path to the documentation root from current page. + */ + get basePath() + { + return this.#localData.basePath; + } + + /** + * @returns {string} Full base URL to documentation root. + */ + get baseURL() + { + return this.#localData.baseURL; + } + + /** + * @returns {DMTComponentStores} Various pre-calculated stores for components. + */ + get componentStores() + { + return this.#componentStores; + } + + /** + * @returns {TJSLocalStorage} Local storage store manager. + */ + get dmtLocalStorage() + { + return this.#storage.local; + } + + /** + * @returns {TJSSessionStorage} Session storage store manager. + */ + get dmtSessionStorage() + { + return this.#storage.session; + } + + /** + * @returns {string} Full URL to `assets/dmt`. + */ + get dmtURL() + { + return this.#localData.dmtURL; + } + + /** + * @returns {string} Initial path URL for current page. + */ + get initialPathURL() + { + return this.#localData.initialPathURL; + } + + /** + * @returns {NavigationData} Navigation data and control. + */ + get navigation() + { + return this.#navigationData; + } + + /** + * @returns {DMTSettingStores} Theme setting stores. + */ + get settingStores() + { + return this.#settingStores; + } + + /** + * @returns {DMTStateStores} Shared state across components. + */ + get stateStores() + { + return this.#stateStores; + } + + // Data forwarded on from BCMP data ------------------------------------------------------------------------------- + + /** + * @returns {{service: DMTIconLink[], user: DMTIconLink[]}} icon links for `IconLinks` component. + */ + get iconLinks() + { + return this.#dmtComponentDataBCMP.iconLinks; + } + + /** + * @returns {{hierarchy: string | undefined, modules: string | undefined}} Additional pages index. + */ + get pageIndex() + { + return this.#dmtComponentDataBCMP.pageIndex ?? {}; + } + + /** + * @returns {boolean} When true 'Module' in page titles is replaced with 'Package'. + */ + get moduleIsPackage() + { + return this.#dmtComponentDataBCMP.moduleIsPackage ?? false; + } + + /** + * @returns {boolean} When true SVG icons for all navigation module entries are displayed. + */ + get showModuleIcon() + { + return this.#dmtComponentDataBCMP.showModuleIcon ?? true; + } + + /** + * @returns {DMTSearchOptions} The `dmtSearch` option; when truthy the main search index is active. + */ + get searchOptions() + { + return this.#dmtComponentDataBCMP.searchOptions; + } + + /** + * @returns {Record} TypeDoc ReflectionKind + */ + get ReflectionKind() + { + return this.#dmtComponentDataBCMP.ReflectionKind; + } + + /** + * @returns {Record} Combined `sidebarLinks` and `navigationLinks` for `SidebarLinks` component. + */ + get sidebarLinks() + { + return this.#dmtComponentDataBCMP?.sidebarLinks ?? {}; + } + + /** + * @returns {string} Provides a key based on the package name or a random string to prepend to local / session + * storage keys. + */ + get storagePrepend() + { + return this.#dmtComponentDataBCMP.storagePrepend ?? 'docs-unnamed'; + } +} + +/** + * @typedef {object} DMTComponentStores Various stores calculated for components. + * + * @property {import('svelte/store').Writable} toolbarIconLinks Icon link + * data for `IconLinks.svelte`. + */ + +/** + * @typedef {object} DMTSettingStores Additional theme settings stored in local storage. + * + * @property {import('svelte/store').Writable} themeAnimate Enables / disables theme animation. + */ + +/** + * @typedef {object} DMTStateStores Shared state across components. + * + * @property {import('svelte/store').Writable} helpPanelVisible Enables / disables help panel display. + * + * @property {import('svelte/store').Writable} mainSearchVisible Enables / disables main search display. + * + * @property {Function} swapHelpPanelVisible Swaps the help panel visible state. + */ + +if (typeof window !== 'undefined') + // @ts-ignore + (window.__svelte || (window.__svelte = { v: new Set() })).v.add(PUBLIC_VERSION); + +/* src\frontend\view\settings\LabeledCheckbox.svelte generated by Svelte v4.2.18 */ + +function create_fragment$l(ctx) { + let label_1; + let input; + let t0; + let svg; + let rect; + let path; + let t1; + let span; + let t2; + let mounted; + let dispose; + + return { + c() { + label_1 = element("label"); + input = element("input"); + t0 = space(); + svg = svg_element("svg"); + rect = svg_element("rect"); + path = svg_element("path"); + t1 = space(); + span = element("span"); + t2 = text(/*label*/ ctx[1]); + attr(input, "type", "checkbox"); + attr(rect, "class", "tsd-checkbox-background"); + attr(rect, "width", "30"); + attr(rect, "height", "30"); + attr(rect, "x", "1"); + attr(rect, "y", "1"); + attr(rect, "rx", "6"); + attr(rect, "fill", "none"); + attr(path, "class", "tsd-checkbox-checkmark"); + attr(path, "d", "M8.35422 16.8214L13.2143 21.75L24.6458 10.25"); + attr(path, "stroke", "none"); + attr(path, "stroke-width", "3.5"); + attr(path, "stroke-linejoin", "round"); + attr(path, "fill", "none"); + attr(svg, "width", "32"); + attr(svg, "height", "32"); + attr(svg, "viewBox", "0 0 32 32"); + attr(svg, "aria-hidden", "true"); + attr(label_1, "class", "tsd-filter-input"); + }, + m(target, anchor) { + insert(target, label_1, anchor); + append(label_1, input); + input.checked = /*$store*/ ctx[2]; + append(label_1, t0); + append(label_1, svg); + append(svg, rect); + append(svg, path); + append(label_1, t1); + append(label_1, span); + append(span, t2); + + if (!mounted) { + dispose = listen(input, "change", /*input_change_handler*/ ctx[3]); + mounted = true; + } + }, + p(ctx, [dirty]) { + if (dirty & /*$store*/ 4) { + input.checked = /*$store*/ ctx[2]; + } + + if (dirty & /*label*/ 2) set_data(t2, /*label*/ ctx[1]); + }, + i: noop, + o: noop, + d(detaching) { + if (detaching) { + detach(label_1); + } + + mounted = false; + dispose(); + } + }; +} + +function instance$k($$self, $$props, $$invalidate) { + let $store, + $$unsubscribe_store = noop, + $$subscribe_store = () => ($$unsubscribe_store(), $$unsubscribe_store = subscribe(store, $$value => $$invalidate(2, $store = $$value)), store); + + $$self.$$.on_destroy.push(() => $$unsubscribe_store()); + let { store = void 0 } = $$props; + $$subscribe_store(); + let { label = void 0 } = $$props; + + function input_change_handler() { + $store = this.checked; + store.set($store); + } + + $$self.$$set = $$props => { + if ('store' in $$props) $$subscribe_store($$invalidate(0, store = $$props.store)); + if ('label' in $$props) $$invalidate(1, label = $$props.label); + }; + + return [store, label, $store, input_change_handler]; +} + +class LabeledCheckbox extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$k, create_fragment$l, safe_not_equal, { store: 0, label: 1 }); + } +} + +/* src\frontend\view\settings\DMTSettings.svelte generated by Svelte v4.2.18 */ + +function create_fragment$k(ctx) { + let section; + let labeledcheckbox; + let current; + + labeledcheckbox = new LabeledCheckbox({ + props: { + store: /*storeThemeAnimate*/ ctx[0], + label: 'Animation' + } + }); + + return { + c() { + section = element("section"); + create_component(labeledcheckbox.$$.fragment); + attr(section, "class", "svelte-20evnz"); + }, + m(target, anchor) { + insert(target, section, anchor); + mount_component(labeledcheckbox, section, null); + current = true; + }, + p: noop, + i(local) { + if (current) return; + transition_in(labeledcheckbox.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(labeledcheckbox.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(section); + } + + destroy_component(labeledcheckbox); + } + }; +} + +function instance$j($$self) { + const { settingStores } = /** @type {DMTComponentData} */ getContext('#dmtComponentData'); + const storeThemeAnimate = settingStores.themeAnimate; + return [storeThemeAnimate]; +} + +class DMTSettings extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$j, create_fragment$k, safe_not_equal, {}); + } +} + +/* src\frontend\view\navigation\tree\Entry.svelte generated by Svelte v4.2.18 */ + +function create_else_block$3(ctx) { + let span; + let t_value = /*entry*/ ctx[0].text + ""; + let t; + + return { + c() { + span = element("span"); + t = text(t_value); + attr(span, "class", "svelte-14yttr0"); + toggle_class(span, "indent-icon", /*indentIcon*/ ctx[1] === 'indent-icon'); + toggle_class(span, "indent-no-icon", /*indentIcon*/ ctx[1] === 'indent-no-icon'); + }, + m(target, anchor) { + insert(target, span, anchor); + append(span, t); + }, + p(ctx, dirty) { + if (dirty & /*entry*/ 1 && t_value !== (t_value = /*entry*/ ctx[0].text + "")) set_data(t, t_value); + + if (dirty & /*indentIcon*/ 2) { + toggle_class(span, "indent-icon", /*indentIcon*/ ctx[1] === 'indent-icon'); + } + + if (dirty & /*indentIcon*/ 2) { + toggle_class(span, "indent-no-icon", /*indentIcon*/ ctx[1] === 'indent-no-icon'); + } + }, + d(detaching) { + if (detaching) { + detach(span); + } + } + }; +} + +// (46:0) {#if path} +function create_if_block$c(ctx) { + let a; + let t0; + let span; + let t1_value = /*entry*/ ctx[0].text + ""; + let t1; + let mounted; + let dispose; + let if_block = /*icon*/ ctx[5] && create_if_block_1$3(ctx); + + return { + c() { + a = element("a"); + if (if_block) if_block.c(); + t0 = space(); + span = element("span"); + t1 = text(t1_value); + attr(span, "class", "svelte-14yttr0"); + attr(a, "href", /*path*/ ctx[6]); + attr(a, "data-storage-key", /*storageKey*/ ctx[2]); + attr(a, "class", "svelte-14yttr0"); + toggle_class(a, "current", /*isCurrent*/ ctx[3]); + toggle_class(a, "indent-icon", /*indentIcon*/ ctx[1] === 'indent-icon'); + toggle_class(a, "indent-no-icon", /*indentIcon*/ ctx[1] === 'indent-no-icon'); + toggle_class(a, "indent-none", /*indentIcon*/ ctx[1] === 'indent-none'); + }, + m(target, anchor) { + insert(target, a, anchor); + if (if_block) if_block.m(a, null); + append(a, t0); + append(a, span); + append(span, t1); + + if (!mounted) { + dispose = listen(a, "click", stop_propagation(prevent_default(/*onClick*/ ctx[7]))); + mounted = true; + } + }, + p(ctx, dirty) { + if (/*icon*/ ctx[5]) if_block.p(ctx, dirty); + if (dirty & /*entry*/ 1 && t1_value !== (t1_value = /*entry*/ ctx[0].text + "")) set_data(t1, t1_value); + + if (dirty & /*storageKey*/ 4) { + attr(a, "data-storage-key", /*storageKey*/ ctx[2]); + } + + if (dirty & /*isCurrent*/ 8) { + toggle_class(a, "current", /*isCurrent*/ ctx[3]); + } + + if (dirty & /*indentIcon*/ 2) { + toggle_class(a, "indent-icon", /*indentIcon*/ ctx[1] === 'indent-icon'); + } + + if (dirty & /*indentIcon*/ 2) { + toggle_class(a, "indent-no-icon", /*indentIcon*/ ctx[1] === 'indent-no-icon'); + } + + if (dirty & /*indentIcon*/ 2) { + toggle_class(a, "indent-none", /*indentIcon*/ ctx[1] === 'indent-none'); + } + }, + d(detaching) { + if (detaching) { + detach(a); + } + + if (if_block) if_block.d(); + mounted = false; + dispose(); + } + }; +} + +// (54:6) {#if icon} +function create_if_block_1$3(ctx) { + let svg; + let use; + + return { + c() { + svg = svg_element("svg"); + use = svg_element("use"); + attr(use, "href", `#icon-${/*icon*/ ctx[5]}`); + attr(svg, "class", "tsd-kind-icon svelte-14yttr0"); + attr(svg, "viewBox", "0 0 24 24"); + }, + m(target, anchor) { + insert(target, svg, anchor); + append(svg, use); + }, + p: noop, + d(detaching) { + if (detaching) { + detach(svg); + } + } + }; +} + +function create_fragment$j(ctx) { + let if_block_anchor; + + function select_block_type(ctx, dirty) { + if (/*path*/ ctx[6]) return create_if_block$c; + return create_else_block$3; + } + + let current_block_type = select_block_type(ctx); + let if_block = current_block_type(ctx); + + return { + c() { + if_block.c(); + if_block_anchor = empty(); + }, + m(target, anchor) { + if_block.m(target, anchor); + insert(target, if_block_anchor, anchor); + }, + p(ctx, [dirty]) { + if_block.p(ctx, dirty); + }, + i: noop, + o: noop, + d(detaching) { + if (detaching) { + detach(if_block_anchor); + } + + if_block.d(detaching); + } + }; +} + +function instance$i($$self, $$props, $$invalidate) { + let isCurrent; + let $storeCurrentPathURL; + let { entry } = $$props; + let { removeIcon = false } = $$props; + let { indentIcon = void 0 } = $$props; + let { storageKey = null } = $$props; + + const { basePath, navigation } = /** @type {DMTComponentData} */ + getContext('#dmtComponentData'); + + /** @type {import('svelte/store').Readable} */ + const storeCurrentPathURL = navigation.treeState.storeCurrentPathURL; + + component_subscribe($$self, storeCurrentPathURL, value => $$invalidate(9, $storeCurrentPathURL = value)); + const icon = !removeIcon && entry.kind ? entry.kind : void 0; + const path = entry.path ? `${basePath}${entry.path}` : void 0; + + /** + * Disables default browser downloading when `Alt-Click` is pressed. This helps to protect users as `Alt-Click` on + * Folder components closes all children folders and this protects an easy mistake when clicking on an anchor. + */ + function onClick() { + globalThis.location.href = path; + } + + $$self.$$set = $$props => { + if ('entry' in $$props) $$invalidate(0, entry = $$props.entry); + if ('removeIcon' in $$props) $$invalidate(8, removeIcon = $$props.removeIcon); + if ('indentIcon' in $$props) $$invalidate(1, indentIcon = $$props.indentIcon); + if ('storageKey' in $$props) $$invalidate(2, storageKey = $$props.storageKey); + }; + + $$self.$$.update = () => { + if ($$self.$$.dirty & /*entry, $storeCurrentPathURL*/ 513) { + $$invalidate(3, isCurrent = entry.path ? entry.path === $storeCurrentPathURL : false); + } + }; + + return [ + entry, + indentIcon, + storageKey, + isCurrent, + storeCurrentPathURL, + icon, + path, + onClick, + removeIcon, + $storeCurrentPathURL + ]; +} + +class Entry extends SvelteComponent { + constructor(options) { + super(); + + init(this, options, instance$i, create_fragment$j, safe_not_equal, { + entry: 0, + removeIcon: 8, + indentIcon: 1, + storageKey: 2 + }); + } +} + +/** + * Provides a single global ResizeObserverManager instance for the resizeObserver action. + * + * @type {ResizeObserverManager} + */ +const resizeObserverActionManager = new ResizeObserverManager(); + +/** + * Provides an action to monitor the given {@link HTMLElement} node with {@link ResizeObserver} via + * {@link ResizeObserverManager} posting width / height changes to the {@link ResizeObserverData.ResizeTarget} in + * various ways depending on the shape of the target. The target can be one of the following and the + * precedence order is listed from top to bottom: + * + * - has a `resizeObserved` function as attribute; offset then content width / height are passed as parameters. + * - has a `setContentBounds` function as attribute; content width / height are passed as parameters. + * - has a `setDimension` function as attribute; offset width / height are passed as parameters. + * - target is an object; offset and content width / height attributes directly set on target. + * - target is a function; the function invoked with offset then content width / height parameters. + * - has a writable store `resizeObserved` as an attribute; updated with offset & content width / height. + * - has an object 'stores' that has a writable store `resizeObserved` as an attribute; updated with offset & + * content width / height. + * + * Note: Svelte currently uses an archaic IFrame based workaround to monitor offset / client width & height changes. + * A more up to date way to do this is with ResizeObserver. To track when Svelte receives ResizeObserver support + * monitor this issue: {@link https://github.com/sveltejs/svelte/issues/4233} + * + * Can-I-Use: {@link https://caniuse.com/resizeobserver} + * + * @param {HTMLElement} node - The node associated with the action. + * + * @param {import('#runtime/util/browser').ResizeObserverData.ResizeTarget} target - A {@link ResizeObserverManager} + * target to update with observed width & height changes. + * + * @returns {import('svelte/action').ActionReturn} The + * action lifecycle methods. + * + * @see https://github.com/sveltejs/svelte/issues/4233 + */ +function resizeObserver(node, target) +{ + resizeObserverActionManager.add(node, target); + + return { + /** + * @param {import('#runtime/util/browser').ResizeObserverData.ResizeTarget} newTarget - A + * {@link ResizeObserverManager} target to update with observed width & height changes. + */ + update: (newTarget) => + { + resizeObserverActionManager.remove(node, target); + target = newTarget; + resizeObserverActionManager.add(node, target); + }, + + destroy: () => + { + resizeObserverActionManager.remove(node, target); + } + }; +} + +/** + * Provides a function that when invoked with an element updates the cached styles for each subscriber of the element. + * + * The style attributes cached to calculate offset height / width include border & padding dimensions. You only need + * to update the cache if you change border or padding attributes of the element. + * + * @param {HTMLElement} el - A HTML element. + */ +resizeObserver.updateCache = function(el) +{ + resizeObserverActionManager.updateCache(el); +}; + +/** + * Provides an action to apply style properties provided as an object. + * + * @param {HTMLElement} node - Target element + * + * @param {Record} properties - Key / value object of properties to set. + * + * @returns {import('svelte/action').ActionReturn>} Lifecycle functions. + */ +function applyStyles(node, properties) +{ + /** Sets properties on node. */ + function setProperties() + { + if (!isObject(properties)) { return; } + + for (const prop of Object.keys(properties)) + { + node.style.setProperty(`${prop}`, properties[prop]); + } + } + + setProperties(); + + return { + /** + * @param {Record} newProperties - Key / value object of properties to set. + */ + update: (newProperties) => + { + properties = newProperties; + setProperties(); + } + }; +} + +/** + * Various utilities to duck type / detect Svelte components and run outro transition while destroying a component + * externally. + */ +class TJSSvelteUtil +{ + /** + * Provides basic duck typing to determine if the provided function is a constructor function for a Svelte component. + * + * @param {unknown} comp - Data to check as a Svelte component. + * + * @returns {boolean} Whether basic duck typing succeeds. + */ + static isComponent(comp) + { + if (comp === null || comp === void 0 || typeof comp !== 'function') { return false; } + + // When using Vite in a developer build the SvelteComponent is wrapped in a ProxyComponent class. + // This class doesn't define methods on the prototype, so we must check if the constructor name + // starts with `Proxy<` as it provides the wrapped component as `Proxy<_wrapped component name_>`. + const prototypeName = comp?.prototype?.constructor?.name; + + if (typeof prototypeName === 'string' && (prototypeName.startsWith('Proxy<') || + prototypeName === 'ProxyComponent')) + { + return true; + } + + return typeof window !== 'undefined' ? + typeof comp.prototype.$destroy === 'function' && typeof comp.prototype.$on === 'function' : // client-side + typeof comp.render === 'function'; // server-side + } + + /** + * Provides basic duck typing to determine if the provided object is a HMR ProxyComponent instance or class. + * + * @param {unknown} comp - Data to check as a HMR proxy component. + * + * @returns {boolean} Whether basic duck typing succeeds. + */ + static isHMRProxy(comp) + { + const instanceName = comp?.constructor?.name; + if (typeof instanceName === 'string' && (instanceName.startsWith('Proxy<') || instanceName === 'ProxyComponent')) + { + return true; + } + + const prototypeName = comp?.prototype?.constructor?.name; + return typeof prototypeName === 'string' && (prototypeName.startsWith('Proxy<') || + prototypeName === 'ProxyComponent'); + } + + /** + * Runs outro transition then destroys Svelte component. + * + * Workaround for https://github.com/sveltejs/svelte/issues/4056 + * + * @param {*} instance - A Svelte component. + */ + static async outroAndDestroy(instance) + { + return new Promise((resolve) => + { + if (instance.$$.fragment && instance.$$.fragment.o) + { + group_outros(); + transition_out(instance.$$.fragment, 0, 0, () => + { + instance.$destroy(); + resolve(); + }); + check_outros(); + } + else + { + instance.$destroy(); + resolve(); + } + }); + } +} + +Object.seal(TJSSvelteUtil); + +/** + * Provides utilities to verify and parse {@link TJSSvelteConfig} configuration objects. + */ +class TJSSvelteConfigUtil +{ + /** + * Validates `config` argument whether it is a valid {@link TJSSvelteConfig}. + * + * @param {unknown} config - The potential config object to validate. + * + * @param {object} [options] - Options. + * + * @param {boolean} [options.raiseException=false] - If validation fails raise an exception. + * + * @returns {config is import('./types').TJSSvelteConfig} Is the config a valid TJSSvelteConfig. + * + * @throws {TypeError} Any validation error when `raiseException` is enabled. + */ + static isConfig(config, { raiseException = false } = {}) + { + if (!isObject(config)) + { + if (raiseException) { throw new TypeError(`TJSSvelteConfigUtil.isConfig error: 'config' is not an object.`); } + return false; + } + + if (!TJSSvelteUtil.isComponent(config.class)) + { + if (raiseException) + { + throw new TypeError( + `TJSSvelteConfigUtil.isConfig error: 'config.class' is not a Svelte component constructor.`); + } + return false; + } + + return true; + } + + /** + * Parses a TyphonJS Svelte config object ensuring that classes specified are Svelte components and props are set + * correctly. + * + * @param {import('./types').TJSSvelteConfig} config - Svelte config object. + * + * @param {any} [thisArg] - `This` reference to set for invoking any props function. + * + * @returns {import('./types').TJSSvelteConfig} The processed Svelte config object. + */ + static parseConfig(config, thisArg = void 0) + { + if (!isObject(config)) + { + throw new TypeError( + `TJSSvelteConfigUtil.parseConfig - 'config' is not an object:\n${JSON.stringify(config)}.`); + } + + if (!TJSSvelteUtil.isComponent(config.class)) + { + throw new TypeError( + `TJSSvelteConfigUtil.parseConfig - 'class' is not a Svelte component constructor for config:\n${ + JSON.stringify(config)}.`); + } + + if (config.hydrate !== void 0 && typeof config.hydrate !== 'boolean') + { + throw new TypeError( + `TJSSvelteConfigUtil.parseConfig - 'hydrate' is not a boolean for config:\n${JSON.stringify(config)}.`); + } + + if (config.intro !== void 0 && typeof config.intro !== 'boolean') + { + throw new TypeError( + `TJSSvelteConfigUtil.parseConfig - 'intro' is not a boolean for config:\n${JSON.stringify(config)}.`); + } + + if (config.target !== void 0 && typeof config.target !== 'string' && !(config.target instanceof Element) && + !(config.target instanceof ShadowRoot) && !(config.target instanceof DocumentFragment)) + { + throw new TypeError( + `TJSSvelteConfigUtil.parseConfig - 'target' is not a Element, ShadowRoot, or DocumentFragment for config:\n${ + JSON.stringify(config)}.`); + } + + if (config.anchor !== void 0 && typeof config.anchor !== 'string' && !(config.anchor instanceof Element) && + !(config.anchor instanceof ShadowRoot) && !(config.anchor instanceof DocumentFragment)) + { + throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'anchor' is not a string, Element for config:\n${ + JSON.stringify(config)}.`); + } + + if (config.context !== void 0 && typeof config.context !== 'function' && !(config.context instanceof Map) && + !isObject(config.context)) + { + throw new TypeError( + `TJSSvelteConfigUtil.parseConfig - 'context' is not a Map, function or object for config:\n${ + JSON.stringify(config)}.`); + } + + // Validate extra TyphonJS options -------------------------------------------------------------------------------- + + // `selectorTarget` optionally stores a target element found in main element. + if (config.selectorTarget !== void 0 && typeof config.selectorTarget !== 'string') + { + throw new TypeError( + `TJSSvelteConfigUtil.parseConfig - 'selectorTarget' is not a string for config:\n${JSON.stringify(config)}.`); + } + + // `options` stores `injectApp`, `injectEventbus`, and `selectorElement`. + if (config.options !== void 0 && !isObject(config.options)) + { + throw new TypeError( + `TJSSvelteConfigUtil.parseConfig - 'options' is not an object for config:\n${JSON.stringify(config)}.`); + } + + // Validate TyphonJS standard options. // TODO: This will change in `0.3.0`! + if (isObject(config.options)) + { + if (config.options.injectApp !== void 0 && typeof config.options.injectApp !== 'boolean') + { + throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'options.injectApp' is not a boolean for config:\n${ + JSON.stringify(config)}.`); + } + + if (config.options.injectEventbus !== void 0 && typeof config.options.injectEventbus !== 'boolean') + { + throw new TypeError( + `TJSSvelteConfigUtil.parseConfig - 'options.injectEventbus' is not a boolean for config:\n${ + JSON.stringify(config)}.`); + } + + // `selectorElement` optionally stores a main element selector to be found in a HTMLElement target. + if (config.options.selectorElement !== void 0 && typeof config.options.selectorElement !== 'string') + { + throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'selectorElement' is not a string for config:\n${ + JSON.stringify(config)}.`); + } + } + + const svelteConfig = { ...config }; + + // Delete extra Svelte options. + delete svelteConfig.options; + + let externalContext = {}; + + // If a context callback function is provided then invoke it with `this` being the Foundry app. + // If an object is returned it adds the entries to external context. + if (typeof svelteConfig.context === 'function') + { + const contextFunc = svelteConfig.context; + delete svelteConfig.context; + + const result = contextFunc.call(thisArg); + if (isObject(result)) + { + externalContext = { ...result }; + } + else + { + throw new Error( + `TJSSvelteConfigUtil.parseConfig - 'context' is a function that did not return an object for config:\n${ + JSON.stringify(config)}`); + } + } + else if (svelteConfig.context instanceof Map) + { + externalContext = Object.fromEntries(svelteConfig.context); + delete svelteConfig.context; + } + else if (isObject(svelteConfig.context)) + { + externalContext = svelteConfig.context; + delete svelteConfig.context; + } + + // If a props is a function then invoke it with `this` being the Foundry app. + // If an object is returned set it as the props. + svelteConfig.props = this.#processProps(svelteConfig.props, thisArg, config); + + // Process children components attaching to external context. + if (Array.isArray(svelteConfig.children)) + { + const children = []; + + for (let cntr = 0; cntr < svelteConfig.children.length; cntr++) + { + const child = svelteConfig.children[cntr]; + + if (!TJSSvelteUtil.isComponent(child.class)) + { + throw new Error(`TJSSvelteConfigUtil.parseConfig - 'class' is not a Svelte component for child[${ + cntr}] for config:\n${JSON.stringify(config)}`); + } + + child.props = this.#processProps(child.props, thisArg, config); + + children.push(child); + } + + if (children.length > 0) + { + externalContext.children = children; + } + + delete svelteConfig.children; + } + else if (isObject(svelteConfig.children)) + { + if (!TJSSvelteUtil.isComponent(svelteConfig.children.class)) + { + throw new Error( + `TJSSvelteConfigUtil.parseConfig - 'class' is not a Svelte component for children object for config:\n${ + JSON.stringify(config)}`); + } + + svelteConfig.children.props = this.#processProps(svelteConfig.children.props, thisArg, config); + + externalContext.children = [svelteConfig.children]; + delete svelteConfig.children; + } + + if (!(svelteConfig.context instanceof Map)) + { + svelteConfig.context = new Map(); + } + + svelteConfig.context.set('#external', externalContext); + + return svelteConfig; + } + + // Internal implementation ---------------------------------------------------------------------------------------- + + /** + * Processes Svelte props. Potentially props can be a function to invoke with `thisArg`. + * + * @param {Record | Function} props - Svelte props. + * + * @param {*} thisArg - `This` reference to set for invoking any props function. + * + * @param {object} config - Svelte config + * + * @returns {Record | undefined} Svelte props. + */ + static #processProps(props, thisArg, config) + { + // If a props is a function then invoke it with `this` being the Foundry app. + // If an object is returned set it as the props. + if (typeof props === 'function') + { + const result = props.call(thisArg); + if (isObject(result)) + { + return result; + } + else + { + throw new Error( + `TJSSvelteConfigUtil.parseConfig - 'props' is a function that did not return an object for config:\n${ + JSON.stringify(config)}`); + } + } + else if (isObject(props)) + { + return props; + } + else if (props !== void 0) + { + throw new Error(`TJSSvelteConfigUtil.parseConfig - 'props' is not a function or an object for config:\n${ + JSON.stringify(config)}`); + } + + return {}; + } +} + +Object.seal(TJSSvelteConfigUtil); + +/* src\frontend\view\external\TJSSvgFolder.svelte generated by Svelte v4.2.18 */ +const get_summary_end_slot_changes = dirty => ({}); +const get_summary_end_slot_context = ctx => ({}); +const get_label_slot_changes = dirty => ({}); +const get_label_slot_context = ctx => ({}); + +// (441:6) {#if localOptions.focusIndicator} +function create_if_block_4$1(ctx) { + let div; + + return { + c() { + div = element("div"); + attr(div, "class", "tjs-folder-focus-indicator svelte-9arcsc"); + }, + m(target, anchor) { + insert(target, div, anchor); + }, + d(detaching) { + if (detaching) { + detach(div); + } + } + }; +} + +// (448:9) {:else} +function create_else_block$2(ctx) { + let div; + let t; + + return { + c() { + div = element("div"); + t = text(/*label*/ ctx[2]); + attr(div, "class", "label svelte-9arcsc"); + }, + m(target, anchor) { + insert(target, div, anchor); + append(div, t); + /*div_binding*/ ctx[36](div); + }, + p(ctx, dirty) { + if (dirty[0] & /*label*/ 4) set_data(t, /*label*/ ctx[2]); + }, + i: noop, + o: noop, + d(detaching) { + if (detaching) { + detach(div); + } + + /*div_binding*/ ctx[36](null); + } + }; +} + +// (446:9) {#if TJSSvelteUtil.isComponent(folder?.slotLabel?.class)} +function create_if_block_3$2(ctx) { + let switch_instance; + let switch_instance_anchor; + let current; + + const switch_instance_spread_levels = [ + isObject(/*folder*/ ctx[5]?.slotLabel?.props) + ? /*folder*/ ctx[5].slotLabel.props + : {} + ]; + + var switch_value = /*folder*/ ctx[5].slotLabel.class; + + function switch_props(ctx, dirty) { + let switch_instance_props = {}; + + for (let i = 0; i < switch_instance_spread_levels.length; i += 1) { + switch_instance_props = assign(switch_instance_props, switch_instance_spread_levels[i]); + } + + if (dirty !== undefined && dirty[0] & /*folder*/ 32) { + switch_instance_props = assign(switch_instance_props, get_spread_update(switch_instance_spread_levels, [ + get_spread_object(isObject(/*folder*/ ctx[5]?.slotLabel?.props) + ? /*folder*/ ctx[5].slotLabel.props + : {}) + ])); + } + + return { props: switch_instance_props }; + } + + if (switch_value) { + switch_instance = construct_svelte_component(switch_value, switch_props(ctx)); + } + + return { + c() { + if (switch_instance) create_component(switch_instance.$$.fragment); + switch_instance_anchor = empty(); + }, + m(target, anchor) { + if (switch_instance) mount_component(switch_instance, target, anchor); + insert(target, switch_instance_anchor, anchor); + current = true; + }, + p(ctx, dirty) { + if (dirty[0] & /*folder*/ 32 && switch_value !== (switch_value = /*folder*/ ctx[5].slotLabel.class)) { + if (switch_instance) { + group_outros(); + const old_component = switch_instance; + + transition_out(old_component.$$.fragment, 1, 0, () => { + destroy_component(old_component, 1); + }); + + check_outros(); + } + + if (switch_value) { + switch_instance = construct_svelte_component(switch_value, switch_props(ctx, dirty)); + create_component(switch_instance.$$.fragment); + transition_in(switch_instance.$$.fragment, 1); + mount_component(switch_instance, switch_instance_anchor.parentNode, switch_instance_anchor); + } else { + switch_instance = null; + } + } else if (switch_value) { + const switch_instance_changes = (dirty[0] & /*folder*/ 32) + ? get_spread_update(switch_instance_spread_levels, [ + get_spread_object(isObject(/*folder*/ ctx[5]?.slotLabel?.props) + ? /*folder*/ ctx[5].slotLabel.props + : {}) + ]) + : {}; + + switch_instance.$set(switch_instance_changes); + } + }, + i(local) { + if (current) return; + if (switch_instance) transition_in(switch_instance.$$.fragment, local); + current = true; + }, + o(local) { + if (switch_instance) transition_out(switch_instance.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(switch_instance_anchor); + } + + if (switch_instance) destroy_component(switch_instance, detaching); + } + }; +} + +// (445:23) +function fallback_block_2(ctx) { + let show_if; + let current_block_type_index; + let if_block; + let if_block_anchor; + let current; + const if_block_creators = [create_if_block_3$2, create_else_block$2]; + const if_blocks = []; + + function select_block_type(ctx, dirty) { + if (dirty[0] & /*folder*/ 32) show_if = null; + if (show_if == null) show_if = !!TJSSvelteUtil.isComponent(/*folder*/ ctx[5]?.slotLabel?.class); + if (show_if) return 0; + return 1; + } + + current_block_type_index = select_block_type(ctx, [-1, -1]); + if_block = if_blocks[current_block_type_index] = if_block_creators[current_block_type_index](ctx); + + return { + c() { + if_block.c(); + if_block_anchor = empty(); + }, + m(target, anchor) { + if_blocks[current_block_type_index].m(target, anchor); + insert(target, if_block_anchor, anchor); + current = true; + }, + p(ctx, dirty) { + let previous_block_index = current_block_type_index; + current_block_type_index = select_block_type(ctx, dirty); + + if (current_block_type_index === previous_block_index) { + if_blocks[current_block_type_index].p(ctx, dirty); + } else { + group_outros(); + + transition_out(if_blocks[previous_block_index], 1, 1, () => { + if_blocks[previous_block_index] = null; + }); + + check_outros(); + if_block = if_blocks[current_block_type_index]; + + if (!if_block) { + if_block = if_blocks[current_block_type_index] = if_block_creators[current_block_type_index](ctx); + if_block.c(); + } else { + if_block.p(ctx, dirty); + } + + transition_in(if_block, 1); + if_block.m(if_block_anchor.parentNode, if_block_anchor); + } + }, + i(local) { + if (current) return; + transition_in(if_block); + current = true; + }, + o(local) { + transition_out(if_block); + current = false; + }, + d(detaching) { + if (detaching) { + detach(if_block_anchor); + } + + if_blocks[current_block_type_index].d(detaching); + } + }; +} + +// (454:9) {#if TJSSvelteUtil.isComponent(folder?.slotSummaryEnd?.class)} +function create_if_block_2$2(ctx) { + let switch_instance; + let switch_instance_anchor; + let current; + + const switch_instance_spread_levels = [ + isObject(/*folder*/ ctx[5]?.slotSummaryEnd?.props) + ? /*folder*/ ctx[5].slotSummaryEnd.props + : {} + ]; + + var switch_value = /*folder*/ ctx[5].slotSummaryEnd.class; + + function switch_props(ctx, dirty) { + let switch_instance_props = {}; + + for (let i = 0; i < switch_instance_spread_levels.length; i += 1) { + switch_instance_props = assign(switch_instance_props, switch_instance_spread_levels[i]); + } + + if (dirty !== undefined && dirty[0] & /*folder*/ 32) { + switch_instance_props = assign(switch_instance_props, get_spread_update(switch_instance_spread_levels, [ + get_spread_object(isObject(/*folder*/ ctx[5]?.slotSummaryEnd?.props) + ? /*folder*/ ctx[5].slotSummaryEnd.props + : {}) + ])); + } + + return { props: switch_instance_props }; + } + + if (switch_value) { + switch_instance = construct_svelte_component(switch_value, switch_props(ctx)); + } + + return { + c() { + if (switch_instance) create_component(switch_instance.$$.fragment); + switch_instance_anchor = empty(); + }, + m(target, anchor) { + if (switch_instance) mount_component(switch_instance, target, anchor); + insert(target, switch_instance_anchor, anchor); + current = true; + }, + p(ctx, dirty) { + if (dirty[0] & /*folder*/ 32 && switch_value !== (switch_value = /*folder*/ ctx[5].slotSummaryEnd.class)) { + if (switch_instance) { + group_outros(); + const old_component = switch_instance; + + transition_out(old_component.$$.fragment, 1, 0, () => { + destroy_component(old_component, 1); + }); + + check_outros(); + } + + if (switch_value) { + switch_instance = construct_svelte_component(switch_value, switch_props(ctx, dirty)); + create_component(switch_instance.$$.fragment); + transition_in(switch_instance.$$.fragment, 1); + mount_component(switch_instance, switch_instance_anchor.parentNode, switch_instance_anchor); + } else { + switch_instance = null; + } + } else if (switch_value) { + const switch_instance_changes = (dirty[0] & /*folder*/ 32) + ? get_spread_update(switch_instance_spread_levels, [ + get_spread_object(isObject(/*folder*/ ctx[5]?.slotSummaryEnd?.props) + ? /*folder*/ ctx[5].slotSummaryEnd.props + : {}) + ]) + : {}; + + switch_instance.$set(switch_instance_changes); + } + }, + i(local) { + if (current) return; + if (switch_instance) transition_in(switch_instance.$$.fragment, local); + current = true; + }, + o(local) { + if (switch_instance) transition_out(switch_instance.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(switch_instance_anchor); + } + + if (switch_instance) destroy_component(switch_instance, detaching); + } + }; +} + +// (453:31) +function fallback_block_1(ctx) { + let show_if = TJSSvelteUtil.isComponent(/*folder*/ ctx[5]?.slotSummaryEnd?.class); + let if_block_anchor; + let current; + let if_block = show_if && create_if_block_2$2(ctx); + + return { + c() { + if (if_block) if_block.c(); + if_block_anchor = empty(); + }, + m(target, anchor) { + if (if_block) if_block.m(target, anchor); + insert(target, if_block_anchor, anchor); + current = true; + }, + p(ctx, dirty) { + if (dirty[0] & /*folder*/ 32) show_if = TJSSvelteUtil.isComponent(/*folder*/ ctx[5]?.slotSummaryEnd?.class); + + if (show_if) { + if (if_block) { + if_block.p(ctx, dirty); + + if (dirty[0] & /*folder*/ 32) { + transition_in(if_block, 1); + } + } else { + if_block = create_if_block_2$2(ctx); + if_block.c(); + transition_in(if_block, 1); + if_block.m(if_block_anchor.parentNode, if_block_anchor); + } + } else if (if_block) { + group_outros(); + + transition_out(if_block, 1, 1, () => { + if_block = null; + }); + + check_outros(); + } + }, + i(local) { + if (current) return; + transition_in(if_block); + current = true; + }, + o(local) { + transition_out(if_block); + current = false; + }, + d(detaching) { + if (detaching) { + detach(if_block_anchor); + } + + if (if_block) if_block.d(detaching); + } + }; +} + +// (461:6) {#if visible} +function create_if_block$b(ctx) { + let current; + const default_slot_template = /*#slots*/ ctx[27].default; + const default_slot = create_slot(default_slot_template, ctx, /*$$scope*/ ctx[26], null); + const default_slot_or_fallback = default_slot || fallback_block(ctx); + + return { + c() { + if (default_slot_or_fallback) default_slot_or_fallback.c(); + }, + m(target, anchor) { + if (default_slot_or_fallback) { + default_slot_or_fallback.m(target, anchor); + } + + current = true; + }, + p(ctx, dirty) { + if (default_slot) { + if (default_slot.p && (!current || dirty[0] & /*$$scope*/ 67108864)) { + update_slot_base( + default_slot, + default_slot_template, + ctx, + /*$$scope*/ ctx[26], + !current + ? get_all_dirty_from_scope(/*$$scope*/ ctx[26]) + : get_slot_changes(default_slot_template, /*$$scope*/ ctx[26], dirty, null), + null + ); + } + } else { + if (default_slot_or_fallback && default_slot_or_fallback.p && (!current || dirty[0] & /*folder*/ 32)) { + default_slot_or_fallback.p(ctx, !current ? [-1, -1] : dirty); + } + } + }, + i(local) { + if (current) return; + transition_in(default_slot_or_fallback, local); + current = true; + }, + o(local) { + transition_out(default_slot_or_fallback, local); + current = false; + }, + d(detaching) { + if (default_slot_or_fallback) default_slot_or_fallback.d(detaching); + } + }; +} + +// (463:12) {#if TJSSvelteUtil.isComponent(folder?.slotDefault?.class)} +function create_if_block_1$2(ctx) { + let switch_instance; + let switch_instance_anchor; + let current; + + const switch_instance_spread_levels = [ + isObject(/*folder*/ ctx[5]?.slotDefault?.props) + ? /*folder*/ ctx[5].slotDefault.props + : {} + ]; + + var switch_value = /*folder*/ ctx[5].slotDefault.class; + + function switch_props(ctx, dirty) { + let switch_instance_props = {}; + + for (let i = 0; i < switch_instance_spread_levels.length; i += 1) { + switch_instance_props = assign(switch_instance_props, switch_instance_spread_levels[i]); + } + + if (dirty !== undefined && dirty[0] & /*folder*/ 32) { + switch_instance_props = assign(switch_instance_props, get_spread_update(switch_instance_spread_levels, [ + get_spread_object(isObject(/*folder*/ ctx[5]?.slotDefault?.props) + ? /*folder*/ ctx[5].slotDefault.props + : {}) + ])); + } + + return { props: switch_instance_props }; + } + + if (switch_value) { + switch_instance = construct_svelte_component(switch_value, switch_props(ctx)); + } + + return { + c() { + if (switch_instance) create_component(switch_instance.$$.fragment); + switch_instance_anchor = empty(); + }, + m(target, anchor) { + if (switch_instance) mount_component(switch_instance, target, anchor); + insert(target, switch_instance_anchor, anchor); + current = true; + }, + p(ctx, dirty) { + if (dirty[0] & /*folder*/ 32 && switch_value !== (switch_value = /*folder*/ ctx[5].slotDefault.class)) { + if (switch_instance) { + group_outros(); + const old_component = switch_instance; + + transition_out(old_component.$$.fragment, 1, 0, () => { + destroy_component(old_component, 1); + }); + + check_outros(); + } + + if (switch_value) { + switch_instance = construct_svelte_component(switch_value, switch_props(ctx, dirty)); + create_component(switch_instance.$$.fragment); + transition_in(switch_instance.$$.fragment, 1); + mount_component(switch_instance, switch_instance_anchor.parentNode, switch_instance_anchor); + } else { + switch_instance = null; + } + } else if (switch_value) { + const switch_instance_changes = (dirty[0] & /*folder*/ 32) + ? get_spread_update(switch_instance_spread_levels, [ + get_spread_object(isObject(/*folder*/ ctx[5]?.slotDefault?.props) + ? /*folder*/ ctx[5].slotDefault.props + : {}) + ]) + : {}; + + switch_instance.$set(switch_instance_changes); + } + }, + i(local) { + if (current) return; + if (switch_instance) transition_in(switch_instance.$$.fragment, local); + current = true; + }, + o(local) { + if (switch_instance) transition_out(switch_instance.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(switch_instance_anchor); + } + + if (switch_instance) destroy_component(switch_instance, detaching); + } + }; +} + +// (462:15) +function fallback_block(ctx) { + let show_if = TJSSvelteUtil.isComponent(/*folder*/ ctx[5]?.slotDefault?.class); + let if_block_anchor; + let current; + let if_block = show_if && create_if_block_1$2(ctx); + + return { + c() { + if (if_block) if_block.c(); + if_block_anchor = empty(); + }, + m(target, anchor) { + if (if_block) if_block.m(target, anchor); + insert(target, if_block_anchor, anchor); + current = true; + }, + p(ctx, dirty) { + if (dirty[0] & /*folder*/ 32) show_if = TJSSvelteUtil.isComponent(/*folder*/ ctx[5]?.slotDefault?.class); + + if (show_if) { + if (if_block) { + if_block.p(ctx, dirty); + + if (dirty[0] & /*folder*/ 32) { + transition_in(if_block, 1); + } + } else { + if_block = create_if_block_1$2(ctx); + if_block.c(); + transition_in(if_block, 1); + if_block.m(if_block_anchor.parentNode, if_block_anchor); + } + } else if (if_block) { + group_outros(); + + transition_out(if_block, 1, 1, () => { + if_block = null; + }); + + check_outros(); + } + }, + i(local) { + if (current) return; + transition_in(if_block); + current = true; + }, + o(local) { + transition_out(if_block); + current = false; + }, + d(detaching) { + if (detaching) { + detach(if_block_anchor); + } + + if (if_block) if_block.d(detaching); + } + }; +} + +function create_fragment$i(ctx) { + let details; + let summary; + let svg; + let path; + let t0; + let t1; + let t2; + let t3; + let div; + let toggleDetails_action; + let applyStyles_action; + let current; + let mounted; + let dispose; + let if_block0 = /*localOptions*/ ctx[8].focusIndicator && create_if_block_4$1(); + const label_slot_template = /*#slots*/ ctx[27].label; + const label_slot = create_slot(label_slot_template, ctx, /*$$scope*/ ctx[26], get_label_slot_context); + const label_slot_or_fallback = label_slot || fallback_block_2(ctx); + const summary_end_slot_template = /*#slots*/ ctx[27]["summary-end"]; + const summary_end_slot = create_slot(summary_end_slot_template, ctx, /*$$scope*/ ctx[26], get_summary_end_slot_context); + const summary_end_slot_or_fallback = summary_end_slot || fallback_block_1(ctx); + let if_block1 = /*visible*/ ctx[12] && create_if_block$b(ctx); + + return { + c() { + details = element("details"); + summary = element("summary"); + svg = svg_element("svg"); + path = svg_element("path"); + t0 = space(); + if (if_block0) if_block0.c(); + t1 = space(); + if (label_slot_or_fallback) label_slot_or_fallback.c(); + t2 = space(); + if (summary_end_slot_or_fallback) summary_end_slot_or_fallback.c(); + t3 = space(); + div = element("div"); + if (if_block1) if_block1.c(); + attr(path, "fill", "currentColor"); + attr(path, "stroke", "currentColor"); + set_style(path, "stroke-linejoin", "round"); + set_style(path, "stroke-width", "3"); + attr(path, "d", "M5,8L19,8L12,15Z"); + attr(svg, "viewBox", "0 0 24 24"); + attr(svg, "class", "svelte-9arcsc"); + toggle_class(svg, "focus-chevron", /*localOptions*/ ctx[8].focusChevron); + attr(summary, "role", "button"); + attr(summary, "tabindex", "0"); + attr(summary, "class", "svelte-9arcsc"); + toggle_class(summary, "default-cursor", /*localOptions*/ ctx[8].chevronOnly); + toggle_class(summary, "remove-focus-visible", /*localOptions*/ ctx[8].focusIndicator || /*localOptions*/ ctx[8].focusChevron); + attr(div, "class", "contents svelte-9arcsc"); + attr(details, "class", "tjs-svg-folder svelte-9arcsc"); + attr(details, "data-id", /*id*/ ctx[1]); + attr(details, "data-label", /*label*/ ctx[2]); + attr(details, "data-closing", "false"); + }, + m(target, anchor) { + insert(target, details, anchor); + append(details, summary); + append(summary, svg); + append(svg, path); + /*svg_binding*/ ctx[35](svg); + append(summary, t0); + if (if_block0) if_block0.m(summary, null); + append(summary, t1); + + if (label_slot_or_fallback) { + label_slot_or_fallback.m(summary, null); + } + + append(summary, t2); + + if (summary_end_slot_or_fallback) { + summary_end_slot_or_fallback.m(summary, null); + } + + /*summary_binding*/ ctx[37](summary); + append(details, t3); + append(details, div); + if (if_block1) if_block1.m(div, null); + /*details_binding*/ ctx[38](details); + current = true; + + if (!mounted) { + dispose = [ + listen(summary, "click", /*onClickSummary*/ ctx[13]), + listen(summary, "contextmenu", /*onContextMenuPress*/ ctx[14]), + listen(summary, "keydown", /*onKeyDown*/ ctx[15], true), + listen(summary, "keyup", /*onKeyUp*/ ctx[16], true), + listen(details, "close", /*onLocalClose*/ ctx[17]), + listen(details, "open", /*onLocalOpen*/ ctx[18]), + listen(details, "toggle", /*toggle_handler*/ ctx[39]), + listen(details, "click", /*click_handler*/ ctx[28]), + listen(details, "keydown", /*keydown_handler*/ ctx[29]), + listen(details, "keyup", /*keyup_handler*/ ctx[30]), + listen(details, "open", /*open_handler*/ ctx[31]), + listen(details, "close", /*close_handler*/ ctx[32]), + listen(details, "openAny", /*openAny_handler*/ ctx[33]), + listen(details, "closeAny", /*closeAny_handler*/ ctx[34]), + action_destroyer(toggleDetails_action = toggleDetails.call(null, details, { + store: /*store*/ ctx[3], + animate: /*animate*/ ctx[0], + clickActive: false + })), + action_destroyer(applyStyles_action = applyStyles.call(null, details, /*styles*/ ctx[4])) + ]; + + mounted = true; + } + }, + p(ctx, dirty) { + if (!current || dirty[0] & /*localOptions*/ 256) { + toggle_class(svg, "focus-chevron", /*localOptions*/ ctx[8].focusChevron); + } + + if (/*localOptions*/ ctx[8].focusIndicator) { + if (if_block0) ; else { + if_block0 = create_if_block_4$1(); + if_block0.c(); + if_block0.m(summary, t1); + } + } else if (if_block0) { + if_block0.d(1); + if_block0 = null; + } + + if (label_slot) { + if (label_slot.p && (!current || dirty[0] & /*$$scope*/ 67108864)) { + update_slot_base( + label_slot, + label_slot_template, + ctx, + /*$$scope*/ ctx[26], + !current + ? get_all_dirty_from_scope(/*$$scope*/ ctx[26]) + : get_slot_changes(label_slot_template, /*$$scope*/ ctx[26], dirty, get_label_slot_changes), + get_label_slot_context + ); + } + } else { + if (label_slot_or_fallback && label_slot_or_fallback.p && (!current || dirty[0] & /*folder, labelEl, label*/ 548)) { + label_slot_or_fallback.p(ctx, !current ? [-1, -1] : dirty); + } + } + + if (summary_end_slot) { + if (summary_end_slot.p && (!current || dirty[0] & /*$$scope*/ 67108864)) { + update_slot_base( + summary_end_slot, + summary_end_slot_template, + ctx, + /*$$scope*/ ctx[26], + !current + ? get_all_dirty_from_scope(/*$$scope*/ ctx[26]) + : get_slot_changes(summary_end_slot_template, /*$$scope*/ ctx[26], dirty, get_summary_end_slot_changes), + get_summary_end_slot_context + ); + } + } else { + if (summary_end_slot_or_fallback && summary_end_slot_or_fallback.p && (!current || dirty[0] & /*folder*/ 32)) { + summary_end_slot_or_fallback.p(ctx, !current ? [-1, -1] : dirty); + } + } + + if (!current || dirty[0] & /*localOptions*/ 256) { + toggle_class(summary, "default-cursor", /*localOptions*/ ctx[8].chevronOnly); + } + + if (!current || dirty[0] & /*localOptions*/ 256) { + toggle_class(summary, "remove-focus-visible", /*localOptions*/ ctx[8].focusIndicator || /*localOptions*/ ctx[8].focusChevron); + } + + if (/*visible*/ ctx[12]) { + if (if_block1) { + if_block1.p(ctx, dirty); + + if (dirty[0] & /*visible*/ 4096) { + transition_in(if_block1, 1); + } + } else { + if_block1 = create_if_block$b(ctx); + if_block1.c(); + transition_in(if_block1, 1); + if_block1.m(div, null); + } + } else if (if_block1) { + group_outros(); + + transition_out(if_block1, 1, 1, () => { + if_block1 = null; + }); + + check_outros(); + } + + if (!current || dirty[0] & /*id*/ 2) { + attr(details, "data-id", /*id*/ ctx[1]); + } + + if (!current || dirty[0] & /*label*/ 4) { + attr(details, "data-label", /*label*/ ctx[2]); + } + + if (toggleDetails_action && is_function(toggleDetails_action.update) && dirty[0] & /*store, animate*/ 9) toggleDetails_action.update.call(null, { + store: /*store*/ ctx[3], + animate: /*animate*/ ctx[0], + clickActive: false + }); + + if (applyStyles_action && is_function(applyStyles_action.update) && dirty[0] & /*styles*/ 16) applyStyles_action.update.call(null, /*styles*/ ctx[4]); + }, + i(local) { + if (current) return; + transition_in(label_slot_or_fallback, local); + transition_in(summary_end_slot_or_fallback, local); + transition_in(if_block1); + current = true; + }, + o(local) { + transition_out(label_slot_or_fallback, local); + transition_out(summary_end_slot_or_fallback, local); + transition_out(if_block1); + current = false; + }, + d(detaching) { + if (detaching) { + detach(details); + } + + /*svg_binding*/ ctx[35](null); + if (if_block0) if_block0.d(); + if (label_slot_or_fallback) label_slot_or_fallback.d(detaching); + if (summary_end_slot_or_fallback) summary_end_slot_or_fallback.d(detaching); + /*summary_binding*/ ctx[37](null); + if (if_block1) if_block1.d(); + /*details_binding*/ ctx[38](null); + mounted = false; + run_all(dispose); + } + }; +} + +function instance$h($$self, $$props, $$invalidate) { + let $store, + $$unsubscribe_store = noop, + $$subscribe_store = () => ($$unsubscribe_store(), $$unsubscribe_store = subscribe(store, $$value => $$invalidate(7, $store = $$value)), store); + + $$self.$$.on_destroy.push(() => $$unsubscribe_store()); + let { $$slots: slots = {}, $$scope } = $$props; + let { folder = void 0 } = $$props; + let { animate = void 0 } = $$props; + let { id = void 0 } = $$props; + let { label = void 0 } = $$props; + let { keyCode = void 0 } = $$props; + let { options = void 0 } = $$props; + let { store = void 0 } = $$props; + $$subscribe_store(); + let { styles = void 0 } = $$props; + let { onClose = void 0 } = $$props; + let { onOpen = void 0 } = $$props; + let { onContextMenu = void 0 } = $$props; + const application = getContext('#external')?.application; + + /** @type {TJSFolderOptions} */ + const localOptions = { + chevronOnly: false, + focusChevron: false, + focusIndicator: false + }; + + let detailsEl, labelEl, summaryEl, svgEl; + let storeUnsubscribe; + + // For performance reasons when the folder is closed the main slot is not rendered. + // When the folder is closed `visible` is set to false with a slight delay to allow the closing animation to + // complete. + let visible = $store; + + let timeoutId; + onDestroy(() => storeUnsubscribe()); + + /** + * Create a CustomEvent with details object containing relevant element and props. + * + * @param {string} type - Event name / type. + * + * @param {boolean} [bubbles=false] - Does the event bubble. + * + * @returns {CustomEvent} + */ + function createEvent(type, bubbles = false) { + return new CustomEvent(type, + { + detail: { + element: detailsEl, + folder, + id, + label, + store + }, + bubbles + }); + } + + /** + * Handles opening / closing the details element from either click or keyboard event when summary focused. + * + * @param {KeyboardEvent | PointerEvent} event - Event. + * + * @param {boolean} [fromKeyboard=false] - True when event is coming from keyboard. This is used to ignore the + * chevronOnly click event handling. + */ + function handleOpenClose(event, fromKeyboard = false) { + const target = event.target; + const chevronTarget = target === svgEl || svgEl.contains(target); + + if (target === summaryEl || target === labelEl || chevronTarget) { + if (!fromKeyboard && localOptions.chevronOnly && !chevronTarget) { + event.preventDefault(); + event.stopPropagation(); + return; + } + + set_store_value(store, $store = !$store, $store); + + if ($store && typeof onOpen === 'function') { + onOpen({ + event, + element: detailsEl, + folder, + id, + label, + store + }); + } else if (!$store && typeof onClose === 'function') { + onClose({ + event, + element: detailsEl, + folder, + id, + label, + store + }); + } + } + + event.preventDefault(); + event.stopPropagation(); + } + + /** + * Detects whether the summary click came from a pointer / mouse device or the keyboard. If from the keyboard and + * the active element is `summaryEl` then no action is taken and `onKeyDown` will handle the key event to open / + * close the detail element. + * + * @param {PointerEvent|MouseEvent} event + */ + function onClickSummary(event) { + const activeWindow = application?.reactive?.activeWindow ?? globalThis; + + // Firefox sends a `click` event / non-standard response so check for mozInputSource equaling 6 (keyboard) or + // a negative pointerId from Chromium and prevent default. This allows `onKeyUp` to handle any open / close + // action. + if (activeWindow.document.activeElement === summaryEl && (event?.pointerId === -1 || event?.mozInputSource === 6)) { + event.preventDefault(); + event.stopPropagation(); + return; + } + + handleOpenClose(event); + } + + /** + * Handles a context menu press forwarding the event to the handler. + * + * @param {PointerEvent} event - PointerEvent. + */ + function onContextMenuPress(event) { + if (typeof onContextMenu === 'function') { + onContextMenu({ event }); + } + } + + /** + * Detect if the key event came from the active tabbed / focused summary element and `options.keyCode` matches. + * + * @param {KeyboardEvent} event - + */ + function onKeyDown(event) { + const activeWindow = application?.reactive?.activeWindow ?? globalThis; + + if (activeWindow.document.activeElement === summaryEl && event.code === keyCode) { + event.preventDefault(); + event.stopPropagation(); + } + } + + /** + * Detect if the key event came from the active tabbed / focused summary element and `options.keyCode` matches. + * + * @param {KeyboardEvent} event - + */ + function onKeyUp(event) { + const activeWindow = application?.reactive?.activeWindow ?? globalThis; + + if (activeWindow.document.activeElement === summaryEl && event.code === keyCode) { + handleOpenClose(event, true); + event.preventDefault(); + event.stopPropagation(); + } + } + + /** + * Handle receiving bubbled event from summary or content to close details / content. + */ + function onLocalClose(event) { + event.preventDefault(); + event.stopPropagation(); + store.set(false); + } + + /** + * Handle receiving bubbled event from summary bar to open details / content. + */ + function onLocalOpen(event) { + event.preventDefault(); + event.stopPropagation(); + store.set(true); + } + + function click_handler(event) { + bubble.call(this, $$self, event); + } + + function keydown_handler(event) { + bubble.call(this, $$self, event); + } + + function keyup_handler(event) { + bubble.call(this, $$self, event); + } + + function open_handler(event) { + bubble.call(this, $$self, event); + } + + function close_handler(event) { + bubble.call(this, $$self, event); + } + + function openAny_handler(event) { + bubble.call(this, $$self, event); + } + + function closeAny_handler(event) { + bubble.call(this, $$self, event); + } + + function svg_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + svgEl = $$value; + $$invalidate(11, svgEl); + }); + } + + function div_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + labelEl = $$value; + $$invalidate(9, labelEl); + }); + } + + function summary_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + summaryEl = $$value; + $$invalidate(10, summaryEl); + }); + } + + function details_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + detailsEl = $$value; + $$invalidate(6, detailsEl); + }); + } + + const toggle_handler = () => $$invalidate(6, detailsEl.open = $store, detailsEl); + + $$self.$$set = $$props => { + if ('folder' in $$props) $$invalidate(5, folder = $$props.folder); + if ('animate' in $$props) $$invalidate(0, animate = $$props.animate); + if ('id' in $$props) $$invalidate(1, id = $$props.id); + if ('label' in $$props) $$invalidate(2, label = $$props.label); + if ('keyCode' in $$props) $$invalidate(19, keyCode = $$props.keyCode); + if ('options' in $$props) $$invalidate(20, options = $$props.options); + if ('store' in $$props) $$subscribe_store($$invalidate(3, store = $$props.store)); + if ('styles' in $$props) $$invalidate(4, styles = $$props.styles); + if ('onClose' in $$props) $$invalidate(21, onClose = $$props.onClose); + if ('onOpen' in $$props) $$invalidate(22, onOpen = $$props.onOpen); + if ('onContextMenu' in $$props) $$invalidate(23, onContextMenu = $$props.onContextMenu); + if ('$$scope' in $$props) $$invalidate(26, $$scope = $$props.$$scope); + }; + + $$self.$$.update = () => { + if ($$self.$$.dirty[0] & /*folder, animate*/ 33) { + $$invalidate(0, animate = isObject(folder) && typeof folder.animate === 'boolean' + ? folder.animate + : typeof animate === 'boolean' ? animate : true); + } + + if ($$self.$$.dirty[0] & /*folder, id*/ 34) { + $$invalidate(1, id = isObject(folder) && typeof folder.id === 'string' + ? folder.id + : typeof id === 'string' ? id : void 0); + } + + if ($$self.$$.dirty[0] & /*folder, label*/ 36) { + $$invalidate(2, label = isObject(folder) && typeof folder.label === 'string' + ? folder.label + : typeof label === 'string' ? label : ''); + } + + if ($$self.$$.dirty[0] & /*folder, keyCode*/ 524320) { + $$invalidate(19, keyCode = isObject(folder) && typeof folder.keyCode === 'string' + ? folder.keyCode + : typeof keyCode === 'string' ? keyCode : 'Enter'); + } + + if ($$self.$$.dirty[0] & /*folder, options*/ 1048608) { + { + $$invalidate(20, options = isObject(folder) && isObject(folder.options) + ? folder.options + : isObject(options) ? options : {}); + + if (typeof options?.chevronOnly === 'boolean') { + $$invalidate(8, localOptions.chevronOnly = options.chevronOnly, localOptions); + } + + if (typeof options?.focusChevron === 'boolean') { + $$invalidate(8, localOptions.focusChevron = options.focusChevron, localOptions); + } + + if (typeof options?.focusIndicator === 'boolean') { + $$invalidate(8, localOptions.focusIndicator = options.focusIndicator, localOptions); + } + } + } + + if ($$self.$$.dirty[0] & /*folder, store, storeUnsubscribe, detailsEl*/ 16777320) { + { + $$subscribe_store($$invalidate(3, store = isObject(folder) && isWritableStore(folder.store) + ? folder.store + : isWritableStore(store) ? store : writable(false))); + + if (typeof storeUnsubscribe === 'function') { + storeUnsubscribe(); + } + + // Manually subscribe to store in order to trigger only on changes; avoids initial dispatch on mount as `detailsEl` + // is not set yet. Directly dispatch custom events as Svelte 3 does not support bubbling of custom events by + // `createEventDispatcher`. + $$invalidate(24, storeUnsubscribe = subscribeIgnoreFirst(store, value => { + if (detailsEl) { + detailsEl.dispatchEvent(createEvent(value ? 'open' : 'close')); + detailsEl.dispatchEvent(createEvent(value ? 'openAny' : 'closeAny', true)); + } + })); + } + } + + if ($$self.$$.dirty[0] & /*folder, styles*/ 48) { + $$invalidate(4, styles = isObject(folder) && isObject(folder.styles) + ? folder.styles + : isObject(styles) ? styles : void 0); + } + + if ($$self.$$.dirty[0] & /*folder, onClose*/ 2097184) { + $$invalidate(21, onClose = isObject(folder) && typeof folder.onClose === 'function' + ? folder.onClose + : typeof onClose === 'function' ? onClose : void 0); + } + + if ($$self.$$.dirty[0] & /*folder, onOpen*/ 4194336) { + $$invalidate(22, onOpen = isObject(folder) && typeof folder.onOpen === 'function' + ? folder.onOpen + : typeof onOpen === 'function' ? onOpen : void 0); + } + + if ($$self.$$.dirty[0] & /*folder, onContextMenu*/ 8388640) { + $$invalidate(23, onContextMenu = isObject(folder) && typeof folder.onContextMenu === 'function' + ? folder.onContextMenu + : typeof onContextMenu === 'function' + ? onContextMenu + : void 0); + } + + if ($$self.$$.dirty[0] & /*$store, timeoutId*/ 33554560) { + if (!$store) { + $$invalidate(25, timeoutId = setTimeout(() => $$invalidate(12, visible = false), 500)); + } else { + clearTimeout(timeoutId); + $$invalidate(12, visible = true); + } + } + }; + + return [ + animate, + id, + label, + store, + styles, + folder, + detailsEl, + $store, + localOptions, + labelEl, + summaryEl, + svgEl, + visible, + onClickSummary, + onContextMenuPress, + onKeyDown, + onKeyUp, + onLocalClose, + onLocalOpen, + keyCode, + options, + onClose, + onOpen, + onContextMenu, + storeUnsubscribe, + timeoutId, + $$scope, + slots, + click_handler, + keydown_handler, + keyup_handler, + open_handler, + close_handler, + openAny_handler, + closeAny_handler, + svg_binding, + div_binding, + summary_binding, + details_binding, + toggle_handler + ]; +} + +class TJSSvgFolder extends SvelteComponent { + constructor(options) { + super(); + + init( + this, + options, + instance$h, + create_fragment$i, + safe_not_equal, + { + folder: 5, + animate: 0, + id: 1, + label: 2, + keyCode: 19, + options: 20, + store: 3, + styles: 4, + onClose: 21, + onOpen: 22, + onContextMenu: 23 + }, + null, + [-1, -1] + ); + } +} + +/* src\frontend\view\navigation\tree\Folder.svelte generated by Svelte v4.2.18 */ + +function get_each_context$6(ctx, list, i) { + const child_ctx = ctx.slice(); + child_ctx[14] = list[i]; + return child_ctx; +} + +// (71:6) {:else} +function create_else_block$1(ctx) { + let entry_1; + let current; + + entry_1 = new Entry({ + props: { + entry: /*child*/ ctx[14], + indentIcon: /*indentIcon*/ ctx[6], + removeIcon: !/*showModuleIcon*/ ctx[2] && /*child*/ ctx[14]?.kind === 2 + } + }); + + return { + c() { + create_component(entry_1.$$.fragment); + }, + m(target, anchor) { + mount_component(entry_1, target, anchor); + current = true; + }, + p(ctx, dirty) { + const entry_1_changes = {}; + if (dirty & /*entry*/ 1) entry_1_changes.entry = /*child*/ ctx[14]; + if (dirty & /*entry*/ 1) entry_1_changes.removeIcon = !/*showModuleIcon*/ ctx[2] && /*child*/ ctx[14]?.kind === 2; + entry_1.$set(entry_1_changes); + }, + i(local) { + if (current) return; + transition_in(entry_1.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(entry_1.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(entry_1, detaching); + } + }; +} + +// (69:6) {#if Array.isArray(child.children)} +function create_if_block$a(ctx) { + let folder_1; + let current; + + folder_1 = new Folder({ + props: { + entry: /*child*/ ctx[14], + parentIcon: !/*removeIcon*/ ctx[5] + } + }); + + return { + c() { + create_component(folder_1.$$.fragment); + }, + m(target, anchor) { + mount_component(folder_1, target, anchor); + current = true; + }, + p(ctx, dirty) { + const folder_1_changes = {}; + if (dirty & /*entry*/ 1) folder_1_changes.entry = /*child*/ ctx[14]; + folder_1.$set(folder_1_changes); + }, + i(local) { + if (current) return; + transition_in(folder_1.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(folder_1.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(folder_1, detaching); + } + }; +} + +// (68:3) {#each entry.children as child (child.path)} +function create_each_block$6(key_1, ctx) { + let first; + let show_if; + let current_block_type_index; + let if_block; + let if_block_anchor; + let current; + const if_block_creators = [create_if_block$a, create_else_block$1]; + const if_blocks = []; + + function select_block_type(ctx, dirty) { + if (dirty & /*entry*/ 1) show_if = null; + if (show_if == null) show_if = !!Array.isArray(/*child*/ ctx[14].children); + if (show_if) return 0; + return 1; + } + + current_block_type_index = select_block_type(ctx, -1); + if_block = if_blocks[current_block_type_index] = if_block_creators[current_block_type_index](ctx); + + return { + key: key_1, + first: null, + c() { + first = empty(); + if_block.c(); + if_block_anchor = empty(); + this.first = first; + }, + m(target, anchor) { + insert(target, first, anchor); + if_blocks[current_block_type_index].m(target, anchor); + insert(target, if_block_anchor, anchor); + current = true; + }, + p(new_ctx, dirty) { + ctx = new_ctx; + let previous_block_index = current_block_type_index; + current_block_type_index = select_block_type(ctx, dirty); + + if (current_block_type_index === previous_block_index) { + if_blocks[current_block_type_index].p(ctx, dirty); + } else { + group_outros(); + + transition_out(if_blocks[previous_block_index], 1, 1, () => { + if_blocks[previous_block_index] = null; + }); + + check_outros(); + if_block = if_blocks[current_block_type_index]; + + if (!if_block) { + if_block = if_blocks[current_block_type_index] = if_block_creators[current_block_type_index](ctx); + if_block.c(); + } else { + if_block.p(ctx, dirty); + } + + transition_in(if_block, 1); + if_block.m(if_block_anchor.parentNode, if_block_anchor); + } + }, + i(local) { + if (current) return; + transition_in(if_block); + current = true; + }, + o(local) { + transition_out(if_block); + current = false; + }, + d(detaching) { + if (detaching) { + detach(first); + detach(if_block_anchor); + } + + if_blocks[current_block_type_index].d(detaching); + } + }; +} + +// (66:0) +function create_default_slot$1(ctx) { + let each_blocks = []; + let each_1_lookup = new Map(); + let each_1_anchor; + let current; + let each_value = ensure_array_like(/*entry*/ ctx[0].children); + const get_key = ctx => /*child*/ ctx[14].path; + + for (let i = 0; i < each_value.length; i += 1) { + let child_ctx = get_each_context$6(ctx, each_value, i); + let key = get_key(child_ctx); + each_1_lookup.set(key, each_blocks[i] = create_each_block$6(key, child_ctx)); + } + + return { + c() { + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].c(); + } + + each_1_anchor = empty(); + }, + m(target, anchor) { + for (let i = 0; i < each_blocks.length; i += 1) { + if (each_blocks[i]) { + each_blocks[i].m(target, anchor); + } + } + + insert(target, each_1_anchor, anchor); + current = true; + }, + p(ctx, dirty) { + if (dirty & /*entry, removeIcon, Array, indentIcon, showModuleIcon*/ 101) { + each_value = ensure_array_like(/*entry*/ ctx[0].children); + group_outros(); + each_blocks = update_keyed_each(each_blocks, dirty, get_key, 1, ctx, each_value, each_1_lookup, each_1_anchor.parentNode, outro_and_destroy_block, create_each_block$6, each_1_anchor, get_each_context$6); + check_outros(); + } + }, + i(local) { + if (current) return; + + for (let i = 0; i < each_value.length; i += 1) { + transition_in(each_blocks[i]); + } + + current = true; + }, + o(local) { + for (let i = 0; i < each_blocks.length; i += 1) { + transition_out(each_blocks[i]); + } + + current = false; + }, + d(detaching) { + if (detaching) { + detach(each_1_anchor); + } + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].d(detaching); + } + } + }; +} + +// (67:3) +function create_label_slot(ctx) { + let entry_1; + let current; + + entry_1 = new Entry({ + props: { + entry: /*entry*/ ctx[0], + removeIcon: /*removeIcon*/ ctx[5], + storageKey: /*storageKey*/ ctx[4], + slot: "label" + } + }); + + return { + c() { + create_component(entry_1.$$.fragment); + }, + m(target, anchor) { + mount_component(entry_1, target, anchor); + current = true; + }, + p(ctx, dirty) { + const entry_1_changes = {}; + if (dirty & /*entry*/ 1) entry_1_changes.entry = /*entry*/ ctx[0]; + entry_1.$set(entry_1_changes); + }, + i(local) { + if (current) return; + transition_in(entry_1.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(entry_1.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(entry_1, detaching); + } + }; +} + +function create_fragment$h(ctx) { + let tjssvgfolder; + let current; + + tjssvgfolder = new TJSSvgFolder({ + props: { + folder: /*folder*/ ctx[7], + onClose: /*onClose*/ ctx[8], + onOpen: /*onOpen*/ ctx[9], + animate: /*$storeThemeAnimate*/ ctx[1], + $$slots: { + label: [create_label_slot], + default: [create_default_slot$1] + }, + $$scope: { ctx } + } + }); + + return { + c() { + create_component(tjssvgfolder.$$.fragment); + }, + m(target, anchor) { + mount_component(tjssvgfolder, target, anchor); + current = true; + }, + p(ctx, [dirty]) { + const tjssvgfolder_changes = {}; + if (dirty & /*$storeThemeAnimate*/ 2) tjssvgfolder_changes.animate = /*$storeThemeAnimate*/ ctx[1]; + + if (dirty & /*$$scope, entry*/ 131073) { + tjssvgfolder_changes.$$scope = { dirty, ctx }; + } + + tjssvgfolder.$set(tjssvgfolder_changes); + }, + i(local) { + if (current) return; + transition_in(tjssvgfolder.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(tjssvgfolder.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(tjssvgfolder, detaching); + } + }; +} + +function instance$g($$self, $$props, $$invalidate) { + let $storeThemeAnimate; + let { entry } = $$props; + let { parentIcon = false } = $$props; + + const { settingStores, showModuleIcon } = /** @type {DMTComponentData} */ + getContext('#dmtComponentData'); + + const storeThemeAnimate = settingStores.themeAnimate; + component_subscribe($$self, storeThemeAnimate, value => $$invalidate(1, $storeThemeAnimate = value)); + + /** @type {TreeState} */ + const treeState = getContext('#treeState'); + + const storageKey = entry.storageKey; + + const store = storageKey + ? treeState.sessionStorage.getStore(storageKey, false) + : void 0; + + const removeIcon = !showModuleIcon && (entry.kind === void 0 || entry.kind === 2); + const indentIcon = !removeIcon ? 'indent-icon' : 'indent-no-icon'; + + const folder = { + store, + options: { focusChevron: true }, + // Dynamically set the folder margin based on whether the parent folder has a svg icon. + styles: parentIcon + ? { + '--tjs-folder-details-margin-left': '3.5px' + } + : void 0 + }; + + /** + * Handle closing all child folders if the `Alt` key is pressed when this folder is closed. + * + * @param {{ event: MouseEvent | KeyboardEvent }} data - On close data. + */ + function onClose(data) { + if (data?.event?.altKey) { + treeState.setChildFolderState(entry, false); + } + } + + /** + * Handle opening all child folders if the `Alt` key is pressed when this folder is opened. + * + * @param {{ event: MouseEvent | KeyboardEvent }} data - On open data. + */ + function onOpen(data) { + if (data?.event?.altKey) { + treeState.setChildFolderState(entry, true); + } + } + + $$self.$$set = $$props => { + if ('entry' in $$props) $$invalidate(0, entry = $$props.entry); + if ('parentIcon' in $$props) $$invalidate(10, parentIcon = $$props.parentIcon); + }; + + return [ + entry, + $storeThemeAnimate, + showModuleIcon, + storeThemeAnimate, + storageKey, + removeIcon, + indentIcon, + folder, + onClose, + onOpen, + parentIcon + ]; +} + +class Folder extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$g, create_fragment$h, safe_not_equal, { entry: 0, parentIcon: 10 }); + } +} + +/* src\frontend\view\navigation\tree\NavigationTree.svelte generated by Svelte v4.2.18 */ + +function get_each_context$5(ctx, list, i) { + const child_ctx = ctx.slice(); + child_ctx[8] = list[i]; + return child_ctx; +} + +// (56:6) {:else} +function create_else_block(ctx) { + let entry_1; + let current; + + entry_1 = new Entry({ + props: { + entry: /*entry*/ ctx[8], + indentIcon: /*indentIcon*/ ctx[4], + removeIcon: !/*showModuleIcon*/ ctx[2] && /*entry*/ ctx[8]?.kind === 2 + } + }); + + return { + c() { + create_component(entry_1.$$.fragment); + }, + m(target, anchor) { + mount_component(entry_1, target, anchor); + current = true; + }, + p(ctx, dirty) { + const entry_1_changes = {}; + if (dirty & /*treeState*/ 1) entry_1_changes.entry = /*entry*/ ctx[8]; + if (dirty & /*treeState*/ 1) entry_1_changes.removeIcon = !/*showModuleIcon*/ ctx[2] && /*entry*/ ctx[8]?.kind === 2; + entry_1.$set(entry_1_changes); + }, + i(local) { + if (current) return; + transition_in(entry_1.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(entry_1.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(entry_1, detaching); + } + }; +} + +// (54:6) {#if Array.isArray(entry.children)} +function create_if_block$9(ctx) { + let folder; + let current; + folder = new Folder({ props: { entry: /*entry*/ ctx[8] } }); + + return { + c() { + create_component(folder.$$.fragment); + }, + m(target, anchor) { + mount_component(folder, target, anchor); + current = true; + }, + p(ctx, dirty) { + const folder_changes = {}; + if (dirty & /*treeState*/ 1) folder_changes.entry = /*entry*/ ctx[8]; + folder.$set(folder_changes); + }, + i(local) { + if (current) return; + transition_in(folder.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(folder.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(folder, detaching); + } + }; +} + +// (53:3) {#each treeState.elementIndex as entry (entry.path)} +function create_each_block$5(key_1, ctx) { + let first; + let show_if; + let current_block_type_index; + let if_block; + let if_block_anchor; + let current; + const if_block_creators = [create_if_block$9, create_else_block]; + const if_blocks = []; + + function select_block_type(ctx, dirty) { + if (dirty & /*treeState*/ 1) show_if = null; + if (show_if == null) show_if = !!Array.isArray(/*entry*/ ctx[8].children); + if (show_if) return 0; + return 1; + } + + current_block_type_index = select_block_type(ctx, -1); + if_block = if_blocks[current_block_type_index] = if_block_creators[current_block_type_index](ctx); + + return { + key: key_1, + first: null, + c() { + first = empty(); + if_block.c(); + if_block_anchor = empty(); + this.first = first; + }, + m(target, anchor) { + insert(target, first, anchor); + if_blocks[current_block_type_index].m(target, anchor); + insert(target, if_block_anchor, anchor); + current = true; + }, + p(new_ctx, dirty) { + ctx = new_ctx; + let previous_block_index = current_block_type_index; + current_block_type_index = select_block_type(ctx, dirty); + + if (current_block_type_index === previous_block_index) { + if_blocks[current_block_type_index].p(ctx, dirty); + } else { + group_outros(); + + transition_out(if_blocks[previous_block_index], 1, 1, () => { + if_blocks[previous_block_index] = null; + }); + + check_outros(); + if_block = if_blocks[current_block_type_index]; + + if (!if_block) { + if_block = if_blocks[current_block_type_index] = if_block_creators[current_block_type_index](ctx); + if_block.c(); + } else { + if_block.p(ctx, dirty); + } + + transition_in(if_block, 1); + if_block.m(if_block_anchor.parentNode, if_block_anchor); + } + }, + i(local) { + if (current) return; + transition_in(if_block); + current = true; + }, + o(local) { + transition_out(if_block); + current = false; + }, + d(detaching) { + if (detaching) { + detach(first); + detach(if_block_anchor); + } + + if_blocks[current_block_type_index].d(detaching); + } + }; +} + +function create_fragment$g(ctx) { + let div; + let each_blocks = []; + let each_1_lookup = new Map(); + let current; + let mounted; + let dispose; + let each_value = ensure_array_like(/*treeState*/ ctx[0].elementIndex); + const get_key = ctx => /*entry*/ ctx[8].path; + + for (let i = 0; i < each_value.length; i += 1) { + let child_ctx = get_each_context$5(ctx, each_value, i); + let key = get_key(child_ctx); + each_1_lookup.set(key, each_blocks[i] = create_each_block$5(key, child_ctx)); + } + + return { + c() { + div = element("div"); + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].c(); + } + + attr(div, "class", "dmt-navigation-content svelte-cugiyd"); + attr(div, "tabindex", "-1"); + }, + m(target, anchor) { + insert(target, div, anchor); + + for (let i = 0; i < each_blocks.length; i += 1) { + if (each_blocks[i]) { + each_blocks[i].m(div, null); + } + } + + /*div_binding*/ ctx[6](div); + current = true; + + if (!mounted) { + dispose = listen(div, "keydown", onKeydown, true); + mounted = true; + } + }, + p(ctx, [dirty]) { + if (dirty & /*treeState, Array, indentIcon, showModuleIcon*/ 21) { + each_value = ensure_array_like(/*treeState*/ ctx[0].elementIndex); + group_outros(); + each_blocks = update_keyed_each(each_blocks, dirty, get_key, 1, ctx, each_value, each_1_lookup, div, outro_and_destroy_block, create_each_block$5, null, get_each_context$5); + check_outros(); + } + }, + i(local) { + if (current) return; + + for (let i = 0; i < each_value.length; i += 1) { + transition_in(each_blocks[i]); + } + + current = true; + }, + o(local) { + for (let i = 0; i < each_blocks.length; i += 1) { + transition_out(each_blocks[i]); + } + + current = false; + }, + d(detaching) { + if (detaching) { + detach(div); + } + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].d(); + } + + /*div_binding*/ ctx[6](null); + mounted = false; + dispose(); + } + }; +} + +function onKeydown(event) { + if (event.code === 'Space') { + event.preventDefault(); + } +} + +function instance$f($$self, $$props, $$invalidate) { + let $storeCurrentPathURL; + let { treeState } = $$props; + setContext('#treeState', treeState); + + const { navigation, showModuleIcon } = /** @type {DMTComponentData} */ + getContext('#dmtComponentData'); + + const { storeCurrentPathURL } = navigation; + component_subscribe($$self, storeCurrentPathURL, value => $$invalidate(5, $storeCurrentPathURL = value)); + let navigationEl; + + // Always indent first level entries to match any module / namespace entries w/ children. + const indentIcon = treeState.hasFolders ? 'indent-no-icon' : 'indent-none'; + + function div_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + navigationEl = $$value; + $$invalidate(1, navigationEl); + }); + } + + $$self.$$set = $$props => { + if ('treeState' in $$props) $$invalidate(0, treeState = $$props.treeState); + }; + + $$self.$$.update = () => { + if ($$self.$$.dirty & /*$storeCurrentPathURL, navigationEl*/ 34) { + if ($storeCurrentPathURL) { + // Wait for the next animation frame as this will ensure multiple levels of tree nodes opening. + nextAnimationFrame().then(() => { + const targetEl = navigationEl.querySelector(`a[href*="${$storeCurrentPathURL}"]`); + + if (targetEl) { + targetEl.scrollIntoView({ block: 'center', inline: 'center' }); + } + }); + } + } + }; + + return [ + treeState, + navigationEl, + showModuleIcon, + storeCurrentPathURL, + indentIcon, + $storeCurrentPathURL, + div_binding + ]; +} + +class NavigationTree extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$f, create_fragment$g, safe_not_equal, { treeState: 0 }); + } +} + +/* src\frontend\view\navigation\panels\DocumentIndex.svelte generated by Svelte v4.2.18 */ + +function create_if_block$8(ctx) { + let section; + let tjssvgfolder; + let current; + + tjssvgfolder = new TJSSvgFolder({ + props: { + folder: /*folder*/ ctx[4], + animate: /*$storeThemeAnimate*/ ctx[0], + $$slots: { default: [create_default_slot] }, + $$scope: { ctx } + } + }); + + return { + c() { + section = element("section"); + create_component(tjssvgfolder.$$.fragment); + attr(section, "class", "dmt-document-index svelte-o6ftwg"); + }, + m(target, anchor) { + insert(target, section, anchor); + mount_component(tjssvgfolder, section, null); + current = true; + }, + p(ctx, dirty) { + const tjssvgfolder_changes = {}; + if (dirty & /*$storeThemeAnimate*/ 1) tjssvgfolder_changes.animate = /*$storeThemeAnimate*/ ctx[0]; + + if (dirty & /*$$scope*/ 512) { + tjssvgfolder_changes.$$scope = { dirty, ctx }; + } + + tjssvgfolder.$set(tjssvgfolder_changes); + }, + i(local) { + if (current) return; + transition_in(tjssvgfolder.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(tjssvgfolder.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(section); + } + + destroy_component(tjssvgfolder); + } + }; +} + +// (29:6) +function create_default_slot(ctx) { + let hr; + let t; + let navigationtree; + let current; + + navigationtree = new NavigationTree({ + props: { + treeState: /*navigation*/ ctx[1].treeState.markdown + } + }); + + return { + c() { + hr = element("hr"); + t = space(); + create_component(navigationtree.$$.fragment); + attr(hr, "class", "svelte-o6ftwg"); + }, + m(target, anchor) { + insert(target, hr, anchor); + insert(target, t, anchor); + mount_component(navigationtree, target, anchor); + current = true; + }, + p: noop, + i(local) { + if (current) return; + transition_in(navigationtree.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(navigationtree.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(hr); + detach(t); + } + + destroy_component(navigationtree, detaching); + } + }; +} + +function create_fragment$f(ctx) { + let if_block_anchor; + let current; + let if_block = /*navigation*/ ctx[1].treeState.markdown.hasData && create_if_block$8(ctx); + + return { + c() { + if (if_block) if_block.c(); + if_block_anchor = empty(); + }, + m(target, anchor) { + if (if_block) if_block.m(target, anchor); + insert(target, if_block_anchor, anchor); + current = true; + }, + p(ctx, [dirty]) { + if (/*navigation*/ ctx[1].treeState.markdown.hasData) if_block.p(ctx, dirty); + }, + i(local) { + if (current) return; + transition_in(if_block); + current = true; + }, + o(local) { + transition_out(if_block); + current = false; + }, + d(detaching) { + if (detaching) { + detach(if_block_anchor); + } + + if (if_block) if_block.d(detaching); + } + }; +} + +function instance$e($$self, $$props, $$invalidate) { + let $store; + let $storeThemeAnimate; + + const { dmtSessionStorage, navigation, settingStores, storagePrepend } = /** @type {DMTComponentData} */ + getContext('#dmtComponentData'); + + const storeThemeAnimate = settingStores.themeAnimate; + component_subscribe($$self, storeThemeAnimate, value => $$invalidate(0, $storeThemeAnimate = value)); + const store = dmtSessionStorage.getStore(`${storagePrepend}-document-index`, false); + component_subscribe($$self, store, value => $$invalidate(5, $store = value)); + + // If the active tree is the markdown tree then ensure that the document index is open. + if (navigation.treeState.activeTreeName === 'markdown') { + set_store_value(store, $store = true, $store); + } + + const folder = { + store, + label: 'Document Index', + options: { focusChevron: true } + }; + + return [$storeThemeAnimate, navigation, storeThemeAnimate, store, folder]; +} + +class DocumentIndex extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$e, create_fragment$f, safe_not_equal, {}); + } +} + +/* src\frontend\view\navigation\panels\SidebarLinks.svelte generated by Svelte v4.2.18 */ + +function get_each_context$4(ctx, list, i) { + const child_ctx = ctx.slice(); + child_ctx[2] = list[i]; + return child_ctx; +} + +// (9:0) {#if hasLinks} +function create_if_block$7(ctx) { + let section; + let each_blocks = []; + let each_1_lookup = new Map(); + let each_value = ensure_array_like(Object.keys(/*sidebarLinks*/ ctx[0])); + const get_key = ctx => /*sidebarLinks*/ ctx[0][/*key*/ ctx[2]]; + + for (let i = 0; i < each_value.length; i += 1) { + let child_ctx = get_each_context$4(ctx, each_value, i); + let key = get_key(child_ctx); + each_1_lookup.set(key, each_blocks[i] = create_each_block$4(key, child_ctx)); + } + + return { + c() { + section = element("section"); + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].c(); + } + + attr(section, "class", "svelte-ietkuq"); + }, + m(target, anchor) { + insert(target, section, anchor); + + for (let i = 0; i < each_blocks.length; i += 1) { + if (each_blocks[i]) { + each_blocks[i].m(section, null); + } + } + }, + p(ctx, dirty) { + if (dirty & /*sidebarLinks, Object*/ 1) { + each_value = ensure_array_like(Object.keys(/*sidebarLinks*/ ctx[0])); + each_blocks = update_keyed_each(each_blocks, dirty, get_key, 1, ctx, each_value, each_1_lookup, section, destroy_block, create_each_block$4, null, get_each_context$4); + } + }, + d(detaching) { + if (detaching) { + detach(section); + } + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].d(); + } + } + }; +} + +// (11:6) {#each Object.keys(sidebarLinks) as key (sidebarLinks[key])} +function create_each_block$4(key_2, ctx) { + let a; + let span; + + return { + key: key_2, + first: null, + c() { + a = element("a"); + span = element("span"); + span.textContent = `${/*key*/ ctx[2]}`; + attr(a, "href", `${/*sidebarLinks*/ ctx[0][/*key*/ ctx[2]]}`); + attr(a, "target", "_blank"); + attr(a, "class", "svelte-ietkuq"); + this.first = a; + }, + m(target, anchor) { + insert(target, a, anchor); + append(a, span); + }, + p(new_ctx, dirty) { + ctx = new_ctx; + }, + d(detaching) { + if (detaching) { + detach(a); + } + } + }; +} + +function create_fragment$e(ctx) { + let if_block_anchor; + let if_block = /*hasLinks*/ ctx[1] && create_if_block$7(ctx); + + return { + c() { + if (if_block) if_block.c(); + if_block_anchor = empty(); + }, + m(target, anchor) { + if (if_block) if_block.m(target, anchor); + insert(target, if_block_anchor, anchor); + }, + p(ctx, [dirty]) { + if (/*hasLinks*/ ctx[1]) if_block.p(ctx, dirty); + }, + i: noop, + o: noop, + d(detaching) { + if (detaching) { + detach(if_block_anchor); + } + + if (if_block) if_block.d(detaching); + } + }; +} + +function instance$d($$self) { + const { sidebarLinks } = /** @type {DMTComponentData} */ getContext('#dmtComponentData'); + const hasLinks = Object.keys(sidebarLinks).length > 0; + return [sidebarLinks, hasLinks]; +} + +class SidebarLinks extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$d, create_fragment$e, safe_not_equal, {}); + } +} + +/* +Adapted from https://github.com/mattdesl +Distributed under MIT License https://github.com/mattdesl/eases/blob/master/LICENSE.md +*/ + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function backInOut(t) { + const s = 1.70158 * 1.525; + if ((t *= 2) < 1) return 0.5 * (t * t * ((s + 1) * t - s)); + return 0.5 * ((t -= 2) * t * ((s + 1) * t + s) + 2); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function backIn(t) { + const s = 1.70158; + return t * t * ((s + 1) * t - s); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function backOut(t) { + const s = 1.70158; + return --t * t * ((s + 1) * t + s) + 1; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function bounceOut(t) { + const a = 4.0 / 11.0; + const b = 8.0 / 11.0; + const c = 9.0 / 10.0; + const ca = 4356.0 / 361.0; + const cb = 35442.0 / 1805.0; + const cc = 16061.0 / 1805.0; + const t2 = t * t; + return t < a + ? 7.5625 * t2 + : t < b + ? 9.075 * t2 - 9.9 * t + 3.4 + : t < c + ? ca * t2 - cb * t + cc + : 10.8 * t * t - 20.52 * t + 10.72; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function bounceInOut(t) { + return t < 0.5 ? 0.5 * (1.0 - bounceOut(1.0 - t * 2.0)) : 0.5 * bounceOut(t * 2.0 - 1.0) + 0.5; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function bounceIn(t) { + return 1.0 - bounceOut(1.0 - t); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function circInOut(t) { + if ((t *= 2) < 1) return -0.5 * (Math.sqrt(1 - t * t) - 1); + return 0.5 * (Math.sqrt(1 - (t -= 2) * t) + 1); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function circIn(t) { + return 1.0 - Math.sqrt(1.0 - t * t); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function circOut(t) { + return Math.sqrt(1 - --t * t); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function cubicInOut(t) { + return t < 0.5 ? 4.0 * t * t * t : 0.5 * Math.pow(2.0 * t - 2.0, 3.0) + 1.0; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function cubicIn(t) { + return t * t * t; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function cubicOut(t) { + const f = t - 1.0; + return f * f * f + 1.0; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function elasticInOut(t) { + return t < 0.5 + ? 0.5 * Math.sin(((+13.0 * Math.PI) / 2) * 2.0 * t) * Math.pow(2.0, 10.0 * (2.0 * t - 1.0)) + : 0.5 * + Math.sin(((-13.0 * Math.PI) / 2) * (2.0 * t - 1.0 + 1.0)) * + Math.pow(2.0, -10.0 * (2.0 * t - 1.0)) + + 1.0; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function elasticIn(t) { + return Math.sin((13.0 * t * Math.PI) / 2) * Math.pow(2.0, 10.0 * (t - 1.0)); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function elasticOut(t) { + return Math.sin((-13.0 * (t + 1.0) * Math.PI) / 2) * Math.pow(2.0, -10.0 * t) + 1.0; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function expoInOut(t) { + return t === 0.0 || t === 1.0 + ? t + : t < 0.5 + ? +0.5 * Math.pow(2.0, 20.0 * t - 10.0) + : -0.5 * Math.pow(2.0, 10.0 - t * 20.0) + 1.0; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function expoIn(t) { + return t === 0.0 ? t : Math.pow(2.0, 10.0 * (t - 1.0)); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function expoOut(t) { + return t === 1.0 ? t : 1.0 - Math.pow(2.0, -10.0 * t); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function quadInOut(t) { + t /= 0.5; + if (t < 1) return 0.5 * t * t; + t--; + return -0.5 * (t * (t - 2) - 1); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function quadIn(t) { + return t * t; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function quadOut(t) { + return -t * (t - 2.0); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function quartInOut(t) { + return t < 0.5 ? +8.0 * Math.pow(t, 4.0) : -8.0 * Math.pow(t - 1.0, 4.0) + 1.0; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function quartIn(t) { + return Math.pow(t, 4.0); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function quartOut(t) { + return Math.pow(t - 1.0, 3.0) * (1.0 - t) + 1.0; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function quintInOut(t) { + if ((t *= 2) < 1) return 0.5 * t * t * t * t * t; + return 0.5 * ((t -= 2) * t * t * t * t + 2); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function quintIn(t) { + return t * t * t * t * t; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function quintOut(t) { + return --t * t * t * t * t + 1; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function sineInOut(t) { + return -0.5 * (Math.cos(Math.PI * t) - 1); +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function sineIn(t) { + const v = Math.cos(t * Math.PI * 0.5); + if (Math.abs(v) < 1e-14) return 1; + else return 1 - v; +} + +/** + * https://svelte.dev/docs/svelte-easing + * @param {number} t + * @returns {number} + */ +function sineOut(t) { + return Math.sin((t * Math.PI) / 2); +} + +const svelteEasingFunc = /*#__PURE__*/Object.freeze({ + __proto__: null, + backIn: backIn, + backInOut: backInOut, + backOut: backOut, + bounceIn: bounceIn, + bounceInOut: bounceInOut, + bounceOut: bounceOut, + circIn: circIn, + circInOut: circInOut, + circOut: circOut, + cubicIn: cubicIn, + cubicInOut: cubicInOut, + cubicOut: cubicOut, + elasticIn: elasticIn, + elasticInOut: elasticInOut, + elasticOut: elasticOut, + expoIn: expoIn, + expoInOut: expoInOut, + expoOut: expoOut, + linear: identity, + quadIn: quadIn, + quadInOut: quadInOut, + quadOut: quadOut, + quartIn: quartIn, + quartInOut: quartInOut, + quartOut: quartOut, + quintIn: quintIn, + quintInOut: quintInOut, + quintOut: quintOut, + sineIn: sineIn, + sineInOut: sineInOut, + sineOut: sineOut +}); + +/** + * @type {Readonly>} + */ +const easingFunc = svelteEasingFunc; + +/** + * Performs a lookup for standard Svelte easing functions by name. For convenience if passing in a function it is + * returned verbatim. + * + * @param {import('./types').EasingReference} easingRef - The name of a standard Svelte easing function or a supplied + * easing function. + * + * @param {object} [options] - Optional parameters. + * + * @param {import('./types').EasingFunctionName | false} [options.default='linear'] - A default easing function by + * name to return. When specified as `false` no default fallback easing function is selected. The default value + * is `linear`. + * + * @returns {import('#runtime/svelte/easing').EasingFunction} The requested easing function. + */ +function getEasingFunc(easingRef, options) +{ + if (typeof easingRef === 'function') { return easingRef; } + + const easingFn = easingFunc[easingRef]; + + return easingFn ? easingFn : easingFunc['linear']; +} + +/** + * Animates the opacity of an element from 0 to the current opacity for `in` transitions and from the current opacity to 0 for `out` transitions. + * + * https://svelte.dev/docs/svelte-transition#fade + * @param {Element} node + * @param {import('./public').FadeParams} [params] + * @returns {import('./public').TransitionConfig} + */ +function fade(node, { delay = 0, duration = 400, easing = identity } = {}) { + const o = +getComputedStyle(node).opacity; + return { + delay, + duration, + easing, + css: (t) => `opacity: ${t * o}` + }; +} + +/** + * Slides an element in and out. + * + * https://svelte.dev/docs/svelte-transition#slide + * @param {Element} node + * @param {import('./public').SlideParams} [params] + * @returns {import('./public').TransitionConfig} + */ +function slide(node, { delay = 0, duration = 400, easing = cubicOut, axis = 'y' } = {}) { + const style = getComputedStyle(node); + const opacity = +style.opacity; + const primary_property = axis === 'y' ? 'height' : 'width'; + const primary_property_value = parseFloat(style[primary_property]); + const secondary_properties = axis === 'y' ? ['top', 'bottom'] : ['left', 'right']; + const capitalized_secondary_properties = secondary_properties.map( + (e) => `${e[0].toUpperCase()}${e.slice(1)}` + ); + const padding_start_value = parseFloat(style[`padding${capitalized_secondary_properties[0]}`]); + const padding_end_value = parseFloat(style[`padding${capitalized_secondary_properties[1]}`]); + const margin_start_value = parseFloat(style[`margin${capitalized_secondary_properties[0]}`]); + const margin_end_value = parseFloat(style[`margin${capitalized_secondary_properties[1]}`]); + const border_width_start_value = parseFloat( + style[`border${capitalized_secondary_properties[0]}Width`] + ); + const border_width_end_value = parseFloat( + style[`border${capitalized_secondary_properties[1]}Width`] + ); + return { + delay, + duration, + easing, + css: (t) => + 'overflow: hidden;' + + `opacity: ${Math.min(t * 20, 1) * opacity};` + + `${primary_property}: ${t * primary_property_value}px;` + + `padding-${secondary_properties[0]}: ${t * padding_start_value}px;` + + `padding-${secondary_properties[1]}: ${t * padding_end_value}px;` + + `margin-${secondary_properties[0]}: ${t * margin_start_value}px;` + + `margin-${secondary_properties[1]}: ${t * margin_end_value}px;` + + `border-${secondary_properties[0]}-width: ${t * border_width_start_value}px;` + + `border-${secondary_properties[1]}-width: ${t * border_width_end_value}px;` + }; +} + +/** + * Combines slide & fade transitions into a single transition. For options `easing` this is applied to both transitions, + * however if provided `easingSlide` and / or `easingFade` will take precedence. The default easing is linear. + * + * @param {HTMLElement} node - The transition node. + * + * @param {object} [options] - Optional parameters. + * + * @param {'x' | 'y'} [options.axis] - The sliding axis. + * + * @param {number} [options.delay] - Delay in ms before start of transition. + * + * @param {number} [options.duration] - Total transition length in ms. + * + * @param {import('#runtime/svelte/easing').EasingReference} [options.easing=linear] - Easing function name or + * function to apply to both slide & fade transitions. + * + * @param {import('#runtime/svelte/easing').EasingReference} [options.easingFade=linear] - Easing function name or + * function to apply to the fade transition. + * + * @param {import('#runtime/svelte/easing').EasingReference} [options.easingSlide=linear] - Easing function name or + * function to apply to the slide transition. + * + * @returns {import('svelte/transition').TransitionConfig} Transition config. + */ +function slideFade(node, options) +{ + const fadeEasing = getEasingFunc(options.easingFade ?? options.easing); + const slideEasing = getEasingFunc(options.easingSlide ?? options.easing); + + const fadeTransition = fade(node); + const slideTransition = slide(node, { axis: options.axis }); + + return { + delay: options.delay ?? 0, + duration: options.duration ?? 500, + easing: identity, + css: (t) => + { + const fadeT = fadeEasing(t); + const slideT = slideEasing(t); + return `${slideTransition.css(slideT, 1 - slideT)}; ${fadeTransition.css(fadeT, 1 - fadeT)}`; + } + }; +} + +/* src\frontend\view\navigation\panels\source\HelpPanel.svelte generated by Svelte v4.2.18 */ + +function get_each_context$3(ctx, list, i) { + const child_ctx = ctx.slice(); + child_ctx[13] = list[i]; + return child_ctx; +} + +// (36:6) {#each reflectionData as entry (entry.value)} +function create_each_block$3(key_1, ctx) { + let span; + let svg; + let use; + let t0; + let t1_value = /*entry*/ ctx[13].key + ""; + let t1; + let t2; + + return { + key: key_1, + first: null, + c() { + span = element("span"); + svg = svg_element("svg"); + use = svg_element("use"); + t0 = space(); + t1 = text(t1_value); + t2 = space(); + attr(use, "href", `#icon-${/*entry*/ ctx[13].value}`); + attr(svg, "class", "tsd-kind-icon svelte-1uxeem0"); + attr(svg, "viewBox", "0 0 24 24"); + attr(span, "class", "svelte-1uxeem0"); + this.first = span; + }, + m(target, anchor) { + insert(target, span, anchor); + append(span, svg); + append(svg, use); + append(span, t0); + append(span, t1); + append(span, t2); + }, + p(new_ctx, dirty) { + ctx = new_ctx; + }, + d(detaching) { + if (detaching) { + detach(span); + } + } + }; +} + +// (46:3) {#if hasMarkdownFolders} +function create_if_block_4(ctx) { + let span; + + return { + c() { + span = element("span"); + span.innerHTML = `Alt + DOpen / focus "Document Index"`; + attr(span, "class", "svelte-1uxeem0"); + }, + m(target, anchor) { + insert(target, span, anchor); + }, + d(detaching) { + if (detaching) { + detach(span); + } + } + }; +} + +// (47:3) {#if hasSourceFolders} +function create_if_block_3$1(ctx) { + let span; + + return { + c() { + span = element("span"); + span.innerHTML = `Alt + ESource (Nav) open / close all`; + attr(span, "class", "svelte-1uxeem0"); + }, + m(target, anchor) { + insert(target, span, anchor); + }, + d(detaching) { + if (detaching) { + detach(span); + } + } + }; +} + +// (51:3) {#if pageIndex.modules} +function create_if_block_2$1(ctx) { + let span; + let i; + let t1; + let t2; + let t3; + + return { + c() { + span = element("span"); + i = element("i"); + i.textContent = "Alt + M"; + t1 = text("Go to "); + t2 = text(/*moduleIndexLabel*/ ctx[6]); + t3 = text(" page"); + attr(i, "class", "key svelte-1uxeem0"); + attr(span, "class", "svelte-1uxeem0"); + }, + m(target, anchor) { + insert(target, span, anchor); + append(span, i); + append(span, t1); + append(span, t2); + append(span, t3); + }, + p: noop, + d(detaching) { + if (detaching) { + detach(span); + } + } + }; +} + +// (54:3) {#if pageIndex.hierarchy} +function create_if_block_1$1(ctx) { + let span; + + return { + c() { + span = element("span"); + span.innerHTML = `Alt + YGo to class hierarchy page`; + attr(span, "class", "svelte-1uxeem0"); + }, + m(target, anchor) { + insert(target, span, anchor); + }, + d(detaching) { + if (detaching) { + detach(span); + } + } + }; +} + +// (55:3) {#if hasAnyFolders} +function create_if_block$6(ctx) { + let span; + + return { + c() { + span = element("span"); + span.innerHTML = `AltPress when opening / closing folders to open / close all child folders.`; + attr(span, "class", "svelte-1uxeem0"); + }, + m(target, anchor) { + insert(target, span, anchor); + }, + d(detaching) { + if (detaching) { + detach(span); + } + } + }; +} + +function create_fragment$d(ctx) { + let div; + let span0; + let t1; + let section; + let each_blocks = []; + let each_1_lookup = new Map(); + let t2; + let span1; + let t4; + let span2; + let t7; + let t8; + let t9; + let span3; + let t12; + let span4; + let t15; + let span5; + let t18; + let t19; + let span6; + let t22; + let span7; + let t25; + let t26; + let div_transition; + let current; + let each_value = ensure_array_like(/*reflectionData*/ ctx[7]); + const get_key = ctx => /*entry*/ ctx[13].value; + + for (let i = 0; i < each_value.length; i += 1) { + let child_ctx = get_each_context$3(ctx, each_value, i); + let key = get_key(child_ctx); + each_1_lookup.set(key, each_blocks[i] = create_each_block$3(key, child_ctx)); + } + + let if_block0 = /*hasMarkdownFolders*/ ctx[2] && create_if_block_4(); + let if_block1 = /*hasSourceFolders*/ ctx[3] && create_if_block_3$1(); + let if_block2 = /*pageIndex*/ ctx[0].modules && create_if_block_2$1(ctx); + let if_block3 = /*pageIndex*/ ctx[0].hierarchy && create_if_block_1$1(); + let if_block4 = /*hasAnyFolders*/ ctx[1] && create_if_block$6(); + + return { + c() { + div = element("div"); + span0 = element("span"); + span0.textContent = "Reflection Icon Reference:"; + t1 = space(); + section = element("section"); + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].c(); + } + + t2 = space(); + span1 = element("span"); + span1.textContent = "Keyboard Shortcuts:"; + t4 = space(); + span2 = element("span"); + span2.innerHTML = `Alt + CFocus main content`; + t7 = space(); + if (if_block0) if_block0.c(); + t8 = space(); + if (if_block1) if_block1.c(); + t9 = space(); + span3 = element("span"); + span3.innerHTML = `Alt + HOpen / close help`; + t12 = space(); + span4 = element("span"); + span4.innerHTML = `Alt + IGo to home / index page`; + t15 = space(); + span5 = element("span"); + span5.innerHTML = `Alt + NSource (Nav) focus selected`; + t18 = space(); + if (if_block2) if_block2.c(); + t19 = space(); + span6 = element("span"); + span6.innerHTML = `Alt + OOpen / focus "On This Page"`; + t22 = space(); + span7 = element("span"); + span7.innerHTML = `Alt + SActivate search`; + t25 = space(); + if (if_block3) if_block3.c(); + t26 = space(); + if (if_block4) if_block4.c(); + attr(span0, "class", "title svelte-1uxeem0"); + attr(section, "class", "reflection-kinds svelte-1uxeem0"); + attr(span1, "class", "title svelte-1uxeem0"); + attr(span2, "class", "svelte-1uxeem0"); + attr(span3, "class", "svelte-1uxeem0"); + attr(span4, "class", "svelte-1uxeem0"); + attr(span5, "class", "svelte-1uxeem0"); + attr(span6, "class", "svelte-1uxeem0"); + attr(span7, "class", "svelte-1uxeem0"); + attr(div, "class", "svelte-1uxeem0"); + }, + m(target, anchor) { + insert(target, div, anchor); + append(div, span0); + append(div, t1); + append(div, section); + + for (let i = 0; i < each_blocks.length; i += 1) { + if (each_blocks[i]) { + each_blocks[i].m(section, null); + } + } + + append(div, t2); + append(div, span1); + append(div, t4); + append(div, span2); + append(div, t7); + if (if_block0) if_block0.m(div, null); + append(div, t8); + if (if_block1) if_block1.m(div, null); + append(div, t9); + append(div, span3); + append(div, t12); + append(div, span4); + append(div, t15); + append(div, span5); + append(div, t18); + if (if_block2) if_block2.m(div, null); + append(div, t19); + append(div, span6); + append(div, t22); + append(div, span7); + append(div, t25); + if (if_block3) if_block3.m(div, null); + append(div, t26); + if (if_block4) if_block4.m(div, null); + current = true; + }, + p(ctx, [dirty]) { + if (dirty & /*reflectionData*/ 128) { + each_value = ensure_array_like(/*reflectionData*/ ctx[7]); + each_blocks = update_keyed_each(each_blocks, dirty, get_key, 1, ctx, each_value, each_1_lookup, section, destroy_block, create_each_block$3, null, get_each_context$3); + } + + if (/*pageIndex*/ ctx[0].modules) if_block2.p(ctx, dirty); + }, + i(local) { + if (current) return; + + if (local) { + add_render_callback(() => { + if (!current) return; + if (!div_transition) div_transition = create_bidirectional_transition(div, /*animateTransition*/ ctx[5], { duration: 100 }, true); + div_transition.run(1); + }); + } + + current = true; + }, + o(local) { + if (local) { + if (!div_transition) div_transition = create_bidirectional_transition(div, /*animateTransition*/ ctx[5], { duration: 100 }, false); + div_transition.run(0); + } + + current = false; + }, + d(detaching) { + if (detaching) { + detach(div); + } + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].d(); + } + + if (if_block0) if_block0.d(); + if (if_block1) if_block1.d(); + if (if_block2) if_block2.d(); + if (if_block3) if_block3.d(); + if (if_block4) if_block4.d(); + if (detaching && div_transition) div_transition.end(); + } + }; +} + +function instance$c($$self, $$props, $$invalidate) { + let $storeThemeAnimate; + const { moduleIsPackage, navigation, pageIndex, ReflectionKind, settingStores } = /** @type {DMTComponentData} */ getContext('#dmtComponentData'); + const hasAnyFolders = navigation.treeState.markdown.hasFolders || navigation.treeState.source.hasFolders; + const hasMarkdownFolders = navigation.treeState.markdown.hasFolders; + const hasSourceFolders = navigation.treeState.source.hasFolders; + const storeThemeAnimate = settingStores.themeAnimate; + component_subscribe($$self, storeThemeAnimate, value => $$invalidate(8, $storeThemeAnimate = value)); + const animateTransition = $storeThemeAnimate ? slideFade : () => void 0; + const moduleIndexLabel = moduleIsPackage ? 'package' : 'module'; + const reflectionData = []; + + for (const [key, value] of Object.entries(ReflectionKind)) { + if (typeof value === 'number') { + reflectionData.push({ key, value }); + } + } + + reflectionData.sort((a, b) => a.key.localeCompare(b.key)); + + return [ + pageIndex, + hasAnyFolders, + hasMarkdownFolders, + hasSourceFolders, + storeThemeAnimate, + animateTransition, + moduleIndexLabel, + reflectionData + ]; +} + +class HelpPanel extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$c, create_fragment$d, safe_not_equal, {}); + } +} + +/* src\frontend\view\navigation\panels\source\NavigationBar.svelte generated by Svelte v4.2.18 */ + +function create_if_block_3(ctx) { + let svg0; + let symbol; + let path; + let t0; + let button0; + let t1; + let button1; + let mounted; + let dispose; + + return { + c() { + svg0 = svg_element("svg"); + symbol = svg_element("symbol"); + path = svg_element("path"); + t0 = space(); + button0 = element("button"); + button0.innerHTML = ``; + t1 = space(); + button1 = element("button"); + button1.innerHTML = ``; + attr(path, "d", "M517.408 993.568l-0.448 0.256c-18.592-0.032-37.152-7.168-51.328-21.344L51.392 558.24c-27.904-27.904-28.32-74.624 0.224-103.2 28.768-28.768 74.784-28.672 103.2-0.224l362.272 362.272L879.36 454.816c27.904-27.904 74.624-28.32 103.2 0.224 28.768 28.768 28.672 74.784 0.224 103.2l-414.24 414.24c-13.92 13.92-32.512 20.992-51.2 21.056z m0-397.408l-0.448 0.256c-18.592-0.032-37.152-7.168-51.328-21.344l-414.24-414.24c-27.904-27.904-28.32-74.624 0.224-103.2 28.768-28.768 74.784-28.672 103.2-0.224L517.088 419.68 879.36 57.408c27.904-27.904 74.624-28.32 103.2 0.224 28.768 28.768 28.672 74.784 0.224 103.2l-414.24 414.24c-13.92 13.92-32.512 20.992-51.2 21.056z"); + attr(symbol, "id", "dmt-double-icon-arrow"); + attr(symbol, "viewBox", "0 0 1024 1024"); + set_style(svg0, "display", "none"); + attr(svg0, "class", "svelte-1xrvgp2"); + attr(button0, "title", 'Open All'); + attr(button0, "class", "svelte-1xrvgp2"); + attr(button1, "title", 'Close All'); + attr(button1, "class", "svelte-1xrvgp2"); + }, + m(target, anchor) { + insert(target, svg0, anchor); + append(svg0, symbol); + append(symbol, path); + insert(target, t0, anchor); + insert(target, button0, anchor); + insert(target, t1, anchor); + insert(target, button1, anchor); + + if (!mounted) { + dispose = [ + listen(button0, "click", /*click_handler*/ ctx[10]), + listen(button0, "keydown", onKeydownRepeat), + listen(button0, "pointerdown", stop_propagation(/*pointerdown_handler*/ ctx[9])), + listen(button1, "click", /*click_handler_1*/ ctx[11]), + listen(button1, "keydown", onKeydownRepeat), + listen(button1, "pointerdown", stop_propagation(/*pointerdown_handler_1*/ ctx[8])) + ]; + + mounted = true; + } + }, + p: noop, + d(detaching) { + if (detaching) { + detach(svg0); + detach(t0); + detach(button0); + detach(t1); + detach(button1); + } + + mounted = false; + run_all(dispose); + } + }; +} + +// (64:6) {#if pageIndex.hierarchy} +function create_if_block_2(ctx) { + let button; + let mounted; + let dispose; + + return { + c() { + button = element("button"); + button.innerHTML = ``; + attr(button, "title", "Class Hierarchy"); + attr(button, "class", "svelte-1xrvgp2"); + }, + m(target, anchor) { + insert(target, button, anchor); + + if (!mounted) { + dispose = [ + listen(button, "click", /*click_handler_2*/ ctx[12]), + listen(button, "keydown", onKeydownRepeat) + ]; + + mounted = true; + } + }, + p: noop, + d(detaching) { + if (detaching) { + detach(button); + } + + mounted = false; + run_all(dispose); + } + }; +} + +// (92:6) {#if pageIndex.modules} +function create_if_block_1(ctx) { + let button; + let svg; + let rect0; + let rect1; + let rect2; + let mounted; + let dispose; + + return { + c() { + button = element("button"); + svg = svg_element("svg"); + rect0 = svg_element("rect"); + rect1 = svg_element("rect"); + rect2 = svg_element("rect"); + attr(rect0, "x", "10"); + attr(rect0, "y", "0"); + attr(rect0, "width", "12"); + attr(rect0, "height", "6"); + attr(rect1, "x", "6"); + attr(rect1, "y", "13"); + attr(rect1, "width", "20"); + attr(rect1, "height", "6"); + attr(rect2, "x", "0"); + attr(rect2, "y", "26"); + attr(rect2, "width", "32"); + attr(rect2, "height", "6"); + attr(svg, "width", "32"); + attr(svg, "height", "32"); + attr(svg, "viewBox", "0 0 32 32"); + attr(svg, "xmlns", "http://www.w3.org/2000/svg"); + attr(svg, "class", "svelte-1xrvgp2"); + attr(button, "title", /*moduleIndexTitle*/ ctx[7]); + attr(button, "class", "svelte-1xrvgp2"); + }, + m(target, anchor) { + insert(target, button, anchor); + append(button, svg); + append(svg, rect0); + append(svg, rect1); + append(svg, rect2); + + if (!mounted) { + dispose = [ + listen(button, "click", /*click_handler_3*/ ctx[13]), + listen(button, "keydown", onKeydownRepeat) + ]; + + mounted = true; + } + }, + p: noop, + d(detaching) { + if (detaching) { + detach(button); + } + + mounted = false; + run_all(dispose); + } + }; +} + +// (126:3) {#if $storeHelpPanelVisible} +function create_if_block$5(ctx) { + let helppanel; + let current; + helppanel = new HelpPanel({}); + + return { + c() { + create_component(helppanel.$$.fragment); + }, + m(target, anchor) { + mount_component(helppanel, target, anchor); + current = true; + }, + i(local) { + if (current) return; + transition_in(helppanel.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(helppanel.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(helppanel, detaching); + } + }; +} + +function create_fragment$c(ctx) { + let section; + let t0; + let t1; + let t2; + let button; + let svg; + let g; + let path0; + let path1; + let t3; + let current; + let mounted; + let dispose; + let if_block0 = /*hasSourceFolders*/ ctx[5] > 0 && create_if_block_3(ctx); + let if_block1 = /*pageIndex*/ ctx[4].hierarchy && create_if_block_2(ctx); + let if_block2 = /*pageIndex*/ ctx[4].modules && create_if_block_1(ctx); + let if_block3 = /*$storeHelpPanelVisible*/ ctx[0] && create_if_block$5(); + + return { + c() { + section = element("section"); + if (if_block0) if_block0.c(); + t0 = space(); + if (if_block1) if_block1.c(); + t1 = space(); + if (if_block2) if_block2.c(); + t2 = space(); + button = element("button"); + svg = svg_element("svg"); + g = svg_element("g"); + path0 = svg_element("path"); + path1 = svg_element("path"); + t3 = space(); + if (if_block3) if_block3.c(); + attr(path0, "d", "M502.29,788.199h-47c-33.1,0-60,26.9-60,60v64.9c0,33.1,26.9,60,60,60h47c33.101,0,60-26.9,60-60v-64.9 C562.29,815,535.391,788.199,502.29,788.199z"); + attr(path1, "d", "M170.89,285.8l86.7,10.8c27.5,3.4,53.6-12.4,63.5-38.3c12.5-32.7,29.9-58.5,52.2-77.3c31.601-26.6,70.9-40,117.9-40\r\n c48.7,0,87.5,12.8,116.3,38.3c28.8,25.6,43.1,56.2,43.1,92.1c0,25.8-8.1,49.4-24.3,70.8c-10.5,13.6-42.8,42.2-96.7,85.9\r\n c-54,43.7-89.899,83.099-107.899,118.099c-18.4,35.801-24.8,75.5-26.4,115.301c-1.399,34.1,25.8,62.5,60,62.5h49\r\n c31.2,0,57-23.9,59.8-54.9c2-22.299,5.7-39.199,11.301-50.699c9.399-19.701,33.699-45.701,72.699-78.1\r\n C723.59,477.8,772.79,428.4,795.891,392c23-36.3,34.6-74.8,34.6-115.5c0-73.5-31.3-138-94-193.4c-62.6-55.4-147-83.1-253-83.1\r\n c-100.8,0-182.1,27.3-244.1,82c-52.8,46.6-84.9,101.8-96.2,165.5C139.69,266.1,152.39,283.5,170.89,285.8z"); + attr(svg, "viewBox", "0 0 973.1 973.1"); + attr(svg, "class", "svelte-1xrvgp2"); + attr(button, "title", /*helpTitle*/ ctx[1]); + attr(button, "class", "svelte-1xrvgp2"); + attr(section, "class", "svelte-1xrvgp2"); + }, + m(target, anchor) { + insert(target, section, anchor); + if (if_block0) if_block0.m(section, null); + append(section, t0); + if (if_block1) if_block1.m(section, null); + append(section, t1); + if (if_block2) if_block2.m(section, null); + append(section, t2); + append(section, button); + append(button, svg); + append(svg, g); + append(g, path0); + append(g, path1); + append(section, t3); + if (if_block3) if_block3.m(section, null); + current = true; + + if (!mounted) { + dispose = [ + listen(button, "click", /*click_handler_4*/ ctx[14]), + listen(button, "keydown", onKeydownRepeat) + ]; + + mounted = true; + } + }, + p(ctx, [dirty]) { + if (/*hasSourceFolders*/ ctx[5] > 0) if_block0.p(ctx, dirty); + if (/*pageIndex*/ ctx[4].hierarchy) if_block1.p(ctx, dirty); + if (/*pageIndex*/ ctx[4].modules) if_block2.p(ctx, dirty); + + if (!current || dirty & /*helpTitle*/ 2) { + attr(button, "title", /*helpTitle*/ ctx[1]); + } + + if (/*$storeHelpPanelVisible*/ ctx[0]) { + if (if_block3) { + if (dirty & /*$storeHelpPanelVisible*/ 1) { + transition_in(if_block3, 1); + } + } else { + if_block3 = create_if_block$5(); + if_block3.c(); + transition_in(if_block3, 1); + if_block3.m(section, null); + } + } else if (if_block3) { + group_outros(); + + transition_out(if_block3, 1, 1, () => { + if_block3 = null; + }); + + check_outros(); + } + }, + i(local) { + if (current) return; + transition_in(if_block3); + current = true; + }, + o(local) { + transition_out(if_block3); + current = false; + }, + d(detaching) { + if (detaching) { + detach(section); + } + + if (if_block0) if_block0.d(); + if (if_block1) if_block1.d(); + if (if_block2) if_block2.d(); + if (if_block3) if_block3.d(); + mounted = false; + run_all(dispose); + } + }; +} + +function onKeydownRepeat(event) { + if (event.repeat) { + event.stopPropagation(); + event.preventDefault(); + } +} + +function instance$b($$self, $$props, $$invalidate) { + let helpTitle; + let $storeHelpPanelVisible; + + const { baseURL, moduleIsPackage, navigation, pageIndex, stateStores } = /** @type {DMTComponentData} */ + getContext('#dmtComponentData'); + + const hasSourceFolders = navigation.treeState.source.hasFolders; + const storeHelpPanelVisible = stateStores.helpPanelVisible; + component_subscribe($$self, storeHelpPanelVisible, value => $$invalidate(0, $storeHelpPanelVisible = value)); + const moduleIndexTitle = moduleIsPackage ? 'Package Index' : 'Module Index'; + + function pointerdown_handler_1(event) { + bubble.call(this, $$self, event); + } + + function pointerdown_handler(event) { + bubble.call(this, $$self, event); + } + + const click_handler = () => navigation.treeState.source.setFoldersAllOpen(true); + const click_handler_1 = () => navigation.treeState.source.setFoldersAllOpen(false); + const click_handler_2 = () => globalThis.location.href = `${baseURL}${pageIndex.hierarchy}`; + const click_handler_3 = () => globalThis.location.href = `${baseURL}${pageIndex.modules}`; + const click_handler_4 = () => set_store_value(storeHelpPanelVisible, $storeHelpPanelVisible = !$storeHelpPanelVisible, $storeHelpPanelVisible); + + $$self.$$.update = () => { + if ($$self.$$.dirty & /*$storeHelpPanelVisible*/ 1) { + $$invalidate(1, helpTitle = $storeHelpPanelVisible ? 'Close Help' : 'Open Help'); + } + }; + + return [ + $storeHelpPanelVisible, + helpTitle, + baseURL, + navigation, + pageIndex, + hasSourceFolders, + storeHelpPanelVisible, + moduleIndexTitle, + pointerdown_handler_1, + pointerdown_handler, + click_handler, + click_handler_1, + click_handler_2, + click_handler_3, + click_handler_4 + ]; +} + +class NavigationBar extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$b, create_fragment$c, safe_not_equal, {}); + } +} + +/* src\frontend\view\navigation\panels\source\SourceIndex.svelte generated by Svelte v4.2.18 */ + +function create_fragment$b(ctx) { + let section; + let navigationbar; + let t; + let navigationtree; + let current; + navigationbar = new NavigationBar({}); + + navigationtree = new NavigationTree({ + props: { + treeState: /*navigation*/ ctx[0].treeState.source + } + }); + + return { + c() { + section = element("section"); + create_component(navigationbar.$$.fragment); + t = space(); + create_component(navigationtree.$$.fragment); + attr(section, "class", "source-index svelte-13h1skr"); + }, + m(target, anchor) { + insert(target, section, anchor); + mount_component(navigationbar, section, null); + append(section, t); + mount_component(navigationtree, section, null); + current = true; + }, + p: noop, + i(local) { + if (current) return; + transition_in(navigationbar.$$.fragment, local); + transition_in(navigationtree.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(navigationbar.$$.fragment, local); + transition_out(navigationtree.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(section); + } + + destroy_component(navigationbar); + destroy_component(navigationtree); + } + }; +} + +function instance$a($$self) { + const { navigation } = /** @type {DMTComponentData} */ getContext('#dmtComponentData'); + return [navigation]; +} + +class SourceIndex extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$a, create_fragment$b, safe_not_equal, {}); + } +} + +/* src\frontend\view\navigation\Navigation.svelte generated by Svelte v4.2.18 */ + +function create_fragment$a(ctx) { + let sidebarlinks; + let t0; + let documentindex; + let t1; + let sourceindex; + let current; + sidebarlinks = new SidebarLinks({}); + documentindex = new DocumentIndex({}); + sourceindex = new SourceIndex({}); + + return { + c() { + create_component(sidebarlinks.$$.fragment); + t0 = space(); + create_component(documentindex.$$.fragment); + t1 = space(); + create_component(sourceindex.$$.fragment); + }, + m(target, anchor) { + mount_component(sidebarlinks, target, anchor); + insert(target, t0, anchor); + mount_component(documentindex, target, anchor); + insert(target, t1, anchor); + mount_component(sourceindex, target, anchor); + current = true; + }, + p: noop, + i(local) { + if (current) return; + transition_in(sidebarlinks.$$.fragment, local); + transition_in(documentindex.$$.fragment, local); + transition_in(sourceindex.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(sidebarlinks.$$.fragment, local); + transition_out(documentindex.$$.fragment, local); + transition_out(sourceindex.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(t0); + detach(t1); + } + + destroy_component(sidebarlinks, detaching); + destroy_component(documentindex, detaching); + destroy_component(sourceindex, detaching); + } + }; +} + +class Navigation extends SvelteComponent { + constructor(options) { + super(); + init(this, options, null, create_fragment$a, safe_not_equal, {}); + } +} + +/* src\frontend\view\search-main\SearchButton.svelte generated by Svelte v4.2.18 */ + +function create_fragment$9(ctx) { + let button; + let mounted; + let dispose; + + return { + c() { + button = element("button"); + button.innerHTML = ``; + attr(button, "class", "svelte-10arjs8"); + }, + m(target, anchor) { + insert(target, button, anchor); + + if (!mounted) { + dispose = [ + listen(button, "click", /*click_handler*/ ctx[3]), + listen(button, "pointerdown", stop_propagation(/*pointerdown_handler*/ ctx[2])) + ]; + + mounted = true; + } + }, + p: noop, + i: noop, + o: noop, + d(detaching) { + if (detaching) { + detach(button); + } + + mounted = false; + run_all(dispose); + } + }; +} + +function instance$9($$self, $$props, $$invalidate) { + let $storeSearchVisible; + const { stateStores } = /** @type {DMTComponentData} */ getContext('#dmtComponentData'); + const storeSearchVisible = stateStores.mainSearchVisible; + component_subscribe($$self, storeSearchVisible, value => $$invalidate(0, $storeSearchVisible = value)); + + function pointerdown_handler(event) { + bubble.call(this, $$self, event); + } + + const click_handler = () => set_store_value(storeSearchVisible, $storeSearchVisible = !$storeSearchVisible, $storeSearchVisible); + return [$storeSearchVisible, storeSearchVisible, pointerdown_handler, click_handler]; +} + +class SearchButton extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$9, create_fragment$9, safe_not_equal, {}); + } +} + +/* src\frontend\view\search-main\SearchResults.svelte generated by Svelte v4.2.18 */ + +function get_each_context$2(ctx, list, i) { + const child_ctx = ctx.slice(); + child_ctx[14] = list[i]; + return child_ctx; +} + +// (39:6) {#if result.kind} +function create_if_block$4(ctx) { + let svg; + let use; + let use_href_value; + + return { + c() { + svg = svg_element("svg"); + use = svg_element("use"); + attr(use, "href", use_href_value = `#icon-${/*result*/ ctx[14].kind}`); + attr(svg, "class", "tsd-kind-icon"); + attr(svg, "viewBox", "0 0 24 24"); + }, + m(target, anchor) { + insert(target, svg, anchor); + append(svg, use); + }, + p(ctx, dirty) { + if (dirty & /*results*/ 2 && use_href_value !== (use_href_value = `#icon-${/*result*/ ctx[14].kind}`)) { + attr(use, "href", use_href_value); + } + }, + d(detaching) { + if (detaching) { + detach(svg); + } + } + }; +} + +// (33:0) {#each results as result (result.id)} +function create_each_block$2(key_1, ctx) { + let li; + let t0; + let span; + let raw_value = /*result*/ ctx[14].name + ""; + let t1; + let li_class_value; + let mounted; + let dispose; + let if_block = /*result*/ ctx[14].kind && create_if_block$4(ctx); + + function click_handler() { + return /*click_handler*/ ctx[8](/*result*/ ctx[14]); + } + + return { + key: key_1, + first: null, + c() { + li = element("li"); + if (if_block) if_block.c(); + t0 = space(); + span = element("span"); + t1 = space(); + attr(span, "class", "parent"); + attr(li, "class", li_class_value = "" + (null_to_empty(/*result*/ ctx[14].classes) + " svelte-5rxzhp")); + attr(li, "role", "menuitem"); + toggle_class(li, "selected", /*result*/ ctx[14].id === /*$storeCurrentId*/ ctx[2]); + this.first = li; + }, + m(target, anchor) { + insert(target, li, anchor); + if (if_block) if_block.m(li, null); + append(li, t0); + append(li, span); + span.innerHTML = raw_value; + append(li, t1); + + if (!mounted) { + dispose = listen(li, "click", click_handler); + mounted = true; + } + }, + p(new_ctx, dirty) { + ctx = new_ctx; + + if (/*result*/ ctx[14].kind) { + if (if_block) { + if_block.p(ctx, dirty); + } else { + if_block = create_if_block$4(ctx); + if_block.c(); + if_block.m(li, t0); + } + } else if (if_block) { + if_block.d(1); + if_block = null; + } + + if (dirty & /*results*/ 2 && raw_value !== (raw_value = /*result*/ ctx[14].name + "")) span.innerHTML = raw_value; + if (dirty & /*results*/ 2 && li_class_value !== (li_class_value = "" + (null_to_empty(/*result*/ ctx[14].classes) + " svelte-5rxzhp"))) { + attr(li, "class", li_class_value); + } + + if (dirty & /*results, results, $storeCurrentId*/ 6) { + toggle_class(li, "selected", /*result*/ ctx[14].id === /*$storeCurrentId*/ ctx[2]); + } + }, + d(detaching) { + if (detaching) { + detach(li); + } + + if (if_block) if_block.d(); + mounted = false; + dispose(); + } + }; +} + +function create_fragment$8(ctx) { + let ul; + let each_blocks = []; + let each_1_lookup = new Map(); + let ul_transition; + let current; + let each_value = ensure_array_like(/*results*/ ctx[1]); + const get_key = ctx => /*result*/ ctx[14].id; + + for (let i = 0; i < each_value.length; i += 1) { + let child_ctx = get_each_context$2(ctx, each_value, i); + let key = get_key(child_ctx); + each_1_lookup.set(key, each_blocks[i] = create_each_block$2(key, child_ctx)); + } + + return { + c() { + ul = element("ul"); + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].c(); + } + + attr(ul, "class", "svelte-5rxzhp"); + }, + m(target, anchor) { + insert(target, ul, anchor); + + for (let i = 0; i < each_blocks.length; i += 1) { + if (each_blocks[i]) { + each_blocks[i].m(ul, null); + } + } + + /*ul_binding*/ ctx[9](ul); + current = true; + }, + p(ctx, [dirty]) { + if (dirty & /*results, $storeCurrentId, onClick*/ 134) { + each_value = ensure_array_like(/*results*/ ctx[1]); + each_blocks = update_keyed_each(each_blocks, dirty, get_key, 1, ctx, each_value, each_1_lookup, ul, destroy_block, create_each_block$2, null, get_each_context$2); + } + }, + i(local) { + if (current) return; + + add_render_callback(() => { + if (!current) return; + if (!ul_transition) ul_transition = create_bidirectional_transition(ul, /*animateTransition*/ ctx[6], { duration: 100 }, true); + ul_transition.run(1); + }); + + current = true; + }, + o(local) { + if (!ul_transition) ul_transition = create_bidirectional_transition(ul, /*animateTransition*/ ctx[6], { duration: 100 }, false); + ul_transition.run(0); + current = false; + }, + d(detaching) { + if (detaching) { + detach(ul); + } + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].d(); + } + + /*ul_binding*/ ctx[9](null); + if (detaching && ul_transition) ul_transition.end(); + } + }; +} + +function instance$8($$self, $$props, $$invalidate) { + let $storeSearchVisible; + let $storeThemeAnimate; + let $storeCurrentId; + let { results = void 0 } = $$props; + let { resultsEl = void 0 } = $$props; + + const { settingStores, stateStores } = /** @type {DMTComponentData} */ + getContext('#dmtComponentData'); + + const storeSearchVisible = stateStores.mainSearchVisible; + component_subscribe($$self, storeSearchVisible, value => $$invalidate(10, $storeSearchVisible = value)); + const storeThemeAnimate = settingStores.themeAnimate; + component_subscribe($$self, storeThemeAnimate, value => $$invalidate(11, $storeThemeAnimate = value)); + + /** @type {import('svelte/store').Writable} */ + const storeCurrentId = getContext('#storeCurrentId'); + + component_subscribe($$self, storeCurrentId, value => $$invalidate(2, $storeCurrentId = value)); + const animateTransition = $storeThemeAnimate ? slideFade : () => void 0; + + function onClick(href) { + set_store_value(storeSearchVisible, $storeSearchVisible = false, $storeSearchVisible); + globalThis.location.href = href; + } + + const click_handler = result => onClick(result.href); + + function ul_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + resultsEl = $$value; + $$invalidate(0, resultsEl); + }); + } + + $$self.$$set = $$props => { + if ('results' in $$props) $$invalidate(1, results = $$props.results); + if ('resultsEl' in $$props) $$invalidate(0, resultsEl = $$props.resultsEl); + }; + + return [ + resultsEl, + results, + $storeCurrentId, + storeSearchVisible, + storeThemeAnimate, + storeCurrentId, + animateTransition, + onClick, + click_handler, + ul_binding + ]; +} + +class SearchResults extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$8, create_fragment$8, safe_not_equal, { results: 1, resultsEl: 0 }); + } +} + +/* src\frontend\view\search-main\SearchField.svelte generated by Svelte v4.2.18 */ + +const { window: window_1 } = globals; + +function create_if_block$3(ctx) { + let searchresults; + let updating_resultsEl; + let current; + + function searchresults_resultsEl_binding(value) { + /*searchresults_resultsEl_binding*/ ctx[13](value); + } + + let searchresults_props = { results: /*results*/ ctx[0] }; + + if (/*resultsEl*/ ctx[3] !== void 0) { + searchresults_props.resultsEl = /*resultsEl*/ ctx[3]; + } + + searchresults = new SearchResults({ props: searchresults_props }); + binding_callbacks.push(() => bind(searchresults, 'resultsEl', searchresults_resultsEl_binding)); + + return { + c() { + create_component(searchresults.$$.fragment); + }, + m(target, anchor) { + mount_component(searchresults, target, anchor); + current = true; + }, + p(ctx, dirty) { + const searchresults_changes = {}; + if (dirty & /*results*/ 1) searchresults_changes.results = /*results*/ ctx[0]; + + if (!updating_resultsEl && dirty & /*resultsEl*/ 8) { + updating_resultsEl = true; + searchresults_changes.resultsEl = /*resultsEl*/ ctx[3]; + add_flush_callback(() => updating_resultsEl = false); + } + + searchresults.$set(searchresults_changes); + }, + i(local) { + if (current) return; + transition_in(searchresults.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(searchresults.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(searchresults, detaching); + } + }; +} + +function create_fragment$7(ctx) { + let input; + let input_transition; + let t; + let if_block_anchor; + let current; + let mounted; + let dispose; + let if_block = /*results*/ ctx[0].length && create_if_block$3(ctx); + + return { + c() { + input = element("input"); + t = space(); + if (if_block) if_block.c(); + if_block_anchor = empty(); + attr(input, "type", "search"); + attr(input, "id", "dmt-search-field"); + attr(input, "aria-label", "Search"); + attr(input, "class", "svelte-tuln0o"); + set_style(input, "color", /*invalidQuery*/ ctx[4] ? 'red' : null); + set_style(input, "border-color", /*invalidQuery*/ ctx[4] ? 'red' : null); + }, + m(target, anchor) { + insert(target, input, anchor); + /*input_binding*/ ctx[11](input); + set_input_value(input, /*$storeQuery*/ ctx[1]); + insert(target, t, anchor); + if (if_block) if_block.m(target, anchor); + insert(target, if_block_anchor, anchor); + current = true; + + if (!mounted) { + dispose = [ + listen(window_1, "pointerdown", /*handlePointerdown*/ ctx[10]), + listen(input, "input", /*input_input_handler*/ ctx[12]), + listen(input, "keydown", /*handleKeydown*/ ctx[9]) + ]; + + mounted = true; + } + }, + p(ctx, [dirty]) { + if (dirty & /*$storeQuery*/ 2 && input.value !== /*$storeQuery*/ ctx[1]) { + set_input_value(input, /*$storeQuery*/ ctx[1]); + } + + if (dirty & /*invalidQuery*/ 16) { + set_style(input, "color", /*invalidQuery*/ ctx[4] ? 'red' : null); + } + + if (dirty & /*invalidQuery*/ 16) { + set_style(input, "border-color", /*invalidQuery*/ ctx[4] ? 'red' : null); + } + + if (/*results*/ ctx[0].length) { + if (if_block) { + if_block.p(ctx, dirty); + + if (dirty & /*results*/ 1) { + transition_in(if_block, 1); + } + } else { + if_block = create_if_block$3(ctx); + if_block.c(); + transition_in(if_block, 1); + if_block.m(if_block_anchor.parentNode, if_block_anchor); + } + } else if (if_block) { + group_outros(); + + transition_out(if_block, 1, 1, () => { + if_block = null; + }); + + check_outros(); + } + }, + i(local) { + if (current) return; + + if (local) { + add_render_callback(() => { + if (!current) return; + if (!input_transition) input_transition = create_bidirectional_transition(input, /*animateTransition*/ ctx[8], { duration: 200 }, true); + input_transition.run(1); + }); + } + + transition_in(if_block); + current = true; + }, + o(local) { + if (local) { + if (!input_transition) input_transition = create_bidirectional_transition(input, /*animateTransition*/ ctx[8], { duration: 200 }, false); + input_transition.run(0); + } + + transition_out(if_block); + current = false; + }, + d(detaching) { + if (detaching) { + detach(input); + detach(t); + detach(if_block_anchor); + } + + /*input_binding*/ ctx[11](null); + if (detaching && input_transition) input_transition.end(); + if (if_block) if_block.d(detaching); + mounted = false; + run_all(dispose); + } + }; +} + +function instance$7($$self, $$props, $$invalidate) { + let invalidQuery; + let $storeSearchVisible; + let $storeQuery; + let $storeThemeAnimate; + const storeCurrentId = writable(void 0); + setContext('#storeCurrentId', storeCurrentId); + + const { basePath, showModuleIcon, searchOptions, settingStores, stateStores } = /** @type {DMTComponentData} */ + getContext('#dmtComponentData'); + + const storeSearchVisible = stateStores.mainSearchVisible; + component_subscribe($$self, storeSearchVisible, value => $$invalidate(15, $storeSearchVisible = value)); + const storeThemeAnimate = settingStores.themeAnimate; + component_subscribe($$self, storeThemeAnimate, value => $$invalidate(16, $storeThemeAnimate = value)); + + /** @type {boolean} */ + const searchFullName = searchOptions?.fullName ?? false; + + /** @type {number} */ + const searchLimit = searchOptions?.limit ?? 10; + + /** + * Stores the input query string from the main search input element. + * + * @type {import('svelte/store').Writable} + */ + const storeQuery = writable(''); + + component_subscribe($$self, storeQuery, value => $$invalidate(1, $storeQuery = value)); + const animateTransition = $storeThemeAnimate ? slideFade : () => void 0; + + // Debounce queries by 250ms. + const debouncedSearchQuery = Timing.debounce((query, options) => $$invalidate(0, results = processMainSearchQuery(query, options)), 250); + + const queryOptions = { + basePath, + showModuleIcon, + searchFullName, + searchLimit + }; + + let currentIndex = 0; + + /** @type {HTMLInputElement} */ + let inputEl; + + /** @type {ProcessedSearchDocument[]} */ + let results = []; + + /** + * Bound from {@link SearchResults} to check for window pointer down events outside input & results elements. + * + * @type {HTMLUListElement} + */ + let resultsEl; + + // Focus input element on mount. + onMount(() => inputEl.focus()); + + /** + * Detects navigation input modifying current selected ID. + * + * @param {KeyboardEvent} event - + */ + function handleKeydown(event) { + switch (event.code) { + case 'ArrowDown': + if (results.length === 0) { + return; + } + if (currentIndex < results.length - 1) { + storeCurrentId.set(results[++currentIndex].id); + event.preventDefault(); + } + break; + case 'ArrowUp': + if (results.length === 0) { + return; + } + if (currentIndex > 0) { + storeCurrentId.set(results[--currentIndex].id); + event.preventDefault(); + } + break; + case 'Enter': + if (currentIndex >= 0) { + window.location.href = results[currentIndex].href; + } + event.preventDefault(); + break; + case 'Escape': + // Only set visibility to false when the query is empty. + if ($storeSearchVisible && !$storeQuery.length) { + set_store_value(storeSearchVisible, $storeSearchVisible = false, $storeSearchVisible); + } + break; + case 'Tab': + if (results.length === 0) { + event.preventDefault(); + return; + } + if (event.shiftKey) { + if (currentIndex > 0) { + storeCurrentId.set(results[--currentIndex].id); + } + } else if (currentIndex < results.length - 1) { + storeCurrentId.set(results[++currentIndex].id); + } + event.preventDefault(); + break; + } + + // Prevents global key commands from activating when main search is active. + event.stopPropagation(); + } + + /** + * Handles browser window pointer down events; setting the search query UI not visible if the target is outside the + * search query UI. + * + * @param {PointerEvent} event - + */ + function handlePointerdown(event) { + if (event.target !== inputEl && !resultsEl?.contains?.(event.target)) { + set_store_value(storeSearchVisible, $storeSearchVisible = false, $storeSearchVisible); + } + } + + function input_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + inputEl = $$value; + $$invalidate(2, inputEl); + }); + } + + function input_input_handler() { + $storeQuery = this.value; + storeQuery.set($storeQuery); + } + + function searchresults_resultsEl_binding(value) { + resultsEl = value; + $$invalidate(3, resultsEl); + } + + $$self.$$.update = () => { + if ($$self.$$.dirty & /*$storeQuery*/ 2) { + // Runs a 250ms debounced query updating `results`. + debouncedSearchQuery($storeQuery, { ...queryOptions }); + } + + if ($$self.$$.dirty & /*results*/ 1) { + // When results change reset current index / ID. + if (results?.length) { + currentIndex = -1; + storeCurrentId.set(void 0); + } + } + + if ($$self.$$.dirty & /*$storeQuery, results*/ 3) { + // When the query string has some input, but results are empty use `invalidQuery` to apply an inline color of red. + $$invalidate(4, invalidQuery = $storeQuery.length && !results?.length); + } + }; + + return [ + results, + $storeQuery, + inputEl, + resultsEl, + invalidQuery, + storeSearchVisible, + storeThemeAnimate, + storeQuery, + animateTransition, + handleKeydown, + handlePointerdown, + input_binding, + input_input_handler, + searchresults_resultsEl_binding + ]; +} + +class SearchField extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$7, create_fragment$7, safe_not_equal, {}); + } +} + +/* src\frontend\view\search-main\SearchMain.svelte generated by Svelte v4.2.18 */ + +function create_if_block$2(ctx) { + let searchfield; + let current; + searchfield = new SearchField({}); + + return { + c() { + create_component(searchfield.$$.fragment); + }, + m(target, anchor) { + mount_component(searchfield, target, anchor); + current = true; + }, + i(local) { + if (current) return; + transition_in(searchfield.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(searchfield.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(searchfield, detaching); + } + }; +} + +function create_fragment$6(ctx) { + let t; + let div; + let searchbutton; + let current; + let if_block = /*$storeSearchVisible*/ ctx[0] && create_if_block$2(); + searchbutton = new SearchButton({}); + + return { + c() { + if (if_block) if_block.c(); + t = space(); + div = element("div"); + create_component(searchbutton.$$.fragment); + attr(div, "class", "dmt-widget dmt-toolbar-icon search no-caption svelte-wmon9h"); + }, + m(target, anchor) { + if (if_block) if_block.m(target, anchor); + insert(target, t, anchor); + insert(target, div, anchor); + mount_component(searchbutton, div, null); + current = true; + }, + p(ctx, [dirty]) { + if (/*$storeSearchVisible*/ ctx[0]) { + if (if_block) { + if (dirty & /*$storeSearchVisible*/ 1) { + transition_in(if_block, 1); + } + } else { + if_block = create_if_block$2(); + if_block.c(); + transition_in(if_block, 1); + if_block.m(t.parentNode, t); + } + } else if (if_block) { + group_outros(); + + transition_out(if_block, 1, 1, () => { + if_block = null; + }); + + check_outros(); + } + }, + i(local) { + if (current) return; + transition_in(if_block); + transition_in(searchbutton.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(if_block); + transition_out(searchbutton.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(t); + detach(div); + } + + if (if_block) if_block.d(detaching); + destroy_component(searchbutton); + } + }; +} + +function instance$6($$self, $$props, $$invalidate) { + let $storeSearchVisible; + const { stateStores } = /** @type {DMTComponentData} */ getContext('#dmtComponentData'); + const storeSearchVisible = stateStores.mainSearchVisible; + component_subscribe($$self, storeSearchVisible, value => $$invalidate(0, $storeSearchVisible = value)); + return [$storeSearchVisible, storeSearchVisible]; +} + +class SearchMain extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$6, create_fragment$6, safe_not_equal, {}); + } +} + +/* src\frontend\view\external\TJSFocusWrap.svelte generated by Svelte v4.2.18 */ + +function create_fragment$5(ctx) { + let div; + let mounted; + let dispose; + + return { + c() { + div = element("div"); + attr(div, "class", "tjs-focus-wrap svelte-kjcljd"); + attr(div, "tabindex", "0"); + }, + m(target, anchor) { + insert(target, div, anchor); + /*div_binding*/ ctx[4](div); + + if (!mounted) { + dispose = listen(div, "focus", /*onFocus*/ ctx[1]); + mounted = true; + } + }, + p: noop, + i: noop, + o: noop, + d(detaching) { + if (detaching) { + detach(div); + } + + /*div_binding*/ ctx[4](null); + mounted = false; + dispose(); + } + }; +} + +function instance$5($$self, $$props, $$invalidate) { + let { elementRoot = void 0 } = $$props; + let { enabled = true } = $$props; + let ignoreElements, wrapEl; + + function onFocus() { + // Early out if not enabled. + if (!enabled) { + return; + } + + if (A11yHelper.isFocusTarget(elementRoot)) { + const firstFocusEl = A11yHelper.getFirstFocusableElement(elementRoot, ignoreElements); + + if (A11yHelper.isFocusTarget(firstFocusEl) && firstFocusEl !== wrapEl) { + firstFocusEl.focus(); + } else { + // No focus target found, so focus elementRoot. + elementRoot.focus(); + } + } + } + + function div_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + wrapEl = $$value; + $$invalidate(0, wrapEl); + }); + } + + $$self.$$set = $$props => { + if ('elementRoot' in $$props) $$invalidate(2, elementRoot = $$props.elementRoot); + if ('enabled' in $$props) $$invalidate(3, enabled = $$props.enabled); + }; + + $$self.$$.update = () => { + if ($$self.$$.dirty & /*wrapEl*/ 1) { + if (wrapEl) { + ignoreElements = new Set([wrapEl]); + } + } + }; + + return [wrapEl, onFocus, elementRoot, enabled, div_binding]; +} + +class TJSFocusWrap extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$5, create_fragment$5, safe_not_equal, { elementRoot: 2, enabled: 3 }); + } +} + +/* src\frontend\view\toolbar\iconlinks\IconMenu.svelte generated by Svelte v4.2.18 */ + +function get_each_context$1(ctx, list, i) { + const child_ctx = ctx.slice(); + child_ctx[11] = list[i]; + return child_ctx; +} + +// (102:6) {#each $toolbarIconLinks.icons as entry (entry.url)} +function create_each_block$1(key_1, ctx) { + let a; + let img; + let img_src_value; + let img_alt_value; + let t; + let a_href_value; + let a_title_value; + + return { + key: key_1, + first: null, + c() { + a = element("a"); + img = element("img"); + t = space(); + if (!src_url_equal(img.src, img_src_value = /*entry*/ ctx[11].iconURL)) attr(img, "src", img_src_value); + attr(img, "alt", img_alt_value = /*entry*/ ctx[11].title); + attr(img, "class", "svelte-1pcybcf"); + attr(a, "href", a_href_value = /*entry*/ ctx[11].url); + attr(a, "target", "_blank"); + attr(a, "title", a_title_value = /*entry*/ ctx[11].title); + attr(a, "class", "svelte-1pcybcf"); + this.first = a; + }, + m(target, anchor) { + insert(target, a, anchor); + append(a, img); + append(a, t); + }, + p(new_ctx, dirty) { + ctx = new_ctx; + + if (dirty & /*$toolbarIconLinks*/ 2 && !src_url_equal(img.src, img_src_value = /*entry*/ ctx[11].iconURL)) { + attr(img, "src", img_src_value); + } + + if (dirty & /*$toolbarIconLinks*/ 2 && img_alt_value !== (img_alt_value = /*entry*/ ctx[11].title)) { + attr(img, "alt", img_alt_value); + } + + if (dirty & /*$toolbarIconLinks*/ 2 && a_href_value !== (a_href_value = /*entry*/ ctx[11].url)) { + attr(a, "href", a_href_value); + } + + if (dirty & /*$toolbarIconLinks*/ 2 && a_title_value !== (a_title_value = /*entry*/ ctx[11].title)) { + attr(a, "title", a_title_value); + } + }, + d(detaching) { + if (detaching) { + detach(a); + } + } + }; +} + +function create_fragment$4(ctx) { + let section; + let div; + let each_blocks = []; + let each_1_lookup = new Map(); + let t; + let tjsfocuswrap; + let section_transition; + let current; + let mounted; + let dispose; + let each_value = ensure_array_like(/*$toolbarIconLinks*/ ctx[1].icons); + const get_key = ctx => /*entry*/ ctx[11].url; + + for (let i = 0; i < each_value.length; i += 1) { + let child_ctx = get_each_context$1(ctx, each_value, i); + let key = get_key(child_ctx); + each_1_lookup.set(key, each_blocks[i] = create_each_block$1(key, child_ctx)); + } + + tjsfocuswrap = new TJSFocusWrap({ + props: { elementRoot: /*menuEl*/ ctx[0] } + }); + + return { + c() { + section = element("section"); + div = element("div"); + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].c(); + } + + t = space(); + create_component(tjsfocuswrap.$$.fragment); + attr(div, "class", "svelte-1pcybcf"); + attr(section, "role", "menu"); + attr(section, "tabindex", "-1"); + attr(section, "class", "svelte-1pcybcf"); + }, + m(target, anchor) { + insert(target, section, anchor); + append(section, div); + + for (let i = 0; i < each_blocks.length; i += 1) { + if (each_blocks[i]) { + each_blocks[i].m(div, null); + } + } + + append(section, t); + mount_component(tjsfocuswrap, section, null); + /*section_binding*/ ctx[7](section); + current = true; + + if (!mounted) { + dispose = [ + listen(window, "pointerdown", /*handlePointerdown*/ ctx[6]), + listen(section, "keydown", /*handleKeydown*/ ctx[4]), + listen(section, "keyup", /*handleKeyup*/ ctx[5]) + ]; + + mounted = true; + } + }, + p(ctx, [dirty]) { + if (dirty & /*$toolbarIconLinks*/ 2) { + each_value = ensure_array_like(/*$toolbarIconLinks*/ ctx[1].icons); + each_blocks = update_keyed_each(each_blocks, dirty, get_key, 1, ctx, each_value, each_1_lookup, div, destroy_block, create_each_block$1, null, get_each_context$1); + } + + const tjsfocuswrap_changes = {}; + if (dirty & /*menuEl*/ 1) tjsfocuswrap_changes.elementRoot = /*menuEl*/ ctx[0]; + tjsfocuswrap.$set(tjsfocuswrap_changes); + }, + i(local) { + if (current) return; + transition_in(tjsfocuswrap.$$.fragment, local); + + add_render_callback(() => { + if (!current) return; + if (!section_transition) section_transition = create_bidirectional_transition(section, slideFade, { duration: 250, easing: quintIn }, true); + section_transition.run(1); + }); + + current = true; + }, + o(local) { + transition_out(tjsfocuswrap.$$.fragment, local); + if (!section_transition) section_transition = create_bidirectional_transition(section, slideFade, { duration: 250, easing: quintIn }, false); + section_transition.run(0); + current = false; + }, + d(detaching) { + if (detaching) { + detach(section); + } + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].d(); + } + + destroy_component(tjsfocuswrap); + /*section_binding*/ ctx[7](null); + if (detaching && section_transition) section_transition.end(); + mounted = false; + run_all(dispose); + } + }; +} + +function instance$4($$self, $$props, $$invalidate) { + let $menuVisible; + let $toolbarIconLinks; + + const { componentStores } = /** @type {DMTComponentData} */ + getContext('#dmtComponentData'); + + const { toolbarIconLinks } = componentStores; + component_subscribe($$self, toolbarIconLinks, value => $$invalidate(1, $toolbarIconLinks = value)); + + // Provides options to `A11yHelper.getFocusableElements` to ignore TJSFocusWrap by CSS class. + const s_IGNORE_CLASSES = { ignoreClasses: ['tjs-focus-wrap'] }; + + const menuVisible = getContext('menuVisible'); + component_subscribe($$self, menuVisible, value => $$invalidate(8, $menuVisible = value)); + let menuEl; + onMount(() => menuEl.focus()); + + /** + * Handle `Shift-Tab` to focus cycle to last element. + * + * @param {KeyboardEvent} event - + */ + function handleKeydown(event) { + switch (event.code) { + case 'Tab': + event.stopPropagation(); + // Handle reverse focus cycling with ``. + if (event.shiftKey) { + // Collect all focusable elements from `elementRoot` and ignore TJSFocusWrap. + const allFocusable = A11yHelper.getFocusableElements(menuEl, s_IGNORE_CLASSES); + + // Find first and last focusable elements. + const firstFocusEl = allFocusable.length > 0 ? allFocusable[0] : void 0; + + const lastFocusEl = allFocusable.length > 0 + ? allFocusable[allFocusable.length - 1] + : void 0; + + // Only cycle focus to the last keyboard focusable app element if `elementRoot` or first focusable + // element is the active element. + if (menuEl === globalThis.document.activeElement || firstFocusEl === globalThis.document.activeElement) { + if (lastFocusEl instanceof HTMLElement && firstFocusEl !== lastFocusEl) { + lastFocusEl.focus(); + } + + event.preventDefault(); + } + } + break; + } + + event.stopPropagation(); + } + + /** + * Close menu on `Escape` key up. + * + * @param {KeyboardEvent} event - + */ + function handleKeyup(event) { + switch (event.code) { + case 'Escape': + set_store_value(menuVisible, $menuVisible = false, $menuVisible); + event.preventDefault(); + break; + } + + event.stopPropagation(); + } + + /** + * Close the menu if a pointer down event occurs outside the button host. + * + * @param {PointerEvent} event - Pointer event. + */ + function handlePointerdown(event) { + if (!menuEl?.parentElement?.contains?.(event.target)) { + set_store_value(menuVisible, $menuVisible = false, $menuVisible); + } + } + + function section_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + menuEl = $$value; + $$invalidate(0, menuEl); + }); + } + + return [ + menuEl, + $toolbarIconLinks, + toolbarIconLinks, + menuVisible, + handleKeydown, + handleKeyup, + handlePointerdown, + section_binding + ]; +} + +class IconMenu extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$4, create_fragment$4, safe_not_equal, {}); + } +} + +/* src\frontend\view\toolbar\iconlinks\IconButton.svelte generated by Svelte v4.2.18 */ + +function create_if_block$1(ctx) { + let iconmenu; + let current; + + iconmenu = new IconMenu({ + props: { buttonHostEl: /*buttonHostEl*/ ctx[0] } + }); + + return { + c() { + create_component(iconmenu.$$.fragment); + }, + m(target, anchor) { + mount_component(iconmenu, target, anchor); + current = true; + }, + p(ctx, dirty) { + const iconmenu_changes = {}; + if (dirty & /*buttonHostEl*/ 1) iconmenu_changes.buttonHostEl = /*buttonHostEl*/ ctx[0]; + iconmenu.$set(iconmenu_changes); + }, + i(local) { + if (current) return; + transition_in(iconmenu.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(iconmenu.$$.fragment, local); + current = false; + }, + d(detaching) { + destroy_component(iconmenu, detaching); + } + }; +} + +function create_fragment$3(ctx) { + let section; + let button; + let t; + let current; + let mounted; + let dispose; + let if_block = /*$menuVisible*/ ctx[1] && create_if_block$1(ctx); + + return { + c() { + section = element("section"); + button = element("button"); + button.innerHTML = ``; + t = space(); + if (if_block) if_block.c(); + attr(button, "class", "svelte-1ebh1s9"); + attr(section, "class", "svelte-1ebh1s9"); + }, + m(target, anchor) { + insert(target, section, anchor); + append(section, button); + append(section, t); + if (if_block) if_block.m(section, null); + /*section_binding*/ ctx[5](section); + current = true; + + if (!mounted) { + dispose = [ + listen(button, "click", /*click_handler*/ ctx[4]), + listen(button, "pointerdown", stop_propagation(/*pointerdown_handler*/ ctx[3])) + ]; + + mounted = true; + } + }, + p(ctx, [dirty]) { + if (/*$menuVisible*/ ctx[1]) { + if (if_block) { + if_block.p(ctx, dirty); + + if (dirty & /*$menuVisible*/ 2) { + transition_in(if_block, 1); + } + } else { + if_block = create_if_block$1(ctx); + if_block.c(); + transition_in(if_block, 1); + if_block.m(section, null); + } + } else if (if_block) { + group_outros(); + + transition_out(if_block, 1, 1, () => { + if_block = null; + }); + + check_outros(); + } + }, + i(local) { + if (current) return; + transition_in(if_block); + current = true; + }, + o(local) { + transition_out(if_block); + current = false; + }, + d(detaching) { + if (detaching) { + detach(section); + } + + if (if_block) if_block.d(); + /*section_binding*/ ctx[5](null); + mounted = false; + run_all(dispose); + } + }; +} + +function instance$3($$self, $$props, $$invalidate) { + let $menuVisible; + const menuVisible = writable(false); + component_subscribe($$self, menuVisible, value => $$invalidate(1, $menuVisible = value)); + setContext('menuVisible', menuVisible); + let buttonHostEl; + + function pointerdown_handler(event) { + bubble.call(this, $$self, event); + } + + const click_handler = () => set_store_value(menuVisible, $menuVisible = !$menuVisible, $menuVisible); + + function section_binding($$value) { + binding_callbacks[$$value ? 'unshift' : 'push'](() => { + buttonHostEl = $$value; + $$invalidate(0, buttonHostEl); + }); + } + + return [ + buttonHostEl, + $menuVisible, + menuVisible, + pointerdown_handler, + click_handler, + section_binding + ]; +} + +class IconButton extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$3, create_fragment$3, safe_not_equal, {}); + } +} + +/* src\frontend\view\toolbar\iconlinks\IconBar.svelte generated by Svelte v4.2.18 */ + +function get_each_context(ctx, list, i) { + const child_ctx = ctx.slice(); + child_ctx[3] = list[i]; + return child_ctx; +} + +// (15:3) {#each $toolbarIconLinks.icons as entry (entry.url)} +function create_each_block(key_1, ctx) { + let a; + let img; + let img_src_value; + let img_alt_value; + let t; + let a_href_value; + let a_title_value; + + return { + key: key_1, + first: null, + c() { + a = element("a"); + img = element("img"); + t = space(); + if (!src_url_equal(img.src, img_src_value = /*entry*/ ctx[3].iconURL)) attr(img, "src", img_src_value); + attr(img, "alt", img_alt_value = /*entry*/ ctx[3].title); + attr(img, "class", "svelte-1f93d1m"); + attr(a, "href", a_href_value = /*entry*/ ctx[3].url); + attr(a, "target", "_blank"); + attr(a, "title", a_title_value = /*entry*/ ctx[3].title); + attr(a, "class", "svelte-1f93d1m"); + this.first = a; + }, + m(target, anchor) { + insert(target, a, anchor); + append(a, img); + append(a, t); + }, + p(new_ctx, dirty) { + ctx = new_ctx; + + if (dirty & /*$toolbarIconLinks*/ 1 && !src_url_equal(img.src, img_src_value = /*entry*/ ctx[3].iconURL)) { + attr(img, "src", img_src_value); + } + + if (dirty & /*$toolbarIconLinks*/ 1 && img_alt_value !== (img_alt_value = /*entry*/ ctx[3].title)) { + attr(img, "alt", img_alt_value); + } + + if (dirty & /*$toolbarIconLinks*/ 1 && a_href_value !== (a_href_value = /*entry*/ ctx[3].url)) { + attr(a, "href", a_href_value); + } + + if (dirty & /*$toolbarIconLinks*/ 1 && a_title_value !== (a_title_value = /*entry*/ ctx[3].title)) { + attr(a, "title", a_title_value); + } + }, + d(detaching) { + if (detaching) { + detach(a); + } + } + }; +} + +function create_fragment$2(ctx) { + let section; + let each_blocks = []; + let each_1_lookup = new Map(); + let each_value = ensure_array_like(/*$toolbarIconLinks*/ ctx[0].icons); + const get_key = ctx => /*entry*/ ctx[3].url; + + for (let i = 0; i < each_value.length; i += 1) { + let child_ctx = get_each_context(ctx, each_value, i); + let key = get_key(child_ctx); + each_1_lookup.set(key, each_blocks[i] = create_each_block(key, child_ctx)); + } + + return { + c() { + section = element("section"); + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].c(); + } + + attr(section, "class", "svelte-1f93d1m"); + }, + m(target, anchor) { + insert(target, section, anchor); + + for (let i = 0; i < each_blocks.length; i += 1) { + if (each_blocks[i]) { + each_blocks[i].m(section, null); + } + } + }, + p(ctx, [dirty]) { + if (dirty & /*$toolbarIconLinks*/ 1) { + each_value = ensure_array_like(/*$toolbarIconLinks*/ ctx[0].icons); + each_blocks = update_keyed_each(each_blocks, dirty, get_key, 1, ctx, each_value, each_1_lookup, section, destroy_block, create_each_block, null, get_each_context); + } + }, + i: noop, + o: noop, + d(detaching) { + if (detaching) { + detach(section); + } + + for (let i = 0; i < each_blocks.length; i += 1) { + each_blocks[i].d(); + } + } + }; +} + +function instance$2($$self, $$props, $$invalidate) { + let $toolbarIconLinks; + const { componentStores } = /** @type {DMTComponentData} */ getContext('#dmtComponentData'); + const { toolbarIconLinks } = componentStores; + component_subscribe($$self, toolbarIconLinks, value => $$invalidate(0, $toolbarIconLinks = value)); + return [$toolbarIconLinks, toolbarIconLinks]; +} + +class IconBar extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$2, create_fragment$2, safe_not_equal, {}); + } +} + +/* src\frontend\view\toolbar\iconlinks\IconLinks.svelte generated by Svelte v4.2.18 */ + +function create_if_block(ctx) { + let switch_instance; + let switch_instance_anchor; + let current; + var switch_value = /*component*/ ctx[1]; + + function switch_props(ctx, dirty) { + return {}; + } + + if (switch_value) { + switch_instance = construct_svelte_component(switch_value, switch_props()); + } + + return { + c() { + if (switch_instance) create_component(switch_instance.$$.fragment); + switch_instance_anchor = empty(); + }, + m(target, anchor) { + if (switch_instance) mount_component(switch_instance, target, anchor); + insert(target, switch_instance_anchor, anchor); + current = true; + }, + p(ctx, dirty) { + if (dirty & /*component*/ 2 && switch_value !== (switch_value = /*component*/ ctx[1])) { + if (switch_instance) { + group_outros(); + const old_component = switch_instance; + + transition_out(old_component.$$.fragment, 1, 0, () => { + destroy_component(old_component, 1); + }); + + check_outros(); + } + + if (switch_value) { + switch_instance = construct_svelte_component(switch_value, switch_props()); + create_component(switch_instance.$$.fragment); + transition_in(switch_instance.$$.fragment, 1); + mount_component(switch_instance, switch_instance_anchor.parentNode, switch_instance_anchor); + } else { + switch_instance = null; + } + } + }, + i(local) { + if (current) return; + if (switch_instance) transition_in(switch_instance.$$.fragment, local); + current = true; + }, + o(local) { + if (switch_instance) transition_out(switch_instance.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(switch_instance_anchor); + } + + if (switch_instance) destroy_component(switch_instance, detaching); + } + }; +} + +function create_fragment$1(ctx) { + let if_block_anchor; + let current; + let if_block = /*$toolbarIconLinks*/ ctx[0].icons.length && create_if_block(ctx); + + return { + c() { + if (if_block) if_block.c(); + if_block_anchor = empty(); + }, + m(target, anchor) { + if (if_block) if_block.m(target, anchor); + insert(target, if_block_anchor, anchor); + current = true; + }, + p(ctx, [dirty]) { + if (/*$toolbarIconLinks*/ ctx[0].icons.length) { + if (if_block) { + if_block.p(ctx, dirty); + + if (dirty & /*$toolbarIconLinks*/ 1) { + transition_in(if_block, 1); + } + } else { + if_block = create_if_block(ctx); + if_block.c(); + transition_in(if_block, 1); + if_block.m(if_block_anchor.parentNode, if_block_anchor); + } + } else if (if_block) { + group_outros(); + + transition_out(if_block, 1, 1, () => { + if_block = null; + }); + + check_outros(); + } + }, + i(local) { + if (current) return; + transition_in(if_block); + current = true; + }, + o(local) { + transition_out(if_block); + current = false; + }, + d(detaching) { + if (detaching) { + detach(if_block_anchor); + } + + if (if_block) if_block.d(detaching); + } + }; +} + +function instance$1($$self, $$props, $$invalidate) { + let $toolbarOffsetWidth; + let $toolbarIconLinks; + + const { componentStores } = /** @type {DMTComponentData} */ + getContext('#dmtComponentData'); + + /** @type {import('svelte/store').Writable} */ + const toolbarOffsetWidth = getContext('toolbarOffsetWidth'); + + component_subscribe($$self, toolbarOffsetWidth, value => $$invalidate(4, $toolbarOffsetWidth = value)); + const { toolbarIconLinks } = componentStores; + component_subscribe($$self, toolbarIconLinks, value => $$invalidate(0, $toolbarIconLinks = value)); + let component = IconBar; + + $$self.$$.update = () => { + if ($$self.$$.dirty & /*$toolbarOffsetWidth, $toolbarIconLinks*/ 17) { + // Pick which component to show based on space available in the toolbar. + if ($toolbarOffsetWidth > 0) { + // Wait until total icon link width is calculated to swap components. + if ($toolbarIconLinks.totalWidth > 0) { + $$invalidate(1, component = $toolbarIconLinks.totalWidth > $toolbarOffsetWidth + ? IconButton + : IconBar); + } + + // If there is less than 40px space show no component. + if ($toolbarOffsetWidth < 40) { + $$invalidate(1, component = void 0); + } + } + } + }; + + return [ + $toolbarIconLinks, + component, + toolbarOffsetWidth, + toolbarIconLinks, + $toolbarOffsetWidth + ]; +} + +class IconLinks extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance$1, create_fragment$1, safe_not_equal, {}); + } +} + +/* src\frontend\view\toolbar\Toolbar.svelte generated by Svelte v4.2.18 */ + +function create_fragment(ctx) { + let section; + let iconlinks; + let resizeObserver_action; + let current; + let mounted; + let dispose; + iconlinks = new IconLinks({}); + + return { + c() { + section = element("section"); + create_component(iconlinks.$$.fragment); + attr(section, "class", "svelte-j9157o"); + }, + m(target, anchor) { + insert(target, section, anchor); + mount_component(iconlinks, section, null); + current = true; + + if (!mounted) { + dispose = action_destroyer(resizeObserver_action = resizeObserver.call(null, section, /*resizeObserver_function*/ ctx[2])); + mounted = true; + } + }, + p(ctx, [dirty]) { + if (resizeObserver_action && is_function(resizeObserver_action.update) && dirty & /*$toolbarOffsetWidth*/ 1) resizeObserver_action.update.call(null, /*resizeObserver_function*/ ctx[2]); + }, + i(local) { + if (current) return; + transition_in(iconlinks.$$.fragment, local); + current = true; + }, + o(local) { + transition_out(iconlinks.$$.fragment, local); + current = false; + }, + d(detaching) { + if (detaching) { + detach(section); + } + + destroy_component(iconlinks); + mounted = false; + dispose(); + } + }; +} + +function instance($$self, $$props, $$invalidate) { + let $toolbarOffsetWidth; + const toolbarOffsetWidth = writable(0); + component_subscribe($$self, toolbarOffsetWidth, value => $$invalidate(0, $toolbarOffsetWidth = value)); + setContext('toolbarOffsetWidth', toolbarOffsetWidth); + const resizeObserver_function = offsetWidth => set_store_value(toolbarOffsetWidth, $toolbarOffsetWidth = offsetWidth, $toolbarOffsetWidth); + return [$toolbarOffsetWidth, toolbarOffsetWidth, resizeObserver_function]; +} + +class Toolbar extends SvelteComponent { + constructor(options) { + super(); + init(this, options, instance, create_fragment, safe_not_equal, {}); + } +} + +// Expose the compression / MessagePack handling functions into the global scope. This reduces any duplication across +// plugins that might work with compressed data. +globalThis.dmtInflateAndUnpack = inflateAndUnpack; +globalThis.dmtInflateAndUnpackB64 = inflateAndUnpackB64; + +// Loads the binary compressed message pack component data. Set as the main context in all components via +// `#dmtComponentData`. +const dmtComponentData = new DMTComponentData(import.meta.url); + +// Mount Svelte components ------------------------------------------------------------------------------------------- + +// Provides the main context for all Svelte components. +const componentContext = new Map([['#dmtComponentData', dmtComponentData]]); + +// Must initialize first so that `animate` local storage initially is configured from OS / browser +// `prefersReducedMotion` state. +const dmtSettings = new DMTSettings({ + target: document.querySelector('.tsd-navigation.settings .tsd-accordion-details'), + context: componentContext +}); + +// Remove the static sidebar links as DMT navigation includes the links. +const staticSidebarEl = document.querySelector('nav#tsd-sidebar-links'); +if (staticSidebarEl) { staticSidebarEl.remove(); } + +// Remove all default children from navigation as it is being replaced by the Navigation Svelte component. +const navEl = document.querySelector('nav.tsd-navigation'); +if (navEl && navEl.firstChild) +{ + while (navEl.firstChild) { navEl.removeChild(navEl.firstChild); } +} + +const navigation = new Navigation({ + target: document.querySelector('nav.tsd-navigation'), + context: componentContext +}); + +const toolbar = new Toolbar({ + target: document.querySelector('#dmt-toolbar'), + context: componentContext +}); + +// Stores references to DMT Svelte components. +globalThis.dmtComponents = { + dmtSettings, + navigation, + toolbar +}; + +// Only load main search index if enabled. +if (dmtComponentData.searchOptions) +{ + loadMainSearchData(); + globalThis.dmtComponents.searchMain = new SearchMain({ + target: document.querySelector('#dmt-search-main'), + context: componentContext + }); +} + +// Extended event handling ------------------------------------------------------------------------------------------- + +// Provides global keyboard commands. +keyCommands(dmtComponentData); + +// Provide automatic focusing of DMT scrollable containers on `pointerover` when there is no explicitly focused +// element allowing intuitive scrolling. +scrollActivation(); + +// Augmentation ------------------------------------------------------------------------------------------------------ + +// Augments default theme details elements to manage all accordions. +DetailsAccordion.initialize(dmtComponentData); + +// After first render ------------------------------------------------------------------------------------------------ + +// Adds a new style rule to set `body` visibility to `visible` after all scripts have loaded. This allows a smoother +// transition for the `main.js` default template script to take effect along with all Svelte components loaded before +// the page is initially visible. There is minimal flicker. +globalThis.requestAnimationFrame(() => +{ + const style = document.createElement('style'); + style.innerHTML = 'body { visibility: visible; }'; + document.head.appendChild(style); + + // Dynamically set CSS variable for the footer element so that scrolling for the details element for `On This Page` + // can account for the footer height. + const footerEl = document.querySelector('body main footer'); + if (footerEl) + { + document.documentElement.style.setProperty('--dmt-footer-height', `${footerEl.offsetHeight}px`); + } +}); diff --git a/docs/assets/dmt/dmt-search.cmp b/docs/assets/dmt/dmt-search.cmp index d80f0079..32ba05d9 100644 Binary files a/docs/assets/dmt/dmt-search.cmp and b/docs/assets/dmt/dmt-search.cmp differ diff --git a/docs/assets/dmt/dmt-theme.css b/docs/assets/dmt/dmt-theme.css index 21977c2e..e6991d5f 100644 --- a/docs/assets/dmt/dmt-theme.css +++ b/docs/assets/dmt/dmt-theme.css @@ -1 +1 @@ -:root{--dmt-box-shadow-color:#00000080;--dmt-container-border-radius:0.5rem;--dmt-container-box-shadow:0 0 0.15rem var(--dmt-box-shadow-color);--dmt-container-box-shadow-floating:0 0 0.75rem var(--dmt-box-shadow-color);--dmt-container-max-height:calc(100vh - var(--dmt-header-height));--dmt-container-padding:1rem;--dmt-container-padding-member:0.5rem;--dmt-header-height:42px;--dmt-overlay-panel-background:#27292e;--dmt-menu-item-background-hover:var(--color-accent);--dmt-menu-item-background-selected:var(--color-accent);--dmt-nav-folder-contents-border-color:var(--color-active-menu-item);--dmt-page-menu-max-height:calc(100vh - var(--dmt-header-height) - 1.5rem);--dmt-sidebar-max-height:calc(100vh - var(--dmt-header-height));--dmt-focus-visible-color:orange;--dmt-outline-focus-visible:3px solid var(--dmt-focus-visible-color);--tjs-folder-summary-chevron-border-radius:0.25rem;--tjs-default-outline-focus-visible:var(--dmt-outline-focus-visible)}:root[data-theme=dark]{--dmt-box-shadow-color:#0009;--dmt-container-background:#0000001a;--dmt-container-border:2px solid #0003;--dmt-container-floating-border:2px solid #0009;--dmt-container-separator-border:1px solid #000c;--dmt-overlay-panel-background:#27292e}:root[data-theme=light]{--dmt-box-shadow-color:#0000004d;--dmt-container-background:#0000000d;--dmt-container-border:2px solid #0000001a;--dmt-container-floating-border:2px solid #0000004d;--dmt-container-separator-border:1px solid #0006;--dmt-overlay-panel-background:#e6e8eb}@media (prefers-color-scheme:dark){:root{--dmt-box-shadow-color:#0009;--dmt-container-background:#0000001a;--dmt-container-border:2px solid #0003;--dmt-container-floating-border:2px solid #0009;--dmt-container-separator-border:1px solid #000c;--dmt-overlay-panel-background:#27292e}}@media (prefers-color-scheme:light){:root{--dmt-box-shadow-color:#0000004d;--dmt-container-background:#0000000d;--dmt-container-border:2px solid #0000001a;--dmt-container-floating-border:2px solid #0000004d;--dmt-container-separator-border:1px solid #0006;--dmt-overlay-panel-background:#e6e8eb}}#dmt-toolbar{container:dmt-toolbar/inline-size}.col-content{container:col-content/inline-size}.site-menu{container:site-menu/inline-size}::-webkit-scrollbar{height:.75rem}.dmt-title-header-flex{align-items:center;display:flex;flex-wrap:nowrap}.dmt-title-header-flex h1{margin-right:auto}a.tsd-anchor-icon:focus-visible>svg{visibility:visible}summary.tsd-accordion-summary:focus-visible{outline:revert}.tsd-panel.tsd-member .tsd-anchor-link .tsd-anchor-icon{margin-right:auto}.site-menu:focus-visible,details.tsd-page-navigation .tsd-accordion-details:focus-visible,div.container.container-main{outline:2px solid #0000}header.tsd-page-toolbar{height:var(--dmt-header-height);position:fixed;top:0}.container{max-width:unset}.container.container-main{margin-top:var(--dmt-header-height);max-height:var(--dmt-container-max-height);overflow-x:hidden;overflow-y:auto}.col-content{height:fit-content;margin-bottom:1rem;margin-top:.75rem;max-width:1300px}.site-menu{margin-top:0;max-height:var(--dmt-sidebar-max-height);padding-left:.1rem;top:0}.site-menu .tsd-accordion-summary{align-items:center;display:flex}.site-menu .tsd-nested-navigation{margin-left:2.5rem}.page-menu{display:flex;flex-direction:column;gap:1rem;max-height:var(--dmt-page-menu-max-height);overflow:revert;padding-left:.25rem;padding-top:.75rem;position:sticky;top:0}.tsd-generator{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);margin-bottom:.75rem}@media (min-width:770px) and (max-width:1399px){.col-sidebar{max-height:var(--dmt-sidebar-max-height);padding-top:0;top:0}}.container-main{background:var(--color-background)}.dmt-summary-svg{transition:transform .1s}:focus-visible{outline:var(--dmt-outline-focus-visible)}details .tsd-accordion-summary:focus-visible{outline:none}details .tsd-accordion-summary:focus-visible svg{border-radius:.25rem;outline:var(--dmt-outline-focus-visible)}details .tsd-accordion-summary h3,details .tsd-accordion-summary h5{align-items:center;display:flex;gap:.25rem}.tsd-navigation a,.tsd-navigation summary>span,.tsd-page-navigation a{padding:.25rem}a{border-radius:.25rem}@container dmt-toolbar (min-width: 0){.title{font-size:clamp(.75rem,2.5cqi,1rem)}}@container col-content (min-width: 0){.tsd-page-title h1{font-size:clamp(1rem,3.5cqi,2rem)}.tsd-kind-icon~span,h5{font-size:clamp(.8rem,2.5cqi,1rem)}}@container site-menu (min-width: 0){.tsd-navigation span{font-size:clamp(.8rem,5cqi,1rem)}}.tsd-page-toolbar{box-shadow:var(--dmt-header-box-shadow)}.tsd-page-toolbar .tsd-toolbar-icon{padding:12px}#dmt-toolbar{align-items:center;display:flex}#dmt-toolbar a.title{height:32px;line-height:32px}.container{margin:0 auto;padding:0 1rem}.container .tsd-signature{border-radius:.5rem}.container .tsd-signatures .tsd-signature{border-radius:0}.container .tsd-panel-group.tsd-index-group details{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow);padding:var(--dmt-container-padding)}.container .tsd-panel-group.tsd-index-group details .tsd-index-heading{margin:0 0 15px}.container .tsd-panel-group.tsd-index-group details:not([open]) .tsd-index-heading.uppercase{margin:0}.container .tsd-panel-group.tsd-index-group details .tsd-accordion-details section:not(:last-child){margin-bottom:15px}.container section.tsd-index-section .tsd-index-list{padding:var(--dmt-container-padding)}.container section.tsd-index-section .tsd-index-list,.container section.tsd-panel.tsd-member{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow)}.container section.tsd-panel.tsd-member{margin-bottom:2rem;padding:var(--dmt-container-padding-member)}.container .tsd-returns-title p,.container li.tsd-description,.container ul.tsd-signatures{margin-bottom:0}.container ul.tsd-parameter-list{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow);padding:var(--dmt-container-padding-member);padding-left:1.5rem}.container ul.tsd-parameter-list h5:first-child,.container ul.tsd-parameter-list h5:last-child{margin-top:0}.container ul.tsd-parameter-list ul.tsd-parameters{background:unset;border:unset;border-radius:unset;box-shadow:unset}.container ul.tsd-parameters{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow);display:flex;flex-direction:column;gap:1rem;margin-bottom:0;padding:var(--dmt-container-padding-member);padding-left:1.5rem}.container ul.tsd-parameters h5:first-child{margin-top:0}.container ul.tsd-parameters h5:last-child{margin-bottom:0}.container ul.tsd-parameters.no-children{background:unset;border:unset;border-radius:unset;box-shadow:unset;margin:0;padding:0}.container .tsd-breadcrumb li:last-child:after{content:""}@media (min-width:2190px){.container-main{grid-template-columns:minmax(0,520px) minmax(0,1300px) 1fr;margin-left:calc(50% - 1095px);padding-right:calc(50% - 1095px)}}@media (width < 1200px){.tsd-index-accordion.tsd-page-navigation{display:none}.page-menu{margin-bottom:.75rem;padding-right:1rem;position:static}.site-menu{max-height:unset}}@media (max-width:769px){.from-has-menu .col-sidebar{display:flex;flex-direction:column}.from-has-menu .col-sidebar,.has-menu .col-sidebar{gap:.5rem;padding:0 0 0 1rem}}.page-menu .tsd-navigation.settings{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow-floating);margin:0;padding:var(--dmt-container-padding)}.page-menu .tsd-navigation.settings .tsd-accordion-summary{width:inherit}.page-menu .tsd-navigation.settings .tsd-filter-visibility h4{padding-top:.25rem}.page-menu .tsd-navigation.settings input[type=checkbox]:focus-visible+svg{outline:var(--dmt-outline-focus-visible)}.page-menu details.tsd-index-accordion.tsd-page-navigation{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow-floating);overflow:hidden;padding:var(--dmt-container-padding)}.page-menu details.tsd-index-accordion.tsd-page-navigation .tsd-accordion-details{height:calc(100% - var(--dmt-header-height));overflow:auto}.page-menu details.tsd-index-accordion.tsd-page-navigation .tsd-accordion-details ul{padding:.25rem 0 .25rem .5rem}.page-menu details[open].tsd-index-accordion.tsd-page-navigation{padding:var(--dmt-container-padding) 0 0 var(--dmt-container-padding)}.page-menu details[open].tsd-index-accordion.tsd-page-navigation .tsd-accordion-summary{width:calc(100% - 1rem)}.page-menu details[open] .tsd-accordion-summary{border-bottom:var(--dmt-container-border);padding-bottom:var(--dmt-container-padding)} \ No newline at end of file +:root{--dmt-box-shadow-color:#00000080;--dmt-container-border-radius:0.5rem;--dmt-container-box-shadow:0 0 0.15rem var(--dmt-box-shadow-color);--dmt-container-box-shadow-floating:0 0 0.75rem var(--dmt-box-shadow-color);--dmt-container-max-height:calc(100vh - var(--dmt-header-height));--dmt-container-padding:1rem;--dmt-container-padding-member:0.5rem;--dmt-header-height:42px;--dmt-overlay-panel-background:#27292e;--dmt-menu-item-background-hover:var(--color-accent);--dmt-menu-item-background-selected:var(--color-accent);--dmt-nav-folder-contents-border-color:var(--color-active-menu-item);--dmt-page-menu-max-height:calc(100vh - var(--dmt-header-height) - var(--dmt-footer-height, 0px) - 1.5rem);--dmt-focus-visible-color:orange;--dmt-outline-focus-visible:3px solid var(--dmt-focus-visible-color);--tjs-folder-summary-chevron-border-radius:0.25rem;--tjs-default-outline-focus-visible:var(--dmt-outline-focus-visible)}:root[data-theme=dark]{--dmt-box-shadow-color:#0009;--dmt-container-background:#0000001a;--dmt-container-border:2px solid #0003;--dmt-container-floating-border:2px solid #0009;--dmt-container-separator-border:1px solid #000c;--dmt-overlay-panel-background:#27292e}:root[data-theme=light]{--dmt-box-shadow-color:#0000004d;--dmt-container-background:#0000000d;--dmt-container-border:2px solid #0000001a;--dmt-container-floating-border:2px solid #0000004d;--dmt-container-separator-border:1px solid #0006;--dmt-overlay-panel-background:#e6e8eb}@media (prefers-color-scheme:dark){:root{--dmt-box-shadow-color:#0009;--dmt-container-background:#0000001a;--dmt-container-border:2px solid #0003;--dmt-container-floating-border:2px solid #0009;--dmt-container-separator-border:1px solid #000c;--dmt-overlay-panel-background:#27292e}}@media (prefers-color-scheme:light){:root{--dmt-box-shadow-color:#0000004d;--dmt-container-background:#0000000d;--dmt-container-border:2px solid #0000001a;--dmt-container-floating-border:2px solid #0000004d;--dmt-container-separator-border:1px solid #0006;--dmt-overlay-panel-background:#e6e8eb}}#dmt-toolbar{container:dmt-toolbar/inline-size}.col-content{container:col-content/inline-size}.site-menu{container:site-menu/inline-size}body main{box-sizing:border-box;display:flex;flex-direction:column;height:100vh;overflow:hidden;width:100vw}body footer{flex-shrink:0;height:fit-content;width:100%}::-webkit-scrollbar{height:.75rem}.dmt-title-header-flex{align-items:center;display:flex;flex-wrap:nowrap}.dmt-title-header-flex h1{margin-right:auto}a.tsd-anchor-icon:focus-visible>svg{visibility:visible}summary.tsd-accordion-summary:focus-visible{outline:revert}.tsd-panel.tsd-member .tsd-anchor-link .tsd-anchor-icon{margin-right:auto}.site-menu:focus-visible,details.tsd-page-navigation .tsd-accordion-details:focus-visible,div.container.container-main{outline:2px solid #0000}header.tsd-page-toolbar{flex-shrink:0;height:var(--dmt-header-height);left:unset;position:unset;top:unset}.container{max-width:unset}.container.container-main{box-sizing:border-box;flex-grow:1;overflow-x:hidden;width:100%}.col-content{display:flex;flex-direction:column;height:fit-content;margin-bottom:1rem;margin-top:.75rem;max-width:1300px;overflow:hidden}.col-content .tsd-panel,.col-content .tsd-panel-group{margin-bottom:0}.col-content details[open].tsd-hierarchy>.tsd-accordion-summary,.col-content details[open].tsd-index-content>.tsd-accordion-summary{border-bottom:var(--dmt-container-border);padding-bottom:var(--dmt-container-padding)}.col-content details.tsd-panel-group summary{background:linear-gradient(to right,var(--dmt-container-background),var(--color-background));border-bottom:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius) 0 0 var(--dmt-container-border-radius);padding:.25rem}.site-menu{margin-top:0;max-height:unset;padding-left:.1rem;top:0}.site-menu .tsd-accordion-summary{align-items:center;display:flex}.site-menu .tsd-nested-navigation{margin-left:2.5rem}.page-menu{display:flex;flex-direction:column;gap:1rem;max-height:var(--dmt-page-menu-max-height);overflow:revert;padding-left:.25rem;padding-top:.75rem;position:sticky;top:0}@media (min-width:770px) and (max-width:1399px){.col-sidebar{max-height:unset;padding-top:0;top:0}}details.tsd-accordion[open] svg{transform:rotate(0deg)}details.tsd-accordion:not([open]) svg{transform:rotate(-90deg)}.dmt-summary-svg{transition:transform .1s}.container-main{background:var(--color-background)}:focus-visible{outline:var(--dmt-outline-focus-visible)}details .tsd-accordion-summary:focus-visible{outline:none}details .tsd-accordion-summary:focus-visible svg{border-radius:.25rem;outline:var(--dmt-outline-focus-visible)}details .tsd-accordion-summary h3,details .tsd-accordion-summary h5{align-items:center;display:flex;gap:.25rem}nav.tsd-navigation{display:flex;flex-direction:column;gap:.75rem}nav.tsd-navigation>section:first-child{margin-top:.75rem}nav.tsd-navigation>section:first-child.source-index{margin-top:0}.tsd-navigation a,.tsd-navigation summary>span,.tsd-page-navigation a{padding:.25rem}a{border-radius:.25rem}@container dmt-toolbar (min-width: 0){.title{font-size:clamp(.75rem,2.5cqi,1rem)}}@container col-content (min-width: 0){.tsd-page-title h1{font-size:clamp(1rem,3.5cqi,2rem)}.tsd-kind-icon~span,h5{font-size:clamp(.8rem,2.5cqi,1rem)}}@container site-menu (min-width: 0){.tsd-navigation span{font-size:clamp(.8rem,5cqi,1rem)}}.tsd-page-toolbar{box-shadow:var(--dmt-header-box-shadow)}.tsd-page-toolbar .tsd-toolbar-contents{padding:0 .25rem 0 1rem}.tsd-page-toolbar .tsd-toolbar-icon{padding:12px}.tsd-page-toolbar .tsd-toolbar-icon.menu{height:30px;margin:6px;padding:6px;width:28px}#dmt-toolbar{align-items:center;display:flex}#dmt-toolbar a.title{height:32px;line-height:32px;padding-right:.5rem}.container{margin:0 auto;padding:0 1rem}.container .tsd-signature{border-radius:.5rem}.container .tsd-signatures .tsd-signature{border-radius:0}.container .tsd-panel-group.tsd-index-group details,.container .tsd-panel-group.tsd-index-group details .tsd-accordion-summary .tsd-index-heading{margin:0}.container .tsd-panel-group.tsd-index-group details .tsd-accordion-details .tsd-index-heading{margin:0 0 15px}.container .tsd-panel-group.tsd-index-group details .tsd-accordion-details section:not(:last-child){margin-bottom:15px}.container .tsd-panel-group.tsd-hierarchy .tsd-accordion-summary a,.container .tsd-panel-group.tsd-index-group .tsd-accordion-summary a{width:unset}.container .tsd-panel-group.tsd-hierarchy details,.container .tsd-panel-group.tsd-index-group details{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow);padding:var(--dmt-container-padding)}.container .tsd-panel-group.tsd-hierarchy .tsd-accordion-details{padding-top:.75rem}.container .tsd-panel-group.tsd-hierarchy .tsd-accordion-details ul.tsd-hierarchy{padding-left:1.25rem}.container section.tsd-index-section .tsd-index-list{padding:var(--dmt-container-padding)}.container section.tsd-index-section .tsd-index-list,.container section.tsd-panel.tsd-member{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow)}.container section.tsd-panel.tsd-member{margin-bottom:2rem;padding:var(--dmt-container-padding-member)}.container .tsd-returns-title p,.container li.tsd-description,.container ul.tsd-signatures{margin-bottom:0}.container ul.tsd-parameter-list{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow);padding:var(--dmt-container-padding-member);padding-left:1.5rem}.container ul.tsd-parameter-list h5:first-child,.container ul.tsd-parameter-list h5:last-child{margin-top:0}.container ul.tsd-parameter-list ul.tsd-parameters{background:unset;border:unset;border-radius:unset;box-shadow:unset}.container ul.tsd-parameters{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow);display:flex;flex-direction:column;gap:1rem;margin-bottom:0;padding:var(--dmt-container-padding-member);padding-left:1.5rem}.container ul.tsd-parameters h5:first-child{margin-top:0}.container ul.tsd-parameters h5:last-child{margin-bottom:0}.container ul.tsd-parameters.no-children{background:unset;border:unset;border-radius:unset;box-shadow:unset;margin:0;padding:0}.container .tsd-breadcrumb li:last-child:after{content:""}@media (min-width:2190px){.page-menu{max-width:350px}.container-main{grid-template-columns:minmax(0,520px) minmax(0,1300px) 1fr;padding-left:calc(50% - 1095px)}}@media (width < 1200px){.tsd-accordion.tsd-page-navigation{display:none}.page-menu{margin-bottom:.75rem;padding-right:1rem;position:static}.site-menu{max-height:unset}}@media (max-width:769px){.from-has-menu .col-sidebar{display:flex;flex-direction:column}.from-has-menu .col-sidebar,.has-menu .col-sidebar{gap:.5rem;padding:0 0 0 1rem}}.page-menu .tsd-navigation.settings{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow-floating);margin:0;padding:var(--dmt-container-padding)}.page-menu .tsd-navigation.settings .tsd-accordion-summary{width:inherit}.page-menu .tsd-navigation.settings .tsd-filter-visibility h4{padding-top:.25rem}.page-menu .tsd-navigation.settings input[type=checkbox]:focus-visible+svg{outline:var(--dmt-outline-focus-visible)}.page-menu details.tsd-accordion.tsd-page-navigation{background:var(--dmt-container-background);border:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius);box-shadow:var(--dmt-container-box-shadow-floating);overflow:hidden;padding:var(--dmt-container-padding)}.page-menu details.tsd-accordion.tsd-page-navigation .tsd-accordion-details{height:calc(100% - var(--dmt-header-height));overflow:auto}.page-menu details.tsd-accordion.tsd-page-navigation .tsd-accordion-details ul{padding:.25rem 0 .25rem .5rem}.page-menu details[open].tsd-accordion.tsd-page-navigation{padding:var(--dmt-container-padding) 0 var(--dmt-container-padding) var(--dmt-container-padding)}.page-menu details[open].tsd-accordion.tsd-page-navigation>.tsd-accordion-summary{width:calc(100% - 1rem)}.page-menu details[open].tsd-accordion.tsd-page-navigation .tsd-accordion-details{padding-top:.75rem}.page-menu .tsd-navigation.settings details[open]>.tsd-accordion-summary,.page-menu details[open].tsd-page-navigation>.tsd-accordion-summary{border-bottom:var(--dmt-container-border);padding-bottom:var(--dmt-container-padding)}.page-menu .tsd-page-navigation details.tsd-page-navigation-section{margin:0 var(--dmt-container-padding) 0 0}.page-menu .tsd-page-navigation details.tsd-page-navigation-section:not(:last-child){margin-bottom:.25rem}.page-menu .tsd-page-navigation details.tsd-page-navigation-section summary{align-items:center;background:linear-gradient(to right,var(--dmt-container-background),#0000);border-bottom:var(--dmt-container-border);border-radius:var(--dmt-container-border-radius) 0 0 var(--dmt-container-border-radius);display:flex;gap:.25rem} \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css index 2747806e..e8652c15 100644 --- a/docs/assets/highlight.css +++ b/docs/assets/highlight.css @@ -9,12 +9,12 @@ --dark-hl-3: #CE9178; --light-hl-4: #795E26; --dark-hl-4: #DCDCAA; - --light-hl-5: #0000FF; - --dark-hl-5: #569CD6; - --light-hl-6: #0070C1; - --dark-hl-6: #4FC1FF; - --light-hl-7: #008000; - --dark-hl-7: #6A9955; + --light-hl-5: #008000; + --dark-hl-5: #6A9955; + --light-hl-6: #0000FF; + --dark-hl-6: #569CD6; + --light-hl-7: #0070C1; + --dark-hl-7: #4FC1FF; --light-hl-8: #000000FF; --dark-hl-8: #D4D4D4; --light-hl-9: #098658; diff --git a/docs/assets/icons.js b/docs/assets/icons.js index b79c9e89..e88e8ca7 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -1,15 +1,18 @@ -(function(svg) { - svg.innerHTML = ``; - svg.style.display = 'none'; - if (location.protocol === 'file:') { - if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); - else updateUseElements() - function updateUseElements() { - document.querySelectorAll('use').forEach(el => { - if (el.getAttribute('href').includes('#icon-')) { - el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); - } - }); - } +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `""`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); } -})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index 7dead611..e371b8b5 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 081d43f0..97603fa9 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,8 +1,9 @@ "use strict"; -"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.scrollToHash(),this.updateIndexVisibility())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.scrollToHash(),this.updateIndexVisibility())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});})(); +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings."}; +"use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/style.css b/docs/assets/style.css index 072daed8..9d619a64 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -10,6 +10,7 @@ --light-color-text: #222; --light-color-text-aside: #6e6e6e; --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; --light-color-ts-keyword: #056bd6; --light-color-ts-project: #b111c9; @@ -35,6 +36,7 @@ --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-color-document: #000000; --light-external-icon: url("data:image/svg+xml;utf8,"); --light-color-scheme: light; @@ -50,6 +52,7 @@ --dark-color-text: #f5f5f5; --dark-color-text-aside: #dddddd; --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; --dark-color-ts-keyword: #3399ff; --dark-color-ts-project: #e358ff; @@ -75,6 +78,7 @@ --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-color-document: #ffffff; --dark-external-icon: url("data:image/svg+xml;utf8,"); --dark-color-scheme: dark; @@ -92,6 +96,7 @@ --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); @@ -116,6 +121,7 @@ --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); + --color-document: var(--light-color-document); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); @@ -134,6 +140,7 @@ --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); @@ -158,6 +165,7 @@ --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); + --color-document: var(--dark-color-document); --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); @@ -183,6 +191,7 @@ body { --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); --color-ts-keyword: var(--light-color-ts-keyword); --color-ts-module: var(--light-color-ts-module); @@ -207,6 +216,7 @@ body { --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); + --color-document: var(--light-color-document); --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); @@ -223,6 +233,7 @@ body { --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); --color-ts-keyword: var(--dark-color-ts-keyword); --color-ts-module: var(--dark-color-ts-module); @@ -247,11 +258,17 @@ body { --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); + --color-document: var(--dark-color-document); --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } +*:focus-visible, +.tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); +} + .always-visible, .always-visible .tsd-signatures { display: inherit !important; @@ -266,16 +283,6 @@ h6 { line-height: 1.2; } -h1 > a:not(.link), -h2 > a:not(.link), -h3 > a:not(.link), -h4 > a:not(.link), -h5 > a:not(.link), -h6 > a:not(.link) { - text-decoration: none; - color: var(--color-text); -} - h1 { font-size: 1.875rem; margin: 0.67rem 0; @@ -306,10 +313,6 @@ h6 { margin: 2.33rem 0; } -.uppercase { - text-transform: uppercase; -} - dl, menu, ol, @@ -327,17 +330,14 @@ dd { } /* Footer */ -.tsd-generator { +footer { 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; +footer > p { + margin: 0 1em; } .container-main { @@ -424,6 +424,9 @@ a.external[target="_blank"] { background-repeat: no-repeat; padding-right: 13px; } +a.tsd-anchor-link { + color: var(--color-text); +} code, pre { @@ -583,13 +586,13 @@ dl.tsd-comment-tag-group p { } .tsd-filter-input { display: flex; - width: fit-content; width: -moz-fit-content; + width: fit-content; align-items: center; - user-select: none; -webkit-user-select: none; -moz-user-select: none; -ms-user-select: none; + user-select: none; cursor: pointer; } .tsd-filter-input input[type="checkbox"] { @@ -612,11 +615,8 @@ dl.tsd-comment-tag-group p { Don't remove unless you know what you're doing. */ opacity: 0.99; } -.tsd-filter-input input[type="checkbox"]:focus + svg { - transform: scale(0.95); -} -.tsd-filter-input input[type="checkbox"]:focus:not(:focus-visible) + svg { - transform: scale(1); +.tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); } .tsd-checkbox-background { fill: var(--color-accent); @@ -633,13 +633,18 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { stroke: var(--color-accent); } -.tsd-theme-toggle { - padding-top: 0.75rem; +.settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; } -.tsd-theme-toggle > h4 { - display: inline; - vertical-align: middle; - margin-right: 0.75rem; + +.tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; +} + +.tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; } .tsd-hierarchy { @@ -772,6 +777,9 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { padding: 0; max-width: 100%; } +.tsd-navigation .tsd-nav-link { + display: none; +} .tsd-nested-navigation { margin-left: 3rem; } @@ -785,6 +793,15 @@ input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { margin-left: -1.5rem; } +.tsd-page-navigation-section { + margin-left: 10px; +} +.tsd-page-navigation-section > summary { + padding: 0.25rem; +} +.tsd-page-navigation-section > div { + margin-left: 20px; +} .tsd-page-navigation ul { padding-left: 1.75rem; } @@ -815,10 +832,10 @@ a.tsd-index-link { } .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; cursor: pointer; } @@ -831,8 +848,9 @@ a.tsd-index-link { padding-top: 0; padding-bottom: 0; } -.tsd-index-accordion .tsd-accordion-summary > svg { +.tsd-accordion .tsd-accordion-summary > svg { margin-left: 0.25rem; + vertical-align: text-top; } .tsd-index-content > :not(:first-child) { margin-top: 0.75rem; @@ -880,7 +898,7 @@ a.tsd-index-link { } .tsd-panel-group { - margin: 4rem 0; + margin: 2rem 0; } .tsd-panel-group.tsd-index-group { margin: 2rem 0; @@ -888,6 +906,9 @@ a.tsd-index-link { .tsd-panel-group.tsd-index-group details { margin: 2rem 0; } +.tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; +} #tsd-search { transition: background-color 0.2s; @@ -1037,6 +1058,12 @@ a.tsd-index-link { border-width: 1px 0; transition: background-color 0.1s; } +.tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; +} +.tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; +} .tsd-description .tsd-signatures .tsd-signature { border-width: 1px; } @@ -1350,6 +1377,12 @@ img { .has-menu .tsd-navigation { max-height: 100%; } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } } /* one sidebar */ diff --git a/docs/classes/_runtime_color_colord.Colord.html b/docs/classes/_runtime_color_colord.Colord.html index 63a2116f..e7b65e38 100644 --- a/docs/classes/_runtime_color_colord.Colord.html +++ b/docs/classes/_runtime_color_colord.Colord.html @@ -1,4 +1,5 @@ -Colord | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

Class Colord

Constructors

constructor +Colord | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
+

Class Colord

Constructors

constructor

Methods

alpha brightness darken @@ -20,13 +21,13 @@ toRgb toRgbString

Properties

rgba -

Constructors

constructor

Methods

alpha

  • alpha(): number

  • Allows to get or change an alpha channel value.

    +

Constructors

constructor

Methods

alpha

  • alpha(): number

  • Allows to get or change an alpha channel value.

    Returns number

  • alpha(value): Colord

  • Parameters

    • value: number

    Returns Colord

brightness

darken

  • darken(amount?): Colord

  • Increases the HSL lightness of a color by the given amount.

    -

    Parameters

    • Optional amount: number

    Returns Colord

desaturate

  • desaturate(amount?): Colord

  • Decreases the HSL saturation of a color by the given amount.

    -

    Parameters

    • Optional amount: number

    Returns Colord

grayscale

  • grayscale(): Colord

  • Makes a gray color with the same lightness as a source color.

    +

    Parameters

    • Optionalamount: number

    Returns Colord

desaturate

  • desaturate(amount?): Colord

  • Decreases the HSL saturation of a color by the given amount.

    +

    Parameters

    • Optionalamount: number

    Returns Colord

grayscale

  • grayscale(): Colord

  • Makes a gray color with the same lightness as a source color.

    Returns Colord

hue

  • hue(): number

  • Allows to get or change a hue value.

    Returns number

  • hue(value): Colord

  • Parameters

    • value: number

    Returns Colord

invert

  • invert(): Colord

  • Creates a new instance containing an inverted (opposite) version of the color.

    Returns Colord

isDark

  • isDark(): boolean

  • Same as calling brightness() < 0.5.

    @@ -35,19 +36,19 @@

    Returns boolean

isValid

  • isValid(): boolean

  • Returns a boolean indicating whether or not an input has been parsed successfully. Note: If parsing is unsuccessful, Colord defaults to black (does not throws an error).

    Returns boolean

lighten

  • lighten(amount?): Colord

  • Increases the HSL lightness of a color by the given amount.

    -

    Parameters

    • Optional amount: number

    Returns Colord

rotate

  • rotate(amount?): Colord

  • Changes the HSL hue of a color by the given amount.

    -

    Parameters

    • Optional amount: number

    Returns Colord

saturate

  • saturate(amount?): Colord

  • Increases the HSL saturation of a color by the given amount.

    -

    Parameters

    • Optional amount: number

    Returns Colord

toHex

  • toHex(): string

  • Returns the hexadecimal representation of a color. +

    Parameters

    • Optionalamount: number

    Returns Colord

rotate

  • rotate(amount?): Colord

  • Changes the HSL hue of a color by the given amount.

    +

    Parameters

    • Optionalamount: number

    Returns Colord

saturate

  • saturate(amount?): Colord

  • Increases the HSL saturation of a color by the given amount.

    +

    Parameters

    • Optionalamount: number

    Returns Colord

toHex

  • toHex(): string

  • Returns the hexadecimal representation of a color. When the alpha channel value of the color is less than 1, it outputs #rrggbbaa format instead of #rrggbb.

    Returns string

toHsl

  • toHsl(digits?): HslaColor

  • Converts a color to HSL color space and returns an object. Always includes an alpha value from 0 to 1.

    -

    Parameters

    • Optional digits: number

    Returns HslaColor

toHslString

  • toHslString(digits?): string

  • Converts a color to HSL color space and returns a string representation. +

    Parameters

    • Optionaldigits: number

    Returns HslaColor

toHslString

  • toHslString(digits?): string

  • Converts a color to HSL color space and returns a string representation. Always includes an alpha value from 0 to 1.

    -

    Parameters

    • Optional digits: number

    Returns string

toHsv

  • toHsv(digits?): HsvaColor

  • Converts a color to HSV color space and returns an object. +

    Parameters

    • Optionaldigits: number

    Returns string

toHsv

  • toHsv(digits?): HsvaColor

  • Converts a color to HSV color space and returns an object. Always includes an alpha value from 0 to 1.

    -

    Parameters

    • Optional digits: number

    Returns HsvaColor

toRgb

  • toRgb(digits?): RgbaColor

  • Converts a color to RGB color space and returns an object. +

    Parameters

    • Optionaldigits: number

    Returns HsvaColor

toRgb

  • toRgb(digits?): RgbaColor

  • Converts a color to RGB color space and returns an object. Always includes an alpha value from 0 to 1.

    -

    Parameters

    • Optional digits: number

    Returns RgbaColor

toRgbString

  • toRgbString(digits?): string

  • Converts a color to RGB color space and returns a string representation. +

    Parameters

    • Optionaldigits: number

    Returns RgbaColor

toRgbString

  • toRgbString(digits?): string

  • Converts a color to RGB color space and returns a string representation. Outputs an alpha value only if it is less than 1.

    -

    Parameters

    • Optional digits: number

    Returns string

Properties

Readonly rgba

rgba: RgbaColor

Settings

Member Visibility

Theme

On This Page

constructoralphabrightnessdarkendesaturategrayscalehueinvertisDarkisEqualisLightisValidlightenrotatesaturatetoHextoHsltoHslStringtoHsvtoRgbtoRgbStringrgba
\ No newline at end of file +

Parameters

  • Optionaldigits: number

Returns string

Properties

Readonlyrgba

rgba: RgbaColor

Settings

Member Visibility

On This Page

Constructors
Methods
Properties
\ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.AsyncCompress.html b/docs/classes/_runtime_data_compress.AsyncCompress.html index 5cd6b00d..2ff3bb8a 100644 --- a/docs/classes/_runtime_data_compress.AsyncCompress.html +++ b/docs/classes/_runtime_data_compress.AsyncCompress.html @@ -1,24 +1,25 @@ -AsyncCompress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

Class AsyncCompress

Asynchronous streaming GZIP compression

-

Constructors

constructor +AsyncCompress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
+

Class AsyncCompress

Asynchronous streaming GZIP compression

+

Constructors

constructor

Methods

flush push

Properties

ondata ondrain? queuedSize terminate -

Constructors

constructor

  • new AsyncCompress(opts, cb?): AsyncCompress

  • Creates an asynchronous GZIP stream

    +

Constructors

constructor

Methods

flush

  • flush(): void

  • Flushes buffered uncompressed data. Useful to immediately retrieve the +

    Parameters

    Returns AsyncCompress

Methods

flush

  • flush(): void

  • Flushes buffered uncompressed data. Useful to immediately retrieve the GZIPped output for small inputs.

    Returns void

push

  • push(chunk, final?): void

  • Pushes a chunk to be GZIPped

    Parameters

    • chunk: Uint8Array

      The chunk to push

      -
    • Optional final: boolean

      Whether this is the last chunk

      -

    Returns void

Properties

ondata

ondata: AsyncFlateStreamHandler

The handler to call whenever data is available

-

Optional ondrain

ondrain?: AsyncFlateDrainHandler

The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

+
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Optionalondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    queuedSize

    queuedSize: number

    The number of uncompressed bytes buffered in the stream

    terminate

    terminate: AsyncTerminable

    A method to terminate the stream's internal worker. Subsequent calls to push() will silently fail.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorflushpushondataondrainqueuedSizeterminate
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.AsyncDecompress.html b/docs/classes/_runtime_data_compress.AsyncDecompress.html index 02ba7568..d6f65b92 100644 --- a/docs/classes/_runtime_data_compress.AsyncDecompress.html +++ b/docs/classes/_runtime_data_compress.AsyncDecompress.html @@ -1,18 +1,19 @@ -AsyncDecompress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class AsyncDecompress

    Asynchronous streaming GZIP, Zlib, or raw DEFLATE decompression

    -

    Constructors

    constructor +AsyncDecompress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class AsyncDecompress

    Asynchronous streaming GZIP, Zlib, or raw DEFLATE decompression

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata ondrain? queuedSize -

    Constructors

    constructor

    • new AsyncDecompress(opts, cb?): AsyncDecompress

    • Creates an asynchronous decompression stream

      +

    Constructors

    constructor

    Methods

    push

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decompressed

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    -

    Optional ondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Optionalondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    queuedSize

    queuedSize: number

    The number of compressed bytes buffered in the stream

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondataondrainqueuedSize
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.AsyncDeflate.html b/docs/classes/_runtime_data_compress.AsyncDeflate.html index eac442f3..63467ea8 100644 --- a/docs/classes/_runtime_data_compress.AsyncDeflate.html +++ b/docs/classes/_runtime_data_compress.AsyncDeflate.html @@ -1,24 +1,25 @@ -AsyncDeflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class AsyncDeflate

    Asynchronous streaming DEFLATE compression

    -

    Constructors

    constructor +AsyncDeflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class AsyncDeflate

    Asynchronous streaming DEFLATE compression

    +

    Constructors

    constructor

    Methods

    flush push

    Properties

    ondata ondrain? queuedSize terminate -

    Constructors

    constructor

    • new AsyncDeflate(opts, cb?): AsyncDeflate

    • Creates an asynchronous DEFLATE stream

      +

    Constructors

    constructor

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the +

      Parameters

      Returns AsyncDeflate

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the deflated output for small inputs.

      Returns void

    push

    • push(chunk, final?): void

    • Pushes a chunk to be deflated

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    -

    Optional ondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Optionalondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    queuedSize

    queuedSize: number

    The number of uncompressed bytes buffered in the stream

    terminate

    terminate: AsyncTerminable

    A method to terminate the stream's internal worker. Subsequent calls to push() will silently fail.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorflushpushondataondrainqueuedSizeterminate
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.AsyncGunzip.html b/docs/classes/_runtime_data_compress.AsyncGunzip.html index ce193760..db279510 100644 --- a/docs/classes/_runtime_data_compress.AsyncGunzip.html +++ b/docs/classes/_runtime_data_compress.AsyncGunzip.html @@ -1,23 +1,24 @@ -AsyncGunzip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class AsyncGunzip

    Asynchronous streaming single or multi-member GZIP decompression

    -

    Constructors

    constructor +AsyncGunzip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class AsyncGunzip

    Asynchronous streaming single or multi-member GZIP decompression

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata ondrain? onmember? queuedSize terminate -

    Constructors

    constructor

    • new AsyncGunzip(opts, cb?): AsyncGunzip

    • Creates an asynchronous GUNZIP stream

      +

    Constructors

    constructor

    Methods

    push

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be GUNZIPped

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    -

    Optional ondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    -

    Optional onmember

    onmember?: GunzipMemberHandler

    The handler to call whenever a new GZIP member is found

    +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Optionalondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    +

    Optionalonmember

    onmember?: GunzipMemberHandler

    The handler to call whenever a new GZIP member is found

    queuedSize

    queuedSize: number

    The number of compressed bytes buffered in the stream

    terminate

    terminate: AsyncTerminable

    A method to terminate the stream's internal worker. Subsequent calls to push() will silently fail.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondataondrainonmemberqueuedSizeterminate
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.AsyncInflate.html b/docs/classes/_runtime_data_compress.AsyncInflate.html index 08ad021d..e2096898 100644 --- a/docs/classes/_runtime_data_compress.AsyncInflate.html +++ b/docs/classes/_runtime_data_compress.AsyncInflate.html @@ -1,21 +1,22 @@ -AsyncInflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class AsyncInflate

    Asynchronous streaming DEFLATE decompression

    -

    Constructors

    constructor +AsyncInflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class AsyncInflate

    Asynchronous streaming DEFLATE decompression

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata ondrain? queuedSize terminate -

    Constructors

    constructor

    • new AsyncInflate(opts, cb?): AsyncInflate

    • Creates an asynchronous DEFLATE decompression stream

      +

    Constructors

    constructor

    Methods

    push

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be inflated

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    -

    Optional ondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Optionalondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    queuedSize

    queuedSize: number

    The number of compressed bytes buffered in the stream

    terminate

    terminate: AsyncTerminable

    A method to terminate the stream's internal worker. Subsequent calls to push() will silently fail.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondataondrainqueuedSizeterminate
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.AsyncUnzipInflate.html b/docs/classes/_runtime_data_compress.AsyncUnzipInflate.html index e093b70a..b7831fd5 100644 --- a/docs/classes/_runtime_data_compress.AsyncUnzipInflate.html +++ b/docs/classes/_runtime_data_compress.AsyncUnzipInflate.html @@ -1,14 +1,15 @@ -AsyncUnzipInflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class AsyncUnzipInflate

    Asynchronous streaming DEFLATE decompression for ZIP archives

    -

    Implements

    Constructors

    constructor +AsyncUnzipInflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class AsyncUnzipInflate

    Asynchronous streaming DEFLATE decompression for ZIP archives

    +

    Implements

    Constructors

    constructor

    Methods

    push

    Properties

    ondata terminate compression -

    Constructors

    constructor

    • new AsyncUnzipInflate(_, sz?): AsyncUnzipInflate

    • Creates a DEFLATE decompression that can be used in ZIP archives

      -

      Parameters

      • _: string
      • Optional sz: number

      Returns AsyncUnzipInflate

    Methods

    push

    • push(data, final): void

    • Pushes a chunk to be decompressed

      +

    Constructors

    constructor

    • new AsyncUnzipInflate(_, sz?): AsyncUnzipInflate

    • Creates a DEFLATE decompression that can be used in ZIP archives

      +

      Parameters

      • _: string
      • Optionalsz: number

      Returns AsyncUnzipInflate

    Methods

    push

    • push(data, final): void

    • Pushes a chunk to be decompressed

      Parameters

      • data: Uint8Array

        The data in this chunk. Do not consume (detach) this data.

      • final: boolean

        Whether this is the last chunk in the data stream

        -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    terminate

    terminate: AsyncTerminable

    A method to terminate any internal workers used by the stream. Subsequent calls to push() should silently fail.

    -

    Static compression

    compression: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondataterminatecompression
    \ No newline at end of file +

    Staticcompression

    compression: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.AsyncUnzlib.html b/docs/classes/_runtime_data_compress.AsyncUnzlib.html index 6d98c52a..c635a9cb 100644 --- a/docs/classes/_runtime_data_compress.AsyncUnzlib.html +++ b/docs/classes/_runtime_data_compress.AsyncUnzlib.html @@ -1,21 +1,22 @@ -AsyncUnzlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class AsyncUnzlib

    Asynchronous streaming Zlib decompression

    -

    Constructors

    constructor +AsyncUnzlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class AsyncUnzlib

    Asynchronous streaming Zlib decompression

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata ondrain? queuedSize terminate -

    Constructors

    constructor

    • new AsyncUnzlib(opts, cb?): AsyncUnzlib

    • Creates an asynchronous Zlib decompression stream

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decompressed from Zlib

      +

      Parameters

      Returns AsyncUnzlib

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decompressed from Zlib

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    -

    Optional ondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Optionalondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    queuedSize

    queuedSize: number

    The number of compressed bytes buffered in the stream

    terminate

    terminate: AsyncTerminable

    A method to terminate the stream's internal worker. Subsequent calls to push() will silently fail.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondataondrainqueuedSizeterminate
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.AsyncZipDeflate.html b/docs/classes/_runtime_data_compress.AsyncZipDeflate.html index 44880809..872e1973 100644 --- a/docs/classes/_runtime_data_compress.AsyncZipDeflate.html +++ b/docs/classes/_runtime_data_compress.AsyncZipDeflate.html @@ -1,5 +1,6 @@ -AsyncZipDeflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class AsyncZipDeflate

    Asynchronous streaming DEFLATE compression for ZIP archives

    -

    Implements

    Constructors

    constructor +AsyncZipDeflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class AsyncZipDeflate

    Asynchronous streaming DEFLATE compression for ZIP archives

    +

    Implements

    Constructors

    constructor

    Methods

    process push

    Properties

    attrs? @@ -14,13 +15,13 @@ os? size terminate -

    Constructors

    constructor

    • new AsyncZipDeflate(filename, opts?): AsyncZipDeflate

    • Creates an asynchronous DEFLATE stream that can be added to ZIP archives

      +

    Constructors

    constructor

    • new AsyncZipDeflate(filename, opts?): AsyncZipDeflate

    • Creates an asynchronous DEFLATE stream that can be added to ZIP archives

      Parameters

      • filename: string

        The filename to associate with this data stream

        -
      • Optional opts: DeflateOptions

        The compression options

        -

      Returns AsyncZipDeflate

    Methods

    process

    • process(chunk, final): void

    • Parameters

      Returns void

    push

    • push(chunk, final?): void

    • Pushes a chunk to be deflated

      +
    • Optionalopts: DeflateOptions

      The compression options

      +

    Returns AsyncZipDeflate

    Methods

    process

    • process(chunk, final): void

    • Parameters

      Returns void

    push

    • push(chunk, final?): void

    • Pushes a chunk to be deflated

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    Optional attrs

    attrs?: number

    The file's attributes. These are traditionally somewhat complicated +

  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    Optionalattrs

    attrs?: number

    The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, here is a representation of what this is, bit by bit:

    TTTTugtrwxrwxrwx0000000000ADVSHR

    @@ -32,7 +33,7 @@

    If you want to set the Unix permissions, for instance, just bit shift by 16, e.g. 0o644 << 16. Note that attributes usually only work in conjunction with the os setting: you must use os = 3 (Unix) if you want to set Unix permissions

    -

    Optional comment

    comment?: string

    The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, +

    Optionalcomment

    comment?: string

    The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.26. The comment must be at most 65,535 bytes long UTF-8 encoded. This field is not read by consumer software.

    compression

    compression: number

    The compression format for the data stream. This number is determined by @@ -44,7 +45,7 @@

    If you don't want to have to generate this yourself, consider extending the ZipPassThrough class and overriding its process() method, or using one of ZipDeflate or AsyncZipDeflate.

    -

    Optional extra

    extra?: Record<number, Uint8Array>

    Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, +

    Optionalextra

    extra?: Record<number, Uint8Array>

    Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.28. At most 65,535 bytes may be used in each ID. The ID must be an integer between 0 and 65,535, inclusive.

    This field is incredibly rare and almost never needed except for compliance with @@ -52,10 +53,10 @@

    filename

    filename: string

    The filename to associate with the data provided to this stream. If you want a file in a subdirectory, use forward slashes as a separator (e.g. directory/filename.ext). This will still work on Windows.

    -

    flag

    flag: 0 | 1 | 2 | 3

    Bits 1 and 2 of the general purpose bit flag, specified in PKZIP's +

    flag

    flag:
        | 0
        | 1
        | 2
        | 3

    Bits 1 and 2 of the general purpose bit flag, specified in PKZIP's APPNOTE.txt, section 4.4.4. Should be between 0 and 3. This is unlikely to be necessary.

    -

    Optional mtime

    mtime?: string | number | Date

    When the file was last modified. Defaults to the current time.

    +

    Optionalmtime

    mtime?: string | number | Date

    When the file was last modified. Defaults to the current time.

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to be called when data is added. After passing this stream to the ZIP file object, this handler will always be defined. To call it:

    stream.ondata(error, chunk, final)

    @@ -63,7 +64,7 @@

    chunk = a Uint8Array of the data that was added (null if there was an error)

    final = boolean, whether this is the final chunk in the stream

    -

    Optional os

    os?: number

    The operating system of origin for this file. The value is defined +

    Optionalos

    os?: number

    The operating system of origin for this file. The value is defined by PKZIP's APPNOTE.txt, section 4.4.2.2. For example, 0 (the default) is MS/DOS, 3 is Unix, 19 is macOS.

    size

    size: number

    The size of the file in bytes. This attribute may be invalid after @@ -76,4 +77,4 @@ purposes. This will not always be called after the stream completes, so you may wish to call this.terminate() after the final chunk is processed if you have clean-up logic.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorprocesspushattrscommentcompressioncrcextrafilenameflagmtimeondataossizeterminate
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.AsyncZlib.html b/docs/classes/_runtime_data_compress.AsyncZlib.html index b07d1621..d77f7d54 100644 --- a/docs/classes/_runtime_data_compress.AsyncZlib.html +++ b/docs/classes/_runtime_data_compress.AsyncZlib.html @@ -1,24 +1,25 @@ -AsyncZlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class AsyncZlib

    Asynchronous streaming Zlib compression

    -

    Constructors

    constructor +AsyncZlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class AsyncZlib

    Asynchronous streaming Zlib compression

    +

    Constructors

    constructor

    Methods

    flush push

    Properties

    ondata ondrain? queuedSize terminate -

    Constructors

    constructor

    • new AsyncZlib(opts, cb?): AsyncZlib

    • Creates an asynchronous Zlib stream

      +

    Constructors

    constructor

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the +

      Parameters

      Returns AsyncZlib

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the zlibbed output for small inputs.

      Returns void

    push

    • push(chunk, final?): void

    • Pushes a chunk to be deflated

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    -

    Optional ondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Optionalondrain

    ondrain?: AsyncFlateDrainHandler

    The handler to call whenever buffered source data is processed (i.e. queuedSize updates)

    queuedSize

    queuedSize: number

    The number of uncompressed bytes buffered in the stream

    terminate

    terminate: AsyncTerminable

    A method to terminate the stream's internal worker. Subsequent calls to push() will silently fail.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorflushpushondataondrainqueuedSizeterminate
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.Compress.html b/docs/classes/_runtime_data_compress.Compress.html index 57815735..a161f698 100644 --- a/docs/classes/_runtime_data_compress.Compress.html +++ b/docs/classes/_runtime_data_compress.Compress.html @@ -1,17 +1,18 @@ -Compress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Compress

    Streaming GZIP compression

    -

    Constructors

    constructor +Compress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Compress

    Streaming GZIP compression

    +

    Constructors

    constructor

    Methods

    flush push

    Properties

    ondata -

    Constructors

    constructor

    • new Compress(opts, cb?): Compress

    • Creates a GZIP stream

      +

    Constructors

    constructor

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the +

      Parameters

      Returns Compress

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the GZIPped output for small inputs.

      Returns void

    push

    • push(chunk, final?): void

    • Pushes a chunk to be GZIPped

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorflushpushondata
    \ No newline at end of file +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.DecodeUTF8.html b/docs/classes/_runtime_data_compress.DecodeUTF8.html index 4ab341aa..c269d642 100644 --- a/docs/classes/_runtime_data_compress.DecodeUTF8.html +++ b/docs/classes/_runtime_data_compress.DecodeUTF8.html @@ -1,11 +1,12 @@ -DecodeUTF8 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class DecodeUTF8

    Streaming UTF-8 decoding

    -

    Constructors

    constructor +DecodeUTF8 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class DecodeUTF8

    Streaming UTF-8 decoding

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata -

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decoded from UTF-8 binary

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decoded from UTF-8 binary

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: StringStreamHandler

    The handler to call whenever data is available

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondata
    \ No newline at end of file +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: StringStreamHandler

    The handler to call whenever data is available

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.Decompress.html b/docs/classes/_runtime_data_compress.Decompress.html index 01c51572..cf9d1caf 100644 --- a/docs/classes/_runtime_data_compress.Decompress.html +++ b/docs/classes/_runtime_data_compress.Decompress.html @@ -1,14 +1,15 @@ -Decompress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Decompress

    Streaming GZIP, Zlib, or raw DEFLATE decompression

    -

    Constructors

    constructor +Decompress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Decompress

    Streaming GZIP, Zlib, or raw DEFLATE decompression

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata -

    Constructors

    constructor

    • new Decompress(opts, cb?): Decompress

    • Creates a decompression stream

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decompressed

      +

      Parameters

      Returns Decompress

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decompressed

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondata
    \ No newline at end of file +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.Deflate.html b/docs/classes/_runtime_data_compress.Deflate.html index e5a85c4b..67fd87dc 100644 --- a/docs/classes/_runtime_data_compress.Deflate.html +++ b/docs/classes/_runtime_data_compress.Deflate.html @@ -1,17 +1,18 @@ -Deflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Deflate

    Streaming DEFLATE compression

    -

    Constructors

    constructor +Deflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Deflate

    Streaming DEFLATE compression

    +

    Constructors

    constructor

    Methods

    flush push

    Properties

    ondata -

    Constructors

    constructor

    • new Deflate(opts, cb?): Deflate

    • Creates a DEFLATE stream

      +

    Constructors

    constructor

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the +

      Parameters

      Returns Deflate

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the deflated output for small inputs.

      Returns void

    push

    • push(chunk, final?): void

    • Pushes a chunk to be deflated

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorflushpushondata
    \ No newline at end of file +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.EncodeUTF8.html b/docs/classes/_runtime_data_compress.EncodeUTF8.html index 8d2db331..acc009b2 100644 --- a/docs/classes/_runtime_data_compress.EncodeUTF8.html +++ b/docs/classes/_runtime_data_compress.EncodeUTF8.html @@ -1,11 +1,12 @@ -EncodeUTF8 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class EncodeUTF8

    Streaming UTF-8 encoding

    -

    Constructors

    constructor +EncodeUTF8 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class EncodeUTF8

    Streaming UTF-8 encoding

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata -

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be encoded to UTF-8

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be encoded to UTF-8

      Parameters

      • chunk: string

        The string data to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondata
    \ No newline at end of file +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.Gunzip.html b/docs/classes/_runtime_data_compress.Gunzip.html index c3c36f2a..fe48511c 100644 --- a/docs/classes/_runtime_data_compress.Gunzip.html +++ b/docs/classes/_runtime_data_compress.Gunzip.html @@ -1,16 +1,17 @@ -Gunzip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Gunzip

    Streaming single or multi-member GZIP decompression

    -

    Constructors

    constructor +Gunzip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Gunzip

    Streaming single or multi-member GZIP decompression

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata onmember? -

    Constructors

    constructor

    • new Gunzip(opts, cb?): Gunzip

    • Creates a GUNZIP stream

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be GUNZIPped

      +

      Parameters

      Returns Gunzip

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be GUNZIPped

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    -

    Optional onmember

    onmember?: GunzipMemberHandler

    The handler to call whenever a new GZIP member is found

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondataonmember
    \ No newline at end of file +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    +

    Optionalonmember

    onmember?: GunzipMemberHandler

    The handler to call whenever a new GZIP member is found

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.Inflate.html b/docs/classes/_runtime_data_compress.Inflate.html index 54bc4f21..a8fc2481 100644 --- a/docs/classes/_runtime_data_compress.Inflate.html +++ b/docs/classes/_runtime_data_compress.Inflate.html @@ -1,14 +1,15 @@ -Inflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Inflate

    Streaming DEFLATE decompression

    -

    Constructors

    constructor +Inflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Inflate

    Streaming DEFLATE decompression

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata -

    Constructors

    constructor

    • new Inflate(opts, cb?): Inflate

    • Creates a DEFLATE decompression stream

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be inflated

      +

      Parameters

      Returns Inflate

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be inflated

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the final chunk

        -

      Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondata
    \ No newline at end of file +
  • Optionalfinal: boolean

    Whether this is the final chunk

    +

    • Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.Unzip.html b/docs/classes/_runtime_data_compress.Unzip.html index 2bd1ab37..fbce1086 100644 --- a/docs/classes/_runtime_data_compress.Unzip.html +++ b/docs/classes/_runtime_data_compress.Unzip.html @@ -1,15 +1,16 @@ -Unzip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Unzip

    A ZIP archive decompression stream that emits files as they are discovered

    -

    Constructors

    constructor +Unzip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Unzip

    A ZIP archive decompression stream that emits files as they are discovered

    +

    Constructors

    constructor

    Methods

    push register

    Properties

    onfile -

    Constructors

    constructor

    • new Unzip(cb?): Unzip

    • Creates a ZIP decompression stream

      -

      Parameters

      • Optional cb: UnzipFileHandler

        The callback to call whenever a file in the ZIP archive is found

        -

      Returns Unzip

    Methods

    push

    • push(chunk, final?): any

    • Pushes a chunk to be unzipped

      +

    Constructors

    constructor

    • new Unzip(cb?): Unzip

    • Creates a ZIP decompression stream

      +

      Parameters

      • Optionalcb: UnzipFileHandler

        The callback to call whenever a file in the ZIP archive is found

        +

      Returns Unzip

    Methods

    push

    • push(chunk, final?): any

    • Pushes a chunk to be unzipped

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        +
      • Optionalfinal: boolean

        Whether this is the last chunk

      Returns any

    register

    • register(decoder): void

    • Registers a decoder with the stream, allowing for files compressed with the compression type provided to be expanded correctly

      Parameters

      Returns void

    Properties

    onfile

    onfile: UnzipFileHandler

    The handler to call whenever a file is discovered

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushregisteronfile
    \ No newline at end of file +

    Returns void

    Properties

    onfile

    onfile: UnzipFileHandler

    The handler to call whenever a file is discovered

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.UnzipInflate.html b/docs/classes/_runtime_data_compress.UnzipInflate.html index 138a035b..246e8fb4 100644 --- a/docs/classes/_runtime_data_compress.UnzipInflate.html +++ b/docs/classes/_runtime_data_compress.UnzipInflate.html @@ -1,12 +1,13 @@ -UnzipInflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class UnzipInflate

    Streaming DEFLATE decompression for ZIP archives. Prefer AsyncZipInflate for +UnzipInflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class UnzipInflate

    Streaming DEFLATE decompression for ZIP archives. Prefer AsyncZipInflate for better performance.

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    push

    Properties

    ondata compression -

    Constructors

    constructor

    Methods

    push

    • push(data, final): void

    • Pushes a chunk to be decompressed

      +

    Constructors

    constructor

    Methods

    push

    • push(data, final): void

    • Pushes a chunk to be decompressed

      Parameters

      • data: Uint8Array

        The data in this chunk. Do not consume (detach) this data.

      • final: boolean

        Whether this is the last chunk in the data stream

        -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    -

    Static compression

    compression: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondatacompression
    \ No newline at end of file +

    Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Staticcompression

    compression: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.UnzipPassThrough.html b/docs/classes/_runtime_data_compress.UnzipPassThrough.html index 125d4cd2..e3ed3dbc 100644 --- a/docs/classes/_runtime_data_compress.UnzipPassThrough.html +++ b/docs/classes/_runtime_data_compress.UnzipPassThrough.html @@ -1,10 +1,11 @@ -UnzipPassThrough | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class UnzipPassThrough

    Streaming pass-through decompression for ZIP archives

    -

    Implements

    Constructors

    constructor +UnzipPassThrough | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class UnzipPassThrough

    Streaming pass-through decompression for ZIP archives

    +

    Implements

    Constructors

    constructor

    Methods

    push

    Properties

    ondata compression -

    Constructors

    constructor

    Methods

    push

    • push(data, final): void

    • Pushes a chunk to be decompressed

      +

    Constructors

    constructor

    Methods

    push

    • push(data, final): void

    • Pushes a chunk to be decompressed

      Parameters

      • data: Uint8Array

        The data in this chunk. Do not consume (detach) this data.

      • final: boolean

        Whether this is the last chunk in the data stream

        -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    -

    Static compression

    compression: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondatacompression
    \ No newline at end of file +

    Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Staticcompression

    compression: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.Unzlib.html b/docs/classes/_runtime_data_compress.Unzlib.html index 4744e9b9..5cb63ae2 100644 --- a/docs/classes/_runtime_data_compress.Unzlib.html +++ b/docs/classes/_runtime_data_compress.Unzlib.html @@ -1,14 +1,15 @@ -Unzlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Unzlib

    Streaming Zlib decompression

    -

    Constructors

    constructor +Unzlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Unzlib

    Streaming Zlib decompression

    +

    Constructors

    constructor

    Methods

    push

    Properties

    ondata -

    Constructors

    constructor

    • new Unzlib(opts, cb?): Unzlib

    • Creates a Zlib decompression stream

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be unzlibbed

      +

      Parameters

      Returns Unzlib

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be unzlibbed

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorpushondata
    \ No newline at end of file +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.Zip.html b/docs/classes/_runtime_data_compress.Zip.html index 84112b0a..08580552 100644 --- a/docs/classes/_runtime_data_compress.Zip.html +++ b/docs/classes/_runtime_data_compress.Zip.html @@ -1,18 +1,19 @@ -Zip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Zip

    A zippable archive to which files can incrementally be added

    -

    Constructors

    constructor +Zip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Zip

    A zippable archive to which files can incrementally be added

    +

    Constructors

    constructor

    Methods

    add end terminate

    Properties

    ondata -

    Constructors

    constructor

    • new Zip(cb?): Zip

    • Creates an empty ZIP archive to which files can be added

      -

      Parameters

      • Optional cb: AsyncFlateStreamHandler

        The callback to call whenever data for the generated ZIP archive - is available

        -

      Returns Zip

    Methods

    add

    • add(file): void

    • Adds a file to the ZIP archive

      +

    Constructors

    constructor

    • new Zip(cb?): Zip

    • Creates an empty ZIP archive to which files can be added

      +

      Parameters

      • Optionalcb: AsyncFlateStreamHandler

        The callback to call whenever data for the generated ZIP archive +is available

        +

      Returns Zip

    Methods

    add

    • add(file): void

    • Adds a file to the ZIP archive

      Parameters

      Returns void

    end

    • end(): void

    • Ends the process of adding files and prepares to emit the final chunks. This must be called after adding all desired files for the resulting ZIP file to work properly.

      Returns void

    terminate

    • terminate(): void

    • A method to terminate any internal workers used by the stream. Subsequent calls to add() will fail.

      -

      Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraddendterminateondata
    \ No newline at end of file +

    Returns void

    Properties

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to call whenever data is available

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.ZipDeflate.html b/docs/classes/_runtime_data_compress.ZipDeflate.html index 5ef86457..26b9c1dc 100644 --- a/docs/classes/_runtime_data_compress.ZipDeflate.html +++ b/docs/classes/_runtime_data_compress.ZipDeflate.html @@ -1,6 +1,7 @@ -ZipDeflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class ZipDeflate

    Streaming DEFLATE compression for ZIP archives. Prefer using AsyncZipDeflate +ZipDeflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class ZipDeflate

    Streaming DEFLATE compression for ZIP archives. Prefer using AsyncZipDeflate for better performance

    -

    Implements

    Constructors

    constructor +

    Implements

    Constructors

    constructor

    Methods

    process push

    Properties

    attrs? @@ -14,13 +15,13 @@ ondata os? size -

    Constructors

    constructor

    • new ZipDeflate(filename, opts?): ZipDeflate

    • Creates a DEFLATE stream that can be added to ZIP archives

      +

    Constructors

    constructor

    • new ZipDeflate(filename, opts?): ZipDeflate

    • Creates a DEFLATE stream that can be added to ZIP archives

      Parameters

      • filename: string

        The filename to associate with this data stream

        -
      • Optional opts: DeflateOptions

        The compression options

        -

      Returns ZipDeflate

    Methods

    process

    • process(chunk, final): void

    • Parameters

      Returns void

    push

    • push(chunk, final?): void

    • Pushes a chunk to be deflated

      +
    • Optionalopts: DeflateOptions

      The compression options

      +

    Returns ZipDeflate

    Methods

    process

    • process(chunk, final): void

    • Parameters

      Returns void

    push

    • push(chunk, final?): void

    • Pushes a chunk to be deflated

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    Optional attrs

    attrs?: number

    The file's attributes. These are traditionally somewhat complicated +

  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    Optionalattrs

    attrs?: number

    The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, here is a representation of what this is, bit by bit:

    TTTTugtrwxrwxrwx0000000000ADVSHR

    @@ -32,7 +33,7 @@

    If you want to set the Unix permissions, for instance, just bit shift by 16, e.g. 0o644 << 16. Note that attributes usually only work in conjunction with the os setting: you must use os = 3 (Unix) if you want to set Unix permissions

    -

    Optional comment

    comment?: string

    The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, +

    Optionalcomment

    comment?: string

    The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.26. The comment must be at most 65,535 bytes long UTF-8 encoded. This field is not read by consumer software.

    compression

    compression: number

    The compression format for the data stream. This number is determined by @@ -44,7 +45,7 @@

    If you don't want to have to generate this yourself, consider extending the ZipPassThrough class and overriding its process() method, or using one of ZipDeflate or AsyncZipDeflate.

    -

    Optional extra

    extra?: Record<number, Uint8Array>

    Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, +

    Optionalextra

    extra?: Record<number, Uint8Array>

    Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.28. At most 65,535 bytes may be used in each ID. The ID must be an integer between 0 and 65,535, inclusive.

    This field is incredibly rare and almost never needed except for compliance with @@ -52,10 +53,10 @@

    filename

    filename: string

    The filename to associate with the data provided to this stream. If you want a file in a subdirectory, use forward slashes as a separator (e.g. directory/filename.ext). This will still work on Windows.

    -

    flag

    flag: 0 | 1 | 2 | 3

    Bits 1 and 2 of the general purpose bit flag, specified in PKZIP's +

    flag

    flag:
        | 0
        | 1
        | 2
        | 3

    Bits 1 and 2 of the general purpose bit flag, specified in PKZIP's APPNOTE.txt, section 4.4.4. Should be between 0 and 3. This is unlikely to be necessary.

    -

    Optional mtime

    mtime?: string | number | Date

    When the file was last modified. Defaults to the current time.

    +

    Optionalmtime

    mtime?: string | number | Date

    When the file was last modified. Defaults to the current time.

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to be called when data is added. After passing this stream to the ZIP file object, this handler will always be defined. To call it:

    stream.ondata(error, chunk, final)

    @@ -63,7 +64,7 @@

    chunk = a Uint8Array of the data that was added (null if there was an error)

    final = boolean, whether this is the final chunk in the stream

    -

    Optional os

    os?: number

    The operating system of origin for this file. The value is defined +

    Optionalos

    os?: number

    The operating system of origin for this file. The value is defined by PKZIP's APPNOTE.txt, section 4.4.2.2. For example, 0 (the default) is MS/DOS, 3 is Unix, 19 is macOS.

    size

    size: number

    The size of the file in bytes. This attribute may be invalid after @@ -72,4 +73,4 @@

    If you don't want to have to compute this yourself, consider extending the ZipPassThrough class and overriding its process() method, or using one of ZipDeflate or AsyncZipDeflate.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorprocesspushattrscommentcompressioncrcextrafilenameflagmtimeondataossize
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.ZipPassThrough.html b/docs/classes/_runtime_data_compress.ZipPassThrough.html index d2b6e990..69cacea6 100644 --- a/docs/classes/_runtime_data_compress.ZipPassThrough.html +++ b/docs/classes/_runtime_data_compress.ZipPassThrough.html @@ -1,5 +1,6 @@ -ZipPassThrough | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class ZipPassThrough

    A pass-through stream to keep data uncompressed in a ZIP archive.

    -

    Implements

    Constructors

    constructor +ZipPassThrough | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class ZipPassThrough

    A pass-through stream to keep data uncompressed in a ZIP archive.

    +

    Implements

    Constructors

    constructor

    Methods

    process push

    Properties

    attrs? @@ -12,9 +13,9 @@ ondata os? size -

    Constructors

    constructor

    • new ZipPassThrough(filename): ZipPassThrough

    • Creates a pass-through stream that can be added to ZIP archives

      +

    Constructors

    constructor

    • new ZipPassThrough(filename): ZipPassThrough

    • Creates a pass-through stream that can be added to ZIP archives

      Parameters

      • filename: string

        The filename to associate with this data stream

        -

      Returns ZipPassThrough

    Methods

    Protected process

    • process(chunk, final): void

    • Processes a chunk and pushes to the output stream. You can override this +

    Returns ZipPassThrough

    Methods

    Protectedprocess

    • process(chunk, final): void

    • Processes a chunk and pushes to the output stream. You can override this method in a subclass for custom behavior, but by default this passes the data through. You must call this.ondata(err, chunk, final) at some point in this method.

      @@ -24,8 +25,8 @@ compression algorithm, note that you must push data from the source file only, pre-compression.

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    Optional attrs

    attrs?: number

    The file's attributes. These are traditionally somewhat complicated +

  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    Optionalattrs

    attrs?: number

    The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, here is a representation of what this is, bit by bit:

    TTTTugtrwxrwxrwx0000000000ADVSHR

    @@ -37,7 +38,7 @@

    If you want to set the Unix permissions, for instance, just bit shift by 16, e.g. 0o644 << 16. Note that attributes usually only work in conjunction with the os setting: you must use os = 3 (Unix) if you want to set Unix permissions

    -

    Optional comment

    comment?: string

    The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, +

    Optionalcomment

    comment?: string

    The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.26. The comment must be at most 65,535 bytes long UTF-8 encoded. This field is not read by consumer software.

    compression

    compression: number

    The compression format for the data stream. This number is determined by @@ -49,7 +50,7 @@

    If you don't want to have to generate this yourself, consider extending the ZipPassThrough class and overriding its process() method, or using one of ZipDeflate or AsyncZipDeflate.

    -

    Optional extra

    extra?: Record<number, Uint8Array>

    Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, +

    Optionalextra

    extra?: Record<number, Uint8Array>

    Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.28. At most 65,535 bytes may be used in each ID. The ID must be an integer between 0 and 65,535, inclusive.

    This field is incredibly rare and almost never needed except for compliance with @@ -57,7 +58,7 @@

    filename

    filename: string

    The filename to associate with the data provided to this stream. If you want a file in a subdirectory, use forward slashes as a separator (e.g. directory/filename.ext). This will still work on Windows.

    -

    Optional mtime

    mtime?: string | number | Date

    When the file was last modified. Defaults to the current time.

    +

    Optionalmtime

    mtime?: string | number | Date

    When the file was last modified. Defaults to the current time.

    ondata

    ondata: AsyncFlateStreamHandler

    The handler to be called when data is added. After passing this stream to the ZIP file object, this handler will always be defined. To call it:

    stream.ondata(error, chunk, final)

    @@ -65,7 +66,7 @@

    chunk = a Uint8Array of the data that was added (null if there was an error)

    final = boolean, whether this is the final chunk in the stream

    -

    Optional os

    os?: number

    The operating system of origin for this file. The value is defined +

    Optionalos

    os?: number

    The operating system of origin for this file. The value is defined by PKZIP's APPNOTE.txt, section 4.4.2.2. For example, 0 (the default) is MS/DOS, 3 is Unix, 19 is macOS.

    size

    size: number

    The size of the file in bytes. This attribute may be invalid after @@ -74,4 +75,4 @@

    If you don't want to have to compute this yourself, consider extending the ZipPassThrough class and overriding its process() method, or using one of ZipDeflate or AsyncZipDeflate.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorprocesspushattrscommentcompressioncrcextrafilenamemtimeondataossize
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_compress.Zlib.html b/docs/classes/_runtime_data_compress.Zlib.html index 413c3313..fa872aed 100644 --- a/docs/classes/_runtime_data_compress.Zlib.html +++ b/docs/classes/_runtime_data_compress.Zlib.html @@ -1,17 +1,18 @@ -Zlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Zlib

    Streaming Zlib compression

    -

    Constructors

    constructor +Zlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Zlib

    Streaming Zlib compression

    +

    Constructors

    constructor

    Methods

    flush push

    Properties

    ondata -

    Constructors

    constructor

    • new Zlib(opts, cb?): Zlib

    • Creates a Zlib stream

      +

    Constructors

    constructor

    • new Zlib(opts, cb?): Zlib

    • Creates a Zlib stream

      Parameters

      Returns Zlib

    • new Zlib(cb?): Zlib

    • Creates a Zlib stream

      -

      Parameters

      Returns Zlib

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the +

      Parameters

      Returns Zlib

    Methods

    flush

    • flush(): void

    • Flushes buffered uncompressed data. Useful to immediately retrieve the zlibbed output for small inputs.

      Returns void

    push

    • push(chunk, final?): void

    • Pushes a chunk to be zlibbed

      Parameters

      • chunk: Uint8Array

        The chunk to push

        -
      • Optional final: boolean

        Whether this is the last chunk

        -

      Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorflushpushondata
    \ No newline at end of file +
  • Optionalfinal: boolean

    Whether this is the last chunk

    +

    • Returns void

    Properties

    ondata

    ondata: FlateStreamHandler

    The handler to call whenever data is available

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_format_msgpack.Decoder.html b/docs/classes/_runtime_data_format_msgpack.Decoder.html index 97fe2925..7d58a19b 100644 --- a/docs/classes/_runtime_data_format_msgpack.Decoder.html +++ b/docs/classes/_runtime_data_format_msgpack.Decoder.html @@ -1,5 +1,16 @@ -Decoder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Decoder

    Hierarchy (view full)

    Constructors

    constructor +Decoder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Decoder

    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Constructors

    constructor

    Methods

    decode unpack unpackMultiple -

    Constructors

    constructor

    Methods

    decode

    unpack

    unpackMultiple

    • unpackMultiple(messagePack): any[]

    • Parameters

      Returns any[]

    • unpackMultiple(messagePack, forEach): void

    • Parameters

      • messagePack: Uint8Array | Buffer
      • forEach: ((value, start?, end?) => any)
          • (value, start?, end?): any

          • Parameters

            • value: any
            • Optional start: number
            • Optional end: number

            Returns any

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructordecodeunpackunpackMultiple
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    decode

    unpack

    unpackMultiple

    • unpackMultiple(messagePack): any[]

    • Parameters

      Returns any[]

    • unpackMultiple(messagePack, forEach): void

    • Parameters

      • messagePack: Uint8Array | Buffer
      • forEach: ((value: any, start?: number, end?: number) => any)
          • (value, start?, end?): any

          • Parameters

            • value: any
            • Optionalstart: number
            • Optionalend: number

            Returns any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_format_msgpack.Encoder.html b/docs/classes/_runtime_data_format_msgpack.Encoder.html index 9cb71fef..e8708a49 100644 --- a/docs/classes/_runtime_data_format_msgpack.Encoder.html +++ b/docs/classes/_runtime_data_format_msgpack.Encoder.html @@ -1,7 +1,18 @@ -Encoder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Encoder

    Hierarchy (view full)

    Constructors

    constructor +Encoder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Encoder

    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Constructors

    constructor

    Methods

    decode encode pack unpack unpackMultiple -

    Constructors

    constructor

    Methods

    decode

    encode

    • encode(value): Buffer

    • Parameters

      • value: any

      Returns Buffer

    pack

    • pack(value): Buffer

    • Parameters

      • value: any

      Returns Buffer

    unpack

    unpackMultiple

    • unpackMultiple(messagePack): any[]

    • Parameters

      Returns any[]

    • unpackMultiple(messagePack, forEach): void

    • Parameters

      • messagePack: Uint8Array | Buffer
      • forEach: ((value, start?, end?) => any)
          • (value, start?, end?): any

          • Parameters

            • value: any
            • Optional start: number
            • Optional end: number

            Returns any

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructordecodeencodepackunpackunpackMultiple
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    decode

    encode

    • encode(value): Buffer

    • Parameters

      • value: any

      Returns Buffer

    pack

    • pack(value): Buffer

    • Parameters

      • value: any

      Returns Buffer

    unpack

    unpackMultiple

    • unpackMultiple(messagePack): any[]

    • Parameters

      Returns any[]

    • unpackMultiple(messagePack, forEach): void

    • Parameters

      • messagePack: Uint8Array | Buffer
      • forEach: ((value: any, start?: number, end?: number) => any)
          • (value, start?, end?): any

          • Parameters

            • value: any
            • Optionalstart: number
            • Optionalend: number

            Returns any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_format_msgpack.Packr.html b/docs/classes/_runtime_data_format_msgpack.Packr.html index c89cd6a0..6d7e112a 100644 --- a/docs/classes/_runtime_data_format_msgpack.Packr.html +++ b/docs/classes/_runtime_data_format_msgpack.Packr.html @@ -1,7 +1,18 @@ -Packr | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Packr

    Hierarchy (view full)

    Constructors

    constructor +Packr | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Packr

    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Constructors

    constructor

    Methods

    decode encode pack unpack unpackMultiple -

    Constructors

    constructor

    Methods

    decode

    encode

    • encode(value): Buffer

    • Parameters

      • value: any

      Returns Buffer

    pack

    • pack(value): Buffer

    • Parameters

      • value: any

      Returns Buffer

    unpack

    unpackMultiple

    • unpackMultiple(messagePack): any[]

    • Parameters

      Returns any[]

    • unpackMultiple(messagePack, forEach): void

    • Parameters

      • messagePack: Uint8Array | Buffer
      • forEach: ((value, start?, end?) => any)
          • (value, start?, end?): any

          • Parameters

            • value: any
            • Optional start: number
            • Optional end: number

            Returns any

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructordecodeencodepackunpackunpackMultiple
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    decode

    encode

    • encode(value): Buffer

    • Parameters

      • value: any

      Returns Buffer

    pack

    • pack(value): Buffer

    • Parameters

      • value: any

      Returns Buffer

    unpack

    unpackMultiple

    • unpackMultiple(messagePack): any[]

    • Parameters

      Returns any[]

    • unpackMultiple(messagePack, forEach): void

    • Parameters

      • messagePack: Uint8Array | Buffer
      • forEach: ((value: any, start?: number, end?: number) => any)
          • (value, start?, end?): any

          • Parameters

            • value: any
            • Optionalstart: number
            • Optionalend: number

            Returns any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_format_msgpack.PackrStream.html b/docs/classes/_runtime_data_format_msgpack.PackrStream.html index d6632704..b228a7c9 100644 --- a/docs/classes/_runtime_data_format_msgpack.PackrStream.html +++ b/docs/classes/_runtime_data_format_msgpack.PackrStream.html @@ -1,8 +1,16 @@ -PackrStream | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class PackrStream

    Hierarchy

    • Transform
      • PackrStream

    Constructors

    constructor -

    Methods

    [asyncDispose] -[asyncIterator] -[captureRejectionSymbol]? -_construct? +PackrStream | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class PackrStream

    +
    + +
    + + Hierarchy
    +     +
    +
    • Transform
      • PackrStream ()
    +
    +

    Constructors

    constructor +

    Methods

    _construct? _destroy _final _flush @@ -10,6 +18,9 @@ _transform _write _writev? +[asyncDispose] +[asyncIterator] +[captureRejectionSymbol]? addListener asIndexedPairs compose @@ -87,13 +98,13 @@ writableLength writableNeedDrain writableObjectMode -captureRejectionSymbol captureRejections +captureRejectionSymbol defaultMaxListeners errorMonitor -

    Constructors

    constructor

    • new PackrStream(options?): PackrStream

    • Parameters

      • Optional options: Options | {
            allowHalfOpen: boolean;
            emitClose: boolean;
            highWaterMark: number;
        }

      Returns PackrStream

    Methods

    [asyncDispose]

    • [asyncDispose](): Promise<void>

    • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

      -

      Returns Promise<void>

      Since

      v20.4.0

      -

    [asyncIterator]

    Optional [captureRejectionSymbol]

    • [captureRejectionSymbol](error, event, ...args): void

    • Parameters

      • error: Error
      • event: string
      • Rest ...args: any[]

      Returns void

    Optional _construct

    • _construct(callback): void

    • Parameters

      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _destroy

    • _destroy(error, callback): void

    • Parameters

      • error: Error
      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _final

    • _final(callback): void

    • Parameters

      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _flush

    • _flush(callback): void

    • Parameters

      • callback: TransformCallback

      Returns void

    _read

    • _read(size): void

    • Parameters

      • size: number

      Returns void

    _transform

    • _transform(chunk, encoding, callback): void

    • Parameters

      • chunk: any
      • encoding: BufferEncoding
      • callback: TransformCallback

      Returns void

    _write

    • _write(chunk, encoding, callback): void

    • Parameters

      • chunk: any
      • encoding: BufferEncoding
      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    Optional _writev

    • _writev(chunks, callback): void

    • Parameters

      • chunks: {
            chunk: any;
            encoding: BufferEncoding;
        }[]
      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    addListener

    • addListener(event, listener): this

    • Event emitter +

    Constructors

    constructor

    • new PackrStream(options?): PackrStream

    • Parameters

      • Optionaloptions: Options | {
            allowHalfOpen: boolean;
            emitClose: boolean;
            highWaterMark: number;
        }

      Returns PackrStream

    Methods

    Optional_construct

    • _construct(callback): void

    • Parameters

      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _destroy

    • _destroy(error, callback): void

    • Parameters

      • error: Error
      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _final

    • _final(callback): void

    • Parameters

      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _flush

    • _flush(callback): void

    • Parameters

      • callback: TransformCallback

      Returns void

    _read

    • _read(size): void

    • Parameters

      • size: number

      Returns void

    _transform

    • _transform(chunk, encoding, callback): void

    • Parameters

      • chunk: any
      • encoding: BufferEncoding
      • callback: TransformCallback

      Returns void

    _write

    • _write(chunk, encoding, callback): void

    • Parameters

      • chunk: any
      • encoding: BufferEncoding
      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    Optional_writev

    • _writev(chunks, callback): void

    • Parameters

      • chunks: {
            chunk: any;
            encoding: BufferEncoding;
        }[]
      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    [asyncDispose]

    • [asyncDispose](): Promise<void>

    • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

      +

      Returns Promise<void>

      Since

      v20.4.0

      +

    [asyncIterator]

    Optional[captureRejectionSymbol]

    • [captureRejectionSymbol](error, event, ...args): void

    • Parameters

      • error: Error
      • event: string
      • Rest...args: any[]

      Returns void

    addListener

    • addListener(event, listener): this

    • Event emitter The defined events on documents including:

      1. close
        2. @@ -108,54 +119,218 @@
      2. resume
      3. unpipe
      -

      Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    asIndexedPairs

    • asIndexedPairs(options?): Readable

    • This method returns a new stream with chunks of the underlying stream paired with a counter +

      Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    asIndexedPairs

    • asIndexedPairs(options?): Readable

    • This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

      -

      Parameters

      • Optional options: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream of indexed pairs.

      -

      Since

      v17.5.0

      -

    compose

    • compose<T>(stream, options?): T

    • Type Parameters

      • T extends ReadableStream

      Parameters

      Returns T

    cork

    • cork(): void

    • Returns void

    destroy

    • destroy(error?): this

    • Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable +

      Parameters

      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream of indexed pairs.

      +

      Since

      v17.5.0

      +

    compose

    • compose<T>(stream, options?): T

    • Type Parameters

      • T extends ReadableStream

      Parameters

      Returns T

    cork

    • cork(): void

    • The writable.cork() method forces all written data to be buffered in memory. +The buffered data will be flushed when either the uncork or end methods are called.

      +

      The primary intent of writable.cork() is to accommodate a situation in which +several small chunks are written to the stream in rapid succession. Instead of +immediately forwarding them to the underlying destination, writable.cork()buffers all the chunks until writable.uncork() is called, which will pass them +all to writable._writev(), if present. This prevents a head-of-line blocking +situation where data is being buffered while waiting for the first small chunk +to be processed. However, use of writable.cork() without implementingwritable._writev() may have an adverse effect on throughput.

      +

      See also: writable.uncork(), writable._writev().

      +

      Returns void

      Since

      v0.11.2

      +

    destroy

    • destroy(error?): this

    • Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push()will be ignored.

      Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

      Implementors should not override this method, but instead implement readable._destroy().

      -

      Parameters

      • Optional error: Error

        Error which will be passed as payload in 'error' event

        -

      Returns this

      Since

      v8.0.0

      +

      Parameters

      • Optionalerror: Error

        Error which will be passed as payload in 'error' event

        +

      Returns this

      Since

      v8.0.0

    drop

    • drop(limit, options?): Readable

    • This method returns a new stream with the first limit chunks dropped from the start.

      Parameters

      • limit: number

        the number of chunks to drop from the readable.

        -
      • Optional options: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream with limit chunks dropped from the start.

      -

      Since

      v17.5.0

      -

    emit

    • emit(event): boolean

    • Parameters

      • event: "close"

      Returns boolean

    • emit(event, chunk): boolean

    • Parameters

      • event: "data"
      • chunk: any

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "drain"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "end"

      Returns boolean

    • emit(event, err): boolean

    • Parameters

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "finish"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "pause"

      Returns boolean

    • emit(event, src): boolean

    • Parameters

      • event: "pipe"
      • src: Readable

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "readable"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "resume"

      Returns boolean

    • emit(event, src): boolean

    • Parameters

      • event: "unpipe"
      • src: Readable

      Returns boolean

    • emit(event, ...args): boolean

    • Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

    end

    • end(cb?): this

    • Parameters

      • Optional cb: (() => void)
          • (): void

          • Returns void

      Returns this

    • end(chunk, cb?): this

    • Parameters

      • chunk: any
      • Optional cb: (() => void)
          • (): void

          • Returns void

      Returns this

    • end(chunk, encoding?, cb?): this

    • Parameters

      • chunk: any
      • Optional encoding: BufferEncoding
      • Optional cb: (() => void)
          • (): void

          • Returns void

      Returns this

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered +

    • Optionaloptions: Pick<ArrayOptions, "signal">

    Returns Readable

    a stream with limit chunks dropped from the start.

    +

    Since

    v17.5.0

    +

    emit

    • emit(event): boolean

    • Parameters

      • event: "close"

      Returns boolean

    • emit(event, chunk): boolean

    • Parameters

      • event: "data"
      • chunk: any

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "drain"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "end"

      Returns boolean

    • emit(event, err): boolean

    • Parameters

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "finish"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "pause"

      Returns boolean

    • emit(event, src): boolean

    • Parameters

      • event: "pipe"
      • src: Readable

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "readable"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "resume"

      Returns boolean

    • emit(event, src): boolean

    • Parameters

      • event: "unpipe"
      • src: Readable

      Returns boolean

    • emit(event, ...args): boolean

    • Parameters

      • event: string | symbol
      • Rest...args: any[]

      Returns boolean

    end

    • end(cb?): this

    • Calling the writable.end() method signals that no more data will be written +to the Writable. The optional chunk and encoding arguments allow one +final additional chunk of data to be written immediately before closing the +stream.

      +

      Calling the write method after calling end will raise an error.

      +
      // Write 'hello, ' and then end with 'world!'.
      const fs = require('node:fs');
      const file = fs.createWriteStream('example.txt');
      file.write('hello, ');
      file.end('world!');
      // Writing more now is not allowed!
+
      + +

      Parameters

      • Optionalcb: (() => void)
          • (): void

          • Returns void

      Returns this

      Since

      v0.9.4

      +
    • end(chunk, cb?): this

    • Calling the writable.end() method signals that no more data will be written +to the Writable. The optional chunk and encoding arguments allow one +final additional chunk of data to be written immediately before closing the +stream.

      +

      Calling the write method after calling end will raise an error.

      +
      // Write 'hello, ' and then end with 'world!'.
      const fs = require('node:fs');
      const file = fs.createWriteStream('example.txt');
      file.write('hello, ');
      file.end('world!');
      // Writing more now is not allowed!
+
      + +

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any +JavaScript value other than null.

        +
      • Optionalcb: (() => void)
          • (): void

          • Returns void

      Returns this

      Since

      v0.9.4

      +
    • end(chunk, encoding?, cb?): this

    • Calling the writable.end() method signals that no more data will be written +to the Writable. The optional chunk and encoding arguments allow one +final additional chunk of data to be written immediately before closing the +stream.

      +

      Calling the write method after calling end will raise an error.

      +
      // Write 'hello, ' and then end with 'world!'.
      const fs = require('node:fs');
      const file = fs.createWriteStream('example.txt');
      file.write('hello, ');
      file.end('world!');
      // Writing more now is not allowed!
+
      + +

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any +JavaScript value other than null.

        +
      • Optionalencoding: BufferEncoding

        The encoding if chunk is a string

        +
      • Optionalcb: (() => void)
          • (): void

          • Returns void

      Returns this

      Since

      v0.9.4

      +

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

      -
      import { EventEmitter } from 'node:events';

      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
      -

      Returns (string | symbol)[]

      Since

      v6.0.0

      +
      import { EventEmitter } from 'node:events';

      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]
+
      + +

      Returns (string | symbol)[]

      Since

      v6.0.0

    every

    • every(fn, options?): Promise<boolean>

    • This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

      -

      Parameters

      • fn: ((data, options?) => boolean | Promise<boolean>)

        a function to call on each chunk of the stream. Async or not.

        -
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optional options: ArrayOptions

      Returns Promise<boolean>

      a promise evaluating to true if fn returned a truthy value for every one of the chunks.

      -

      Since

      v17.5.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)

        a function to call on each chunk of the stream. Async or not.

        +
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optionaloptions: ArrayOptions

      Returns Promise<boolean>

      a promise evaluating to true if fn returned a truthy value for every one of the chunks.

      +

      Since

      v17.5.0

    filter

    • filter(fn, options?): Readable

    • This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

      -

      Parameters

      • fn: ((data, options?) => boolean | Promise<boolean>)

        a function to filter chunks from the stream. Async or not.

        -
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optional options: ArrayOptions

      Returns Readable

      a stream filtered with the predicate fn.

      -

      Since

      v17.4.0, v16.14.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)

        a function to filter chunks from the stream. Async or not.

        +
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream filtered with the predicate fn.

      +

      Since

      v17.4.0, v16.14.0

    find

    • find<T>(fn, options?): Promise<T>

    • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

      -

      Type Parameters

      • T

      Parameters

      • fn: ((data, options?) => data is T)

        a function to call on each chunk of the stream. Async or not.

        -
          • (data, options?): data is T

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns data is T

      • Optional options: ArrayOptions

      Returns Promise<T>

      a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

    Type Parameters

    • T

    Parameters

    • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => data is T)

      a function to call on each chunk of the stream. Async or not.

      +
        • (data, options?): data is T

        • Parameters

          • data: any
          • Optionaloptions: Pick<ArrayOptions, "signal">

          Returns data is T

    • Optionaloptions: ArrayOptions

    Returns Promise<T>

    a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

    -

    Since

    v17.5.0

    -
  • find(fn, options?): Promise<any>

  • Parameters

    • fn: ((data, options?) => boolean | Promise<boolean>)
        • (data, options?): boolean | Promise<boolean>

        • Parameters

          • data: any
          • Optional options: Pick<ArrayOptions, "signal">

          Returns boolean | Promise<boolean>

    • Optional options: ArrayOptions

    Returns Promise<any>

    • flatMap

    • flatMap(fn, options?): Readable

    • This method returns a new stream by applying the given callback to each chunk of the stream +

      Since

      v17.5.0

      +
    • find(fn, options?): Promise<any>

    • Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optionaloptions: ArrayOptions

      Returns Promise<any>

    flatMap

    • flatMap(fn, options?): Readable

    • This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

      It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

      -

      Parameters

      • fn: ((data, options?) => any)

        a function to map over every chunk in the stream. May be async. May be a stream or generator.

        -
          • (data, options?): any

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns any

      • Optional options: ArrayOptions

      Returns Readable

      a stream flat-mapped with the function fn.

      -

      Since

      v17.5.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => any)

        a function to map over every chunk in the stream. May be async. May be a stream or generator.

        +
          • (data, options?): any

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns any

      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream flat-mapped with the function fn.

      +

      Since

      v17.5.0

    forEach

    • forEach(fn, options?): Promise<void>

    • This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

      This method is different from for await...of loops in that it can optionally process chunks concurrently. @@ -164,54 +339,58 @@ In either case the stream will be destroyed.

      This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

      -

      Parameters

      • fn: ((data, options?) => void | Promise<void>)

        a function to call on each chunk of the stream. Async or not.

        -
          • (data, options?): void | Promise<void>

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns void | Promise<void>

      • Optional options: ArrayOptions

      Returns Promise<void>

      a promise for when the stream has finished.

      -

      Since

      v17.5.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => void | Promise<void>)

        a function to call on each chunk of the stream. Async or not.

        +
          • (data, options?): void | Promise<void>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns void | Promise<void>

      • Optionaloptions: ArrayOptions

      Returns Promise<void>

      a promise for when the stream has finished.

      +

      Since

      v17.5.0

    getMaxListeners

    • getMaxListeners(): number

    • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

      -

      Returns number

      Since

      v1.0.0

      +

      Returns number

      Since

      v1.0.0

    isPaused

    • isPaused(): boolean

    • The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most typical cases, there will be no reason to use this method directly.

      -
      const readable = new stream.Readable();

      readable.isPaused(); // === false
      readable.pause();
      readable.isPaused(); // === true
      readable.resume();
      readable.isPaused(); // === false
-
      -

      Returns boolean

      Since

      v0.11.14

      +
      const readable = new stream.Readable();

      readable.isPaused(); // === false
      readable.pause();
      readable.isPaused(); // === true
      readable.resume();
      readable.isPaused(); // === false
+
      + +

      Returns boolean

      Since

      v0.11.14

    iterator

    • iterator(options?): AsyncIterableIterator<any>

    • The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

      -

      Parameters

      • Optional options: {
            destroyOnReturn?: boolean;
        }
        • Optional destroyOnReturn?: boolean

          When set to false, calling return on the async iterator, +

          Parameters

          • Optionaloptions: {
                destroyOnReturn?: boolean;
            }
            • OptionaldestroyOnReturn?: boolean

              When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

              -

          Returns AsyncIterableIterator<any>

          Since

          v16.3.0

          +

      Returns AsyncIterableIterator<any>

      Since

      v16.3.0

    listenerCount

    • listenerCount(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

        -
      • Optional listener: Function

        The event handler function

        -

      Returns number

      Since

      v3.2.0

      +
    • Optionallistener: Function

      The event handler function

      +

    Returns number

    Since

    v3.2.0

    listeners

    • listeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      -
      server.on('connection', (stream) => {
        console.log('someone connected!');
      });
      console.log(util.inspect(server.listeners('connection')));
      // Prints: [ [Function] ]
-
      -

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v0.1.26

      +
      server.on('connection', (stream) => {
        console.log('someone connected!');
      });
      console.log(util.inspect(server.listeners('connection')));
      // Prints: [ [Function] ]
+
      + +

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v0.1.26

    map

    • map(fn, options?): Readable

    • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

      -

      Parameters

      • fn: ((data, options?) => any)

        a function to map over every chunk in the stream. Async or not.

        -
          • (data, options?): any

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns any

      • Optional options: ArrayOptions

      Returns Readable

      a stream mapped with the function fn.

      -

      Since

      v17.4.0, v16.14.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => any)

        a function to map over every chunk in the stream. Async or not.

        +
          • (data, options?): any

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns any

      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream mapped with the function fn.

      +

      Since

      v17.4.0, v16.14.0

    off

    • off(eventName, listener): this

    • Alias for emitter.removeListener().

      -

      Parameters

      • eventName: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v10.0.0

      -

    on

    • on(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    once

    • once(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    pause

    • pause(): this

    • The readable.pause() method will cause a stream in flowing mode to stop +

      Parameters

      • eventName: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

      Since

      v10.0.0

      +

    on

    • on(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    once

    • once(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    pause

    • pause(): this

    • The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

      -
      const readable = getReadableStreamSomehow();
      readable.on('data', (chunk) => {
        console.log(`Received ${chunk.length} bytes of data.`);
        readable.pause();
        console.log('There will be no additional data for 1 second.');
        setTimeout(() => {
          console.log('Now data will start flowing again.');
          readable.resume();
        }, 1000);
      });
-
      +
      const readable = getReadableStreamSomehow();
      readable.on('data', (chunk) => {
        console.log(`Received ${chunk.length} bytes of data.`);
        readable.pause();
        console.log('There will be no additional data for 1 second.');
        setTimeout(() => {
          console.log('Now data will start flowing again.');
          readable.resume();
        }, 1000);
      });
+
      +

      The readable.pause() method has no effect if there is a 'readable'event listener.

      -

      Returns this

      Since

      v0.9.4

      -

    pipe

    • pipe<T>(destination, options?): T

    • Type Parameters

      • T extends WritableStream

      Parameters

      • destination: T
      • Optional options: {
            end?: boolean;
        }
        • Optional end?: boolean

      Returns T

    prependListener

    • prependListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    prependOnceListener

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    push

    • push(chunk, encoding?): boolean

    • Parameters

      • chunk: any
      • Optional encoding: BufferEncoding

      Returns boolean

    rawListeners

    • rawListeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName, +

      Returns this

      Since

      v0.9.4

      +

    pipe

    • pipe<T>(destination, options?): T

    • Type Parameters

      • T extends WritableStream

      Parameters

      • destination: T
      • Optionaloptions: {
            end?: boolean;
        }
        • Optionalend?: boolean

      Returns T

    prependListener

    • prependListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    prependOnceListener

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    push

    • push(chunk, encoding?): boolean

    • Parameters

      • chunk: any
      • Optionalencoding: BufferEncoding

      Returns boolean

    rawListeners

    • rawListeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

      -
      import { EventEmitter } from 'node:events';
      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');
-
      -

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v9.4.0

      +
      import { EventEmitter } from 'node:events';
      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');
+
      + +

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v9.4.0

    read

    • read(size?): any

    • The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been @@ -226,8 +405,9 @@

      The readable.read() method should only be called on Readable streams operating in paused mode. In flowing mode, readable.read() is called automatically until the internal buffer is fully drained.

      -
      const readable = getReadableStreamSomehow();

      // 'readable' may be triggered multiple times as data is buffered in
      readable.on('readable', () => {
        let chunk;
        console.log('Stream is readable (new data received in buffer)');
        // Use a loop to make sure we read all currently available data
        while (null !== (chunk = readable.read())) {
          console.log(`Read ${chunk.length} bytes of data...`);
        }
      });

      // 'end' will be triggered once when there is no more data available
      readable.on('end', () => {
        console.log('Reached end of stream.');
      });
-
      +
      const readable = getReadableStreamSomehow();

      // 'readable' may be triggered multiple times as data is buffered in
      readable.on('readable', () => {
        let chunk;
        console.log('Stream is readable (new data received in buffer)');
        // Use a loop to make sure we read all currently available data
        while (null !== (chunk = readable.read())) {
          console.log(`Read ${chunk.length} bytes of data...`);
        }
      });

      // 'end' will be triggered once when there is no more data available
      readable.on('end', () => {
        console.log('Reached end of stream.');
      });
+
      +

      Each call to readable.read() returns a chunk of data, or null. The chunks are not concatenated. A while loop is necessary to consume all data currently in the buffer. When reading a large file .read() may return null, @@ -237,41 +417,46 @@ emitted when there is no more data to come.

      Therefore to read a file's whole contents from a readable, it is necessary to collect chunks across multiple 'readable' events:

      -
      const chunks = [];

      readable.on('readable', () => {
        let chunk;
        while (null !== (chunk = readable.read())) {
          chunks.push(chunk);
        }
      });

      readable.on('end', () => {
        const content = chunks.join('');
      });
-
      +
      const chunks = [];

      readable.on('readable', () => {
        let chunk;
        while (null !== (chunk = readable.read())) {
          chunks.push(chunk);
        }
      });

      readable.on('end', () => {
        const content = chunks.join('');
      });
+
      +

      A Readable stream in object mode will always return a single item from a call to readable.read(size), regardless of the value of thesize argument.

      If the readable.read() method returns a chunk of data, a 'data' event will also be emitted.

      Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

      -

      Parameters

      • Optional size: number

        Optional argument to specify how much data to read.

        -

      Returns any

      Since

      v0.9.4

      +

      Parameters

      • Optionalsize: number

        Optional argument to specify how much data to read.

        +

      Returns any

      Since

      v0.9.4

    reduce

    • reduce<T>(fn, initial?, options?): Promise<T>

    • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

      If no initial value is supplied the first chunk of the stream is used as the initial value. If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

      The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

      -

      Type Parameters

      • T = any

      Parameters

      • fn: ((previous, data, options?) => T)

        a reducer function to call over every chunk in the stream. Async or not.

        -
          • (previous, data, options?): T

          • Parameters

            • previous: any
            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns T

      • Optional initial: undefined

        the initial value to use in the reduction.

        -
      • Optional options: Pick<ArrayOptions, "signal">

      Returns Promise<T>

      a promise for the final value of the reduction.

      -

      Since

      v17.5.0

      -
    • reduce<T>(fn, initial, options?): Promise<T>

    • Type Parameters

      • T = any

      Parameters

      • fn: ((previous, data, options?) => T)
          • (previous, data, options?): T

          • Parameters

            • previous: T
            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns T

      • initial: T
      • Optional options: Pick<ArrayOptions, "signal">

      Returns Promise<T>

    removeAllListeners

    • removeAllListeners(event?): this

    • Removes all listeners, or those of the specified eventName.

      +

      Type Parameters

      • T = any

      Parameters

      • fn: ((previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T)

        a reducer function to call over every chunk in the stream. Async or not.

        +
          • (previous, data, options?): T

          • Parameters

            • previous: any
            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns T

      • Optionalinitial: undefined

        the initial value to use in the reduction.

        +
      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Promise<T>

      a promise for the final value of the reduction.

      +

      Since

      v17.5.0

      +
    • reduce<T>(fn, initial, options?): Promise<T>

    • Type Parameters

      • T = any

      Parameters

      • fn: ((previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T)
          • (previous, data, options?): T

          • Parameters

            • previous: T
            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns T

      • initial: T
      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Promise<T>

    removeAllListeners

    • removeAllListeners(event?): this

    • Removes all listeners, or those of the specified eventName.

      It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

      Returns a reference to the EventEmitter, so that calls can be chained.

      -

      Parameters

      • Optional event: string | symbol

      Returns this

      Since

      v0.1.26

      -

    removeListener

    • removeListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    resume

    • resume(): this

    • The readable.resume() method causes an explicitly paused Readable stream to +

      Parameters

      • Optionalevent: string | symbol

      Returns this

      Since

      v0.1.26

      +

    removeListener

    • removeListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    resume

    • resume(): this

    • The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

      The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

      -
      getReadableStreamSomehow()
        .resume()
        .on('end', () => {
          console.log('Reached the end, but did not read anything.');
        });
-
      +
      getReadableStreamSomehow()
        .resume()
        .on('end', () => {
          console.log('Reached the end, but did not read anything.');
        });
+
      +

      The readable.resume() method has no effect if there is a 'readable'event listener.

      -

      Returns this

      Since

      v0.9.4

      -

    setDefaultEncoding

    • setDefaultEncoding(encoding): this

    • Parameters

      • encoding: BufferEncoding

      Returns this

    setEncoding

    • setEncoding(encoding): this

    • The readable.setEncoding() method sets the character encoding for +

      Returns this

      Since

      v0.9.4

      +

    setDefaultEncoding

    • setDefaultEncoding(encoding): this

    • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

      +

      Parameters

      • encoding: BufferEncoding

        The new default encoding

        +

      Returns this

      Since

      v0.11.15

      +

    setEncoding

    • setEncoding(encoding): this

    • The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

      By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the @@ -280,41 +465,58 @@

      The Readable stream will properly handle multi-byte characters delivered through the stream that would otherwise become improperly decoded if simply pulled from the stream as Buffer objects.

      -
      const readable = getReadableStreamSomehow();
      readable.setEncoding('utf8');
      readable.on('data', (chunk) => {
        assert.equal(typeof chunk, 'string');
        console.log('Got %d characters of string data:', chunk.length);
      });
-
      +
      const readable = getReadableStreamSomehow();
      readable.setEncoding('utf8');
      readable.on('data', (chunk) => {
        assert.equal(typeof chunk, 'string');
        console.log('Got %d characters of string data:', chunk.length);
      });
+
      +

      Parameters

      • encoding: BufferEncoding

        The encoding to use.

        -

      Returns this

      Since

      v0.9.4

      +

    Returns this

    Since

    v0.9.4

    setMaxListeners

    • setMaxListeners(n): this

    • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

      Returns a reference to the EventEmitter, so that calls can be chained.

      -

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

      +

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

    some

    • some(fn, options?): Promise<boolean>

    • This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

      -

      Parameters

      • fn: ((data, options?) => boolean | Promise<boolean>)

        a function to call on each chunk of the stream. Async or not.

        -
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optional options: ArrayOptions

      Returns Promise<boolean>

      a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

      -

      Since

      v17.5.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)

        a function to call on each chunk of the stream. Async or not.

        +
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optionaloptions: ArrayOptions

      Returns Promise<boolean>

      a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

      +

      Since

      v17.5.0

    take

    • take(limit, options?): Readable

    • This method returns a new stream with the first limit chunks.

      Parameters

      • limit: number

        the number of chunks to take from the readable.

        -
      • Optional options: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream with limit chunks taken.

      -

      Since

      v17.5.0

      +
    • Optionaloptions: Pick<ArrayOptions, "signal">

    Returns Readable

    a stream with limit chunks taken.

    +

    Since

    v17.5.0

    toArray

    • toArray(options?): Promise<any[]>

    • This method allows easily obtaining the contents of a stream.

      As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

      -

      Parameters

      • Optional options: Pick<ArrayOptions, "signal">

      Returns Promise<any[]>

      a promise containing an array with the contents of the stream.

      -

      Since

      v17.5.0

      -

    uncork

    • uncork(): void

    • Returns void

    unpipe

    • unpipe(destination?): this

    • The readable.unpipe() method detaches a Writable stream previously attached +

      Parameters

      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Promise<any[]>

      a promise containing an array with the contents of the stream.

      +

      Since

      v17.5.0

      +

    uncork

    • uncork(): void

    • The writable.uncork() method flushes all data buffered since cork was called.

      +

      When using writable.cork() and writable.uncork() to manage the buffering +of writes to a stream, defer calls to writable.uncork() usingprocess.nextTick(). Doing so allows batching of allwritable.write() calls that occur within a given Node.js event +loop phase.

      +
      stream.cork();
      stream.write('some ');
      stream.write('data ');
      process.nextTick(() => stream.uncork());
+
      + +

      If the writable.cork() method is called multiple times on a stream, the +same number of calls to writable.uncork() must be called to flush the buffered +data.

      +
      stream.cork();
      stream.write('some ');
      stream.cork();
      stream.write('data ');
      process.nextTick(() => {
        stream.uncork();
        // The data will not be flushed until uncork() is called a second time.
        stream.uncork();
      });
+
      + +

      See also: writable.cork().

      +

      Returns void

      Since

      v0.11.2

      +

    unpipe

    • unpipe(destination?): this

    • The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

      If the destination is not specified, then all pipes are detached.

      If the destination is specified, but no pipe is set up for it, then the method does nothing.

      -
      const fs = require('node:fs');
      const readable = getReadableStreamSomehow();
      const writable = fs.createWriteStream('file.txt');
      // All the data from readable goes into 'file.txt',
      // but only for the first second.
      readable.pipe(writable);
      setTimeout(() => {
        console.log('Stop writing to file.txt.');
        readable.unpipe(writable);
        console.log('Manually close the file stream.');
        writable.end();
      }, 1000);
-
      -

      Parameters

      • Optional destination: WritableStream

        Optional specific stream to unpipe

        -

      Returns this

      Since

      v0.9.4

      +
      const fs = require('node:fs');
      const readable = getReadableStreamSomehow();
      const writable = fs.createWriteStream('file.txt');
      // All the data from readable goes into 'file.txt',
      // but only for the first second.
      readable.pipe(writable);
      setTimeout(() => {
        console.log('Stop writing to file.txt.');
        readable.unpipe(writable);
        console.log('Manually close the file stream.');
        writable.end();
      }, 1000);
+
      + +

      Parameters

      • Optionaldestination: WritableStream

        Optional specific stream to unpipe

        +

      Returns this

      Since

      v0.9.4

    unshift

    • unshift(chunk, encoding?): void

    • Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be @@ -327,8 +529,9 @@ has been emitted or a runtime error will be thrown.

      Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

      -
      // Pull off a header delimited by \n\n.
      // Use unshift() if we get too much.
      // Call the callback with (error, header, stream).
      const { StringDecoder } = require('node:string_decoder');
      function parseHeader(stream, callback) {
        stream.on('error', callback);
        stream.on('readable', onReadable);
        const decoder = new StringDecoder('utf8');
        let header = '';
        function onReadable() {
          let chunk;
          while (null !== (chunk = stream.read())) {
            const str = decoder.write(chunk);
            if (str.includes('\n\n')) {
              // Found the header boundary.
              const split = str.split(/\n\n/);
              header += split.shift();
              const remaining = split.join('\n\n');
              const buf = Buffer.from(remaining, 'utf8');
              stream.removeListener('error', callback);
              // Remove the 'readable' listener before unshifting.
              stream.removeListener('readable', onReadable);
              if (buf.length)
                stream.unshift(buf);
              // Now the body of the message can be read from the stream.
              callback(null, header, stream);
              return;
            }
            // Still reading the header.
            header += str;
          }
        }
      }
-
      +
      // Pull off a header delimited by \n\n.
      // Use unshift() if we get too much.
      // Call the callback with (error, header, stream).
      const { StringDecoder } = require('node:string_decoder');
      function parseHeader(stream, callback) {
        stream.on('error', callback);
        stream.on('readable', onReadable);
        const decoder = new StringDecoder('utf8');
        let header = '';
        function onReadable() {
          let chunk;
          while (null !== (chunk = stream.read())) {
            const str = decoder.write(chunk);
            if (str.includes('\n\n')) {
              // Found the header boundary.
              const split = str.split(/\n\n/);
              header += split.shift();
              const remaining = split.join('\n\n');
              const buf = Buffer.from(remaining, 'utf8');
              stream.removeListener('error', callback);
              // Remove the 'readable' listener before unshifting.
              stream.removeListener('readable', onReadable);
              if (buf.length)
                stream.unshift(buf);
              // Now the body of the message can be read from the stream.
              callback(null, header, stream);
              return;
            }
            // Still reading the header.
            header += str;
          }
        }
      }
+
      +

      Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. This can cause unexpected results if readable.unshift() is called during a @@ -338,8 +541,8 @@ process of performing a read.

      Parameters

      • chunk: any

        Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array, or null. For object mode streams, chunk may be any JavaScript value.

        -
      • Optional encoding: BufferEncoding

        Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

        -

      Returns void

      Since

      v0.9.11

      +
    • Optionalencoding: BufferEncoding

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      +

    Returns void

    Since

    v0.9.11

    wrap

    • wrap(stream): this

    • Prior to Node.js 0.10, streams did not implement the entire node:streammodule API as it is currently defined. (See Compatibility for more information.)

      When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable @@ -348,11 +551,83 @@

      It will rarely be necessary to use readable.wrap() but the method has been provided as a convenience for interacting with older Node.js applications and libraries.

      -
      const { OldReader } = require('./old-api-module.js');
      const { Readable } = require('node:stream');
      const oreader = new OldReader();
      const myReader = new Readable().wrap(oreader);

      myReader.on('readable', () => {
        myReader.read(); // etc.
      });
-
      +
      const { OldReader } = require('./old-api-module.js');
      const { Readable } = require('node:stream');
      const oreader = new OldReader();
      const myReader = new Readable().wrap(oreader);

      myReader.on('readable', () => {
        myReader.read(); // etc.
      });
+
      +

      Parameters

      • stream: ReadableStream

        An "old style" readable stream

        -

      Returns this

      Since

      v0.9.4

      -

    write

    • write(chunk, encoding?, cb?): boolean

    • Parameters

      • chunk: any
      • Optional encoding: BufferEncoding
      • Optional cb: ((error) => void)
          • (error): void

          • Parameters

            Returns void

      Returns boolean

    • write(chunk, cb?): boolean

    • Parameters

      • chunk: any
      • Optional cb: ((error) => void)
          • (error): void

          • Parameters

            Returns void

      Returns boolean

    Static addAbortListener

    • addAbortListener(signal, resource): Disposable
    • Experimental

      Listens once to the abort event on the provided signal.

      +

    Returns this

    Since

    v0.9.4

    +

    write

    • write(chunk, encoding?, cb?): boolean

    • The writable.write() method writes some data to the stream, and calls the +supplied callback once the data has been fully handled. If an error +occurs, the callback will be called with the error as its +first argument. The callback is called asynchronously and before 'error' is +emitted.

      +

      The return value is true if the internal buffer is less than thehighWaterMark configured when the stream was created after admitting chunk. +If false is returned, further attempts to write data to the stream should +stop until the 'drain' event is emitted.

      +

      While a stream is not draining, calls to write() will buffer chunk, and +return false. Once all currently buffered chunks are drained (accepted for +delivery by the operating system), the 'drain' event will be emitted. +Once write() returns false, do not write more chunks +until the 'drain' event is emitted. While calling write() on a stream that +is not draining is allowed, Node.js will buffer all written chunks until +maximum memory usage occurs, at which point it will abort unconditionally. +Even before it aborts, high memory usage will cause poor garbage collector +performance and high RSS (which is not typically released back to the system, +even after the memory is no longer required). Since TCP sockets may never +drain if the remote peer does not read the data, writing a socket that is +not draining may lead to a remotely exploitable vulnerability.

      +

      Writing data while the stream is not draining is particularly +problematic for a Transform, because the Transform streams are paused +by default until they are piped or a 'data' or 'readable' event handler +is added.

      +

      If the data to be written can be generated or fetched on demand, it is +recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is +possible to respect backpressure and avoid memory issues using the 'drain' event:

      +
      function write(data, cb) {
        if (!stream.write(data)) {
          stream.once('drain', cb);
        } else {
          process.nextTick(cb);
        }
      }

      // Wait for cb to be called before doing any other write.
      write('hello', () => {
        console.log('Write completed, do more writes now.');
      });
+
      + +

      A Writable stream in object mode will always ignore the encoding argument.

      +

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any +JavaScript value other than null.

        +
      • Optionalencoding: BufferEncoding

        The encoding, if chunk is a string.

        +
      • Optionalcb: ((error: Error) => void)
          • (error): void

          • Parameters

            Returns void

      Returns boolean

      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

      +

      Since

      v0.9.4

      +
    • write(chunk, cb?): boolean

    • The writable.write() method writes some data to the stream, and calls the +supplied callback once the data has been fully handled. If an error +occurs, the callback will be called with the error as its +first argument. The callback is called asynchronously and before 'error' is +emitted.

      +

      The return value is true if the internal buffer is less than thehighWaterMark configured when the stream was created after admitting chunk. +If false is returned, further attempts to write data to the stream should +stop until the 'drain' event is emitted.

      +

      While a stream is not draining, calls to write() will buffer chunk, and +return false. Once all currently buffered chunks are drained (accepted for +delivery by the operating system), the 'drain' event will be emitted. +Once write() returns false, do not write more chunks +until the 'drain' event is emitted. While calling write() on a stream that +is not draining is allowed, Node.js will buffer all written chunks until +maximum memory usage occurs, at which point it will abort unconditionally. +Even before it aborts, high memory usage will cause poor garbage collector +performance and high RSS (which is not typically released back to the system, +even after the memory is no longer required). Since TCP sockets may never +drain if the remote peer does not read the data, writing a socket that is +not draining may lead to a remotely exploitable vulnerability.

      +

      Writing data while the stream is not draining is particularly +problematic for a Transform, because the Transform streams are paused +by default until they are piped or a 'data' or 'readable' event handler +is added.

      +

      If the data to be written can be generated or fetched on demand, it is +recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is +possible to respect backpressure and avoid memory issues using the 'drain' event:

      +
      function write(data, cb) {
        if (!stream.write(data)) {
          stream.once('drain', cb);
        } else {
          process.nextTick(cb);
        }
      }

      // Wait for cb to be called before doing any other write.
      write('hello', () => {
        console.log('Write completed, do more writes now.');
      });
+
      + +

      A Writable stream in object mode will always ignore the encoding argument.

      +

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any +JavaScript value other than null.

        +
      • Optionalcb: ((error: Error) => void)
          • (error): void

          • Parameters

            Returns void

      Returns boolean

      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

      +

      Since

      v0.9.4

      +

    StaticaddAbortListener

    • addAbortListener(signal, resource): Disposable
    • Experimental

      Listens once to the abort event on the provided signal.

      Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -362,11 +637,12 @@ two issues by listening to the event such that stopImmediatePropagation does not prevent the listener from running.

      Returns a disposable so that it may be unsubscribed from more easily.

      -
      import { addAbortListener } from 'node:events';

      function example(signal) {
        let disposable;
        try {
          signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
          disposable = addAbortListener(signal, (e) => {
            // Do something when signal is aborted.
          });
        } finally {
          disposable?.[Symbol.dispose]();
        }
      }
-
      -

      Parameters

      • signal: AbortSignal
      • resource: ((event) => void)
          • (event): void

          • Parameters

            Returns void

      Returns Disposable

      Disposable that removes the abort listener.

      -

      Since

      v20.5.0

      -

    Static from

    • from(src): Duplex

    • A utility method for creating duplex streams.

      +
      import { addAbortListener } from 'node:events';

      function example(signal) {
        let disposable;
        try {
          signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
          disposable = addAbortListener(signal, (e) => {
            // Do something when signal is aborted.
          });
        } finally {
          disposable?.[Symbol.dispose]();
        }
      }
+
      + +

      Parameters

      Returns Disposable

      Disposable that removes the abort listener.

      +

      Since

      v20.5.0

      +

    Staticfrom

    • from(src): Duplex

    • A utility method for creating duplex streams.

      • Stream converts writable stream into writable Duplex and readable stream to Duplex.
        • @@ -384,107 +660,141 @@ Duplex will write to the writable and read from the readable.
      • Promise converts into readable Duplex. Value null is ignored.
      -

      Parameters

      Returns Duplex

      Since

      v16.8.0

      -

    Static fromWeb

    • fromWeb(duplexStream, options?): Duplex
    • Experimental

      A utility method for creating a Duplex from a web ReadableStream and WritableStream.

      -

      Parameters

      • duplexStream: {
            readable: ReadableStream<any>;
            writable: WritableStream<any>;
        }
        • readable: ReadableStream<any>
        • writable: WritableStream<any>
      • Optional options: Pick<DuplexOptions, "signal" | "encoding" | "highWaterMark" | "objectMode" | "decodeStrings" | "allowHalfOpen">

      Returns Duplex

      Since

      v17.0.0

      -

    Static getEventListeners

    • getEventListeners(emitter, name): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      +

      Parameters

      Returns Duplex

      Since

      v16.8.0

      +

    StaticfromWeb

    • fromWeb(duplexStream, options?): Duplex
    • Experimental

      A utility method for creating a Duplex from a web ReadableStream and WritableStream.

      +

      Parameters

      • duplexStream: {
            readable: ReadableStream<any>;
            writable: WritableStream<any>;
        }
        • readable: ReadableStream<any>
        • writable: WritableStream<any>
      • Optionaloptions: Pick<DuplexOptions,
            | "signal"
            | "encoding"
            | "highWaterMark"
            | "objectMode"
            | "decodeStrings"
            | "allowHalfOpen">

      Returns Duplex

      Since

      v17.0.0

      +

    StaticgetEventListeners

    • getEventListeners(emitter, name): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

      For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

      -
      import { getEventListeners, EventEmitter } from 'node:events';

      {
        const ee = new EventEmitter();
        const listener = () => console.log('Events are fun');
        ee.on('foo', listener);
        console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
      }
      {
        const et = new EventTarget();
        const listener = () => console.log('Events are fun');
        et.addEventListener('foo', listener);
        console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
      }
-
      -

      Parameters

      • emitter: EventEmitter | _DOMEventTarget
      • name: string | symbol

      Returns Function[]

      Since

      v15.2.0, v14.17.0

      -

    Static getMaxListeners

    • getMaxListeners(emitter): number

    • Returns the currently set max amount of listeners.

      +
      import { getEventListeners, EventEmitter } from 'node:events';

      {
        const ee = new EventEmitter();
        const listener = () => console.log('Events are fun');
        ee.on('foo', listener);
        console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
      }
      {
        const et = new EventTarget();
        const listener = () => console.log('Events are fun');
        et.addEventListener('foo', listener);
        console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
      }
+
      + +

      Parameters

      • emitter: EventEmitter | _DOMEventTarget
      • name: string | symbol

      Returns Function[]

      Since

      v15.2.0, v14.17.0

      +

    StaticgetMaxListeners

    • getMaxListeners(emitter): number

    • Returns the currently set max amount of listeners.

      For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

      For EventTargets this is the only way to get the max event listeners for the event target. If the number of event handlers on a single EventTarget exceeds the max set, the EventTarget will print a warning.

      -
      import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

      {
        const ee = new EventEmitter();
        console.log(getMaxListeners(ee)); // 10
        setMaxListeners(11, ee);
        console.log(getMaxListeners(ee)); // 11
      }
      {
        const et = new EventTarget();
        console.log(getMaxListeners(et)); // 10
        setMaxListeners(11, et);
        console.log(getMaxListeners(et)); // 11
      }
-
      -

      Parameters

      • emitter: EventEmitter | _DOMEventTarget

      Returns number

      Since

      v19.9.0

      -

    Static isDisturbed

    • isDisturbed(stream): boolean

    • Returns whether the stream has been read from or cancelled.

      -

      Parameters

      • stream: Readable | ReadableStream

      Returns boolean

      Since

      v16.8.0

      -

    Static listenerCount

    • listenerCount(emitter, eventName): number

    • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

      -
      import { EventEmitter, listenerCount } from 'node:events';

      const myEmitter = new EventEmitter();
      myEmitter.on('event', () => {});
      myEmitter.on('event', () => {});
      console.log(listenerCount(myEmitter, 'event'));
      // Prints: 2
-
      +
      import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

      {
        const ee = new EventEmitter();
        console.log(getMaxListeners(ee)); // 10
        setMaxListeners(11, ee);
        console.log(getMaxListeners(ee)); // 11
      }
      {
        const et = new EventTarget();
        console.log(getMaxListeners(et)); // 10
        setMaxListeners(11, et);
        console.log(getMaxListeners(et)); // 11
      }
+
      + +

      Parameters

      • emitter: EventEmitter | _DOMEventTarget

      Returns number

      Since

      v19.9.0

      +

    StaticisDisturbed

    • isDisturbed(stream): boolean

    • Returns whether the stream has been read from or cancelled.

      +

      Parameters

      • stream: Readable | ReadableStream

      Returns boolean

      Since

      v16.8.0

      +

    StaticlistenerCount

    • listenerCount(emitter, eventName): number

    • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

      +
      import { EventEmitter, listenerCount } from 'node:events';

      const myEmitter = new EventEmitter();
      myEmitter.on('event', () => {});
      myEmitter.on('event', () => {});
      console.log(listenerCount(myEmitter, 'event'));
      // Prints: 2
+
      +

      Parameters

      • emitter: EventEmitter

        The emitter to query

      • eventName: string | symbol

        The event name

        -

      Returns number

      Since

      v0.9.12

      -

      Deprecated

      Since v3.2.0 - Use listenerCount instead.

      -

    Static on

    • on(emitter, eventName, options?): AsyncIterableIterator<any>
    • import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
-
      +

    Returns number

    Since

    v0.9.12

    +

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    +

    Staticon

    • on(emitter, eventName, options?): AsyncIterableIterator<any>
    • import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
+
      +

      Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

      An AbortSignal can be used to cancel waiting on events:

      -
      import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ac = new AbortController();

      (async () => {
        const ee = new EventEmitter();

        // Emit later on
        process.nextTick(() => {
          ee.emit('foo', 'bar');
          ee.emit('foo', 42);
        });

        for await (const event of on(ee, 'foo', { signal: ac.signal })) {
          // The execution of this inner block is synchronous and it
          // processes one event at a time (even with await). Do not use
          // if concurrent execution is required.
          console.log(event); // prints ['bar'] [42]
        }
        // Unreachable here
      })();

      process.nextTick(() => ac.abort());
-
      +
      import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ac = new AbortController();

      (async () => {
        const ee = new EventEmitter();

        // Emit later on
        process.nextTick(() => {
          ee.emit('foo', 'bar');
          ee.emit('foo', 42);
        });

        for await (const event of on(ee, 'foo', { signal: ac.signal })) {
          // The execution of this inner block is synchronous and it
          // processes one event at a time (even with await). Do not use
          // if concurrent execution is required.
          console.log(event); // prints ['bar'] [42]
        }
        // Unreachable here
      })();

      process.nextTick(() => ac.abort());
+
      +

      Parameters

      • emitter: EventEmitter
      • eventName: string

        The name of the event being listened for

        -
      • Optional options: StaticEventEmitterOptions

      Returns AsyncIterableIterator<any>

      that iterates eventName events emitted by the emitter

      -

      Since

      v13.6.0, v12.16.0

      -

    Static once

    • once(emitter, eventName, options?): Promise<any[]>

    • Creates a Promise that is fulfilled when the EventEmitter emits the given +

    • Optionaloptions: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    +

    Since

    v13.6.0, v12.16.0

    +

    Staticonce

    • once(emitter, eventName, options?): Promise<any[]>

    • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

      -

      This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event +

      This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

      -
      import { once, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.error('error happened', err);
      }
-
      +
      import { once, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.error('error happened', err);
      }
+
      +

      The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

      -
      import { EventEmitter, once } from 'node:events';

      const ee = new EventEmitter();

      once(ee, 'error')
        .then(([err]) => console.log('ok', err.message))
        .catch((err) => console.error('error', err.message));

      ee.emit('error', new Error('boom'));

      // Prints: ok boom
-
      +
      import { EventEmitter, once } from 'node:events';

      const ee = new EventEmitter();

      once(ee, 'error')
        .then(([err]) => console.log('ok', err.message))
        .catch((err) => console.error('error', err.message));

      ee.emit('error', new Error('boom'));

      // Prints: ok boom
+
      +

      An AbortSignal can be used to cancel waiting for the event:

      -
      import { EventEmitter, once } from 'node:events';

      const ee = new EventEmitter();
      const ac = new AbortController();

      async function foo(emitter, event, signal) {
        try {
          await once(emitter, event, { signal });
          console.log('event emitted!');
        } catch (error) {
          if (error.name === 'AbortError') {
            console.error('Waiting for the event was canceled!');
          } else {
            console.error('There was an error', error.message);
          }
        }
      }

      foo(ee, 'foo', ac.signal);
      ac.abort(); // Abort waiting for the event
      ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
      -

      Parameters

      • emitter: _NodeEventTarget
      • eventName: string | symbol
      • Optional options: StaticEventEmitterOptions

      Returns Promise<any[]>

      Since

      v11.13.0, v10.16.0

      -
    • once(emitter, eventName, options?): Promise<any[]>

    • Parameters

      • emitter: _DOMEventTarget
      • eventName: string
      • Optional options: StaticEventEmitterOptions

      Returns Promise<any[]>

    Static setMaxListeners

    • setMaxListeners(n?, ...eventTargets): void
    • import { setMaxListeners, EventEmitter } from 'node:events';

      const target = new EventTarget();
      const emitter = new EventEmitter();

      setMaxListeners(5, target, emitter);
-
      -

      Parameters

      • Optional n: number

        A non-negative number. The maximum number of listeners per EventTarget event.

        -
      • Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]

      Returns void

      Since

      v15.4.0

      -

    Static toWeb

    • toWeb(streamDuplex): {
          readable: ReadableStream<any>;
          writable: WritableStream<any>;
      }
    • Experimental

      A utility method for creating a web ReadableStream and WritableStream from a Duplex.

      -

      Parameters

      • streamDuplex: Duplex

      Returns {
          readable: ReadableStream<any>;
          writable: WritableStream<any>;
      }

      • readable: ReadableStream<any>
      • writable: WritableStream<any>

      Since

      v17.0.0

      -

    Properties

    allowHalfOpen

    allowHalfOpen: boolean

    If false then the stream will automatically end the writable side when the +

    import { EventEmitter, once } from 'node:events';

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
+
    + +

    Parameters

    • emitter: _NodeEventTarget
    • eventName: string | symbol
    • Optionaloptions: StaticEventEmitterOptions

    Returns Promise<any[]>

    Since

    v11.13.0, v10.16.0

    +
  • once(emitter, eventName, options?): Promise<any[]>

  • Parameters

    • emitter: _DOMEventTarget
    • eventName: string
    • Optionaloptions: StaticEventEmitterOptions

    Returns Promise<any[]>

    • StaticsetMaxListeners

    • setMaxListeners(n?, ...eventTargets): void
    • import { setMaxListeners, EventEmitter } from 'node:events';

      const target = new EventTarget();
      const emitter = new EventEmitter();

      setMaxListeners(5, target, emitter);
+
      + +

      Parameters

      • Optionaln: number

        A non-negative number. The maximum number of listeners per EventTarget event.

        +
      • Rest...eventTargets: (EventEmitter | _DOMEventTarget)[]

      Returns void

      Since

      v15.4.0

      +

    StatictoWeb

    • toWeb(streamDuplex): {
          readable: ReadableStream<any>;
          writable: WritableStream<any>;
      }
    • Experimental

      A utility method for creating a web ReadableStream and WritableStream from a Duplex.

      +

      Parameters

      • streamDuplex: Duplex

      Returns {
          readable: ReadableStream<any>;
          writable: WritableStream<any>;
      }

      • Experimentalreadable: ReadableStream<any>
      • Experimentalwritable: WritableStream<any>

      Since

      v17.0.0

      +

    Properties

    allowHalfOpen

    allowHalfOpen: boolean

    If false then the stream will automatically end the writable side when the readable side ends. Set initially by the allowHalfOpen constructor option, which defaults to true.

    This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is emitted.

    -

    Since

    v0.9.4

    -

    Readonly closed

    closed: boolean

    destroyed

    destroyed: boolean

    Is true after readable.destroy() has been called.

    -

    Since

    v8.0.0

    -

    Readonly errored

    errored: Error

    readable

    readable: boolean

    Is true if it is safe to call readable.read(), which means +

    Since

    v0.9.4

    +

    Readonlyclosed

    closed: boolean

    Is true after 'close' has been emitted.

    +

    Since

    v18.0.0

    +

    destroyed

    destroyed: boolean

    Is true after readable.destroy() has been called.

    +

    Since

    v8.0.0

    +

    Readonlyerrored

    errored: Error

    Returns error if the stream has been destroyed with an error.

    +

    Since

    v18.0.0

    +

    readable

    readable: boolean

    Is true if it is safe to call readable.read(), which means the stream has not been destroyed or emitted 'error' or 'end'.

    -

    Since

    v11.4.0

    -

    Readonly Experimental readableAborted

    readableAborted: boolean

    Returns whether the stream was destroyed or errored before emitting 'end'.

    -

    Since

    v16.8.0

    -

    Readonly Experimental readableDidRead

    readableDidRead: boolean

    Returns whether 'data' has been emitted.

    -

    Since

    v16.7.0, v14.18.0

    -

    Readonly readableEncoding

    readableEncoding: BufferEncoding

    Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

    -

    Since

    v12.7.0

    -

    Readonly readableEnded

    readableEnded: boolean

    Becomes true when 'end' event is emitted.

    -

    Since

    v12.9.0

    -

    Readonly readableFlowing

    readableFlowing: boolean

    This property reflects the current state of a Readable stream as described +

    Since

    v11.4.0

    +

    Readonly ExperimentalreadableAborted

    readableAborted: boolean

    Returns whether the stream was destroyed or errored before emitting 'end'.

    +

    Since

    v16.8.0

    +

    Readonly ExperimentalreadableDidRead

    readableDidRead: boolean

    Returns whether 'data' has been emitted.

    +

    Since

    v16.7.0, v14.18.0

    +

    ReadonlyreadableEncoding

    readableEncoding: BufferEncoding

    Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

    +

    Since

    v12.7.0

    +

    ReadonlyreadableEnded

    readableEnded: boolean

    Becomes true when 'end' event is emitted.

    +

    Since

    v12.9.0

    +

    ReadonlyreadableFlowing

    readableFlowing: boolean

    This property reflects the current state of a Readable stream as described in the Three states section.

    -

    Since

    v9.4.0

    -

    Readonly readableHighWaterMark

    readableHighWaterMark: number

    Returns the value of highWaterMark passed when creating this Readable.

    -

    Since

    v9.3.0

    -

    Readonly readableLength

    readableLength: number

    This property contains the number of bytes (or objects) in the queue +

    Since

    v9.4.0

    +

    ReadonlyreadableHighWaterMark

    readableHighWaterMark: number

    Returns the value of highWaterMark passed when creating this Readable.

    +

    Since

    v9.3.0

    +

    ReadonlyreadableLength

    readableLength: number

    This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the highWaterMark.

    -

    Since

    v9.4.0

    -

    Readonly readableObjectMode

    readableObjectMode: boolean

    Getter for the property objectMode of a given Readable stream.

    -

    Since

    v12.3.0

    -

    Readonly writable

    writable: boolean

    Readonly writableCorked

    writableCorked: number

    Readonly writableEnded

    writableEnded: boolean

    Readonly writableFinished

    writableFinished: boolean

    Readonly writableHighWaterMark

    writableHighWaterMark: number

    Readonly writableLength

    writableLength: number

    Readonly writableNeedDrain

    writableNeedDrain: boolean

    Readonly writableObjectMode

    writableObjectMode: boolean

    Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    -

    See how to write a custom rejection handler.

    -

    Since

    v13.4.0, v12.16.0

    -

    Static captureRejections

    captureRejections: boolean

    Value: boolean

    +

    Since

    v9.4.0

    +

    ReadonlyreadableObjectMode

    readableObjectMode: boolean

    Getter for the property objectMode of a given Readable stream.

    +

    Since

    v12.3.0

    +

    Readonlywritable

    writable: boolean

    Is true if it is safe to call writable.write(), which means +the stream has not been destroyed, errored, or ended.

    +

    Since

    v11.4.0

    +

    ReadonlywritableCorked

    writableCorked: number

    Number of times writable.uncork() needs to be +called in order to fully uncork the stream.

    +

    Since

    v13.2.0, v12.16.0

    +

    ReadonlywritableEnded

    writableEnded: boolean

    Is true after writable.end() has been called. This property +does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

    +

    Since

    v12.9.0

    +

    ReadonlywritableFinished

    writableFinished: boolean

    Is set to true immediately before the 'finish' event is emitted.

    +

    Since

    v12.6.0

    +

    ReadonlywritableHighWaterMark

    writableHighWaterMark: number

    Return the value of highWaterMark passed when creating this Writable.

    +

    Since

    v9.3.0

    +

    ReadonlywritableLength

    writableLength: number

    This property contains the number of bytes (or objects) in the queue +ready to be written. The value provides introspection data regarding +the status of the highWaterMark.

    +

    Since

    v9.4.0

    +

    ReadonlywritableNeedDrain

    writableNeedDrain: boolean

    Is true if the stream's buffer has been full and stream will emit 'drain'.

    +

    Since

    v15.2.0, v14.17.0

    +

    ReadonlywritableObjectMode

    writableObjectMode: boolean

    Getter for the property objectMode of a given Writable stream.

    +

    Since

    v12.3.0

    +

    StaticcaptureRejections

    captureRejections: boolean

    Value: boolean

    Change the default captureRejections option on all new EventEmitter objects.

    -

    Since

    v13.4.0, v12.16.0

    -

    Static defaultMaxListeners

    defaultMaxListeners: number

    By default, a maximum of 10 listeners can be registered for any single +

    Since

    v13.4.0, v12.16.0

    +

    Static ReadonlycaptureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    +

    See how to write a custom rejection handler.

    +

    Since

    v13.4.0, v12.16.0

    +

    StaticdefaultMaxListeners

    defaultMaxListeners: number

    By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListenersproperty can be used. If this value is not a positive number, a RangeErroris thrown.

    @@ -496,8 +806,9 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    more listeners to be added but will output a trace warning to stderr indicating that a "possible EventEmitter memory leak" has been detected. For any singleEventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()methods can be used to temporarily avoid this warning:

    -
    import { EventEmitter } from 'node:events';
    const emitter = new EventEmitter();
    emitter.setMaxListeners(emitter.getMaxListeners() + 1);
    emitter.once('event', () => {
      // do stuff
      emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
    });
-
    +
    import { EventEmitter } from 'node:events';
    const emitter = new EventEmitter();
    emitter.setMaxListeners(emitter.getMaxListeners() + 1);
    emitter.once('event', () => {
      // do stuff
      emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
    });
+
    +

    The --trace-warnings command-line flag can be used to display the stack trace for such warnings.

    The emitted warning can be inspected with process.on('warning') and will @@ -505,9 +816,9 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    the event emitter instance, the event's name and the number of attached listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

    -

    Since

    v0.11.2

    -

    Static Readonly errorMonitor

    errorMonitor: typeof errorMonitor

    This symbol shall be used to install a listener for only monitoring 'error'events. Listeners installed using this symbol are called before the regular'error' listeners are called.

    +

    Since

    v0.11.2

    +

    Static ReadonlyerrorMonitor

    errorMonitor: typeof errorMonitor

    This symbol shall be used to install a listener for only monitoring 'error'events. Listeners installed using this symbol are called before the regular'error' listeners are called.

    Installing a listener using this symbol does not change the behavior once an'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

    -

    Since

    v13.6.0, v12.17.0

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructor[asyncDispose][asyncIterator][captureRejectionSymbol]_construct_destroy_final_flush_read_transform_write_writevaddListenerasIndexedPairscomposecorkdestroydropemitendeventNameseveryfilterfindflatMapforEachgetMaxListenersisPausediteratorlistenerCountlistenersmapoffononcepausepipeprependListenerprependOnceListenerpushrawListenersreadreduceremoveAllListenersremoveListenerresumesetDefaultEncodingsetEncodingsetMaxListenerssometaketoArrayuncorkunpipeunshiftwrapwriteaddAbortListenerfromfromWebgetEventListenersgetMaxListenersisDisturbedlistenerCountononcesetMaxListenerstoWeballowHalfOpencloseddestroyederroredreadablereadableAbortedreadableDidReadreadableEncodingreadableEndedreadableFlowingreadableHighWaterMarkreadableLengthreadableObjectModewritablewritableCorkedwritableEndedwritableFinishedwritableHighWaterMarkwritableLengthwritableNeedDrainwritableObjectModecaptureRejectionSymbolcaptureRejectionsdefaultMaxListenerserrorMonitor
    \ No newline at end of file +

    Since

    v13.6.0, v12.17.0

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_format_msgpack.Unpackr.html b/docs/classes/_runtime_data_format_msgpack.Unpackr.html index 37085a45..af561e6e 100644 --- a/docs/classes/_runtime_data_format_msgpack.Unpackr.html +++ b/docs/classes/_runtime_data_format_msgpack.Unpackr.html @@ -1,5 +1,16 @@ -Unpackr | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Unpackr

    Hierarchy (view full)

    Constructors

    constructor +Unpackr | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Unpackr

    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Constructors

    constructor

    Methods

    decode unpack unpackMultiple -

    Constructors

    constructor

    Methods

    decode

    • decode(messagePack): any

    • Parameters

      Returns any

    unpack

    • unpack(messagePack): any

    • Parameters

      Returns any

    unpackMultiple

    • unpackMultiple(messagePack): any[]

    • Parameters

      Returns any[]

    • unpackMultiple(messagePack, forEach): void

    • Parameters

      • messagePack: Uint8Array | Buffer
      • forEach: ((value, start?, end?) => any)
          • (value, start?, end?): any

          • Parameters

            • value: any
            • Optional start: number
            • Optional end: number

            Returns any

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructordecodeunpackunpackMultiple
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    decode

    • decode(messagePack): any

    • Parameters

      Returns any

    unpack

    • unpack(messagePack): any

    • Parameters

      Returns any

    unpackMultiple

    • unpackMultiple(messagePack): any[]

    • Parameters

      Returns any[]

    • unpackMultiple(messagePack, forEach): void

    • Parameters

      • messagePack: Uint8Array | Buffer
      • forEach: ((value: any, start?: number, end?: number) => any)
          • (value, start?, end?): any

          • Parameters

            • value: any
            • Optionalstart: number
            • Optionalend: number

            Returns any

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_format_msgpack.UnpackrStream.html b/docs/classes/_runtime_data_format_msgpack.UnpackrStream.html index 2a1e5598..caa6f147 100644 --- a/docs/classes/_runtime_data_format_msgpack.UnpackrStream.html +++ b/docs/classes/_runtime_data_format_msgpack.UnpackrStream.html @@ -1,8 +1,16 @@ -UnpackrStream | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class UnpackrStream

    Hierarchy

    • Transform
      • UnpackrStream

    Constructors

    constructor -

    Methods

    [asyncDispose] -[asyncIterator] -[captureRejectionSymbol]? -_construct? +UnpackrStream | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class UnpackrStream

    +
    + +
    + + Hierarchy
    +     +
    +
    • Transform
      • UnpackrStream ()
    +
    +

    Constructors

    constructor +

    Methods

    _construct? _destroy _final _flush @@ -10,6 +18,9 @@ _transform _write _writev? +[asyncDispose] +[asyncIterator] +[captureRejectionSymbol]? addListener asIndexedPairs compose @@ -87,13 +98,13 @@ writableLength writableNeedDrain writableObjectMode -captureRejectionSymbol captureRejections +captureRejectionSymbol defaultMaxListeners errorMonitor -

    Constructors

    constructor

    • new UnpackrStream(options?): UnpackrStream

    • Parameters

      • Optional options: Options | {
            allowHalfOpen: boolean;
            emitClose: boolean;
            highWaterMark: number;
        }

      Returns UnpackrStream

    Methods

    [asyncDispose]

    • [asyncDispose](): Promise<void>

    • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

      -

      Returns Promise<void>

      Since

      v20.4.0

      -

    [asyncIterator]

    Optional [captureRejectionSymbol]

    • [captureRejectionSymbol](error, event, ...args): void

    • Parameters

      • error: Error
      • event: string
      • Rest ...args: any[]

      Returns void

    Optional _construct

    • _construct(callback): void

    • Parameters

      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _destroy

    • _destroy(error, callback): void

    • Parameters

      • error: Error
      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _final

    • _final(callback): void

    • Parameters

      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _flush

    • _flush(callback): void

    • Parameters

      • callback: TransformCallback

      Returns void

    _read

    • _read(size): void

    • Parameters

      • size: number

      Returns void

    _transform

    • _transform(chunk, encoding, callback): void

    • Parameters

      • chunk: any
      • encoding: BufferEncoding
      • callback: TransformCallback

      Returns void

    _write

    • _write(chunk, encoding, callback): void

    • Parameters

      • chunk: any
      • encoding: BufferEncoding
      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    Optional _writev

    • _writev(chunks, callback): void

    • Parameters

      • chunks: {
            chunk: any;
            encoding: BufferEncoding;
        }[]
      • callback: ((error?) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    addListener

    • addListener(event, listener): this

    • Event emitter +

    Constructors

    constructor

    • new UnpackrStream(options?): UnpackrStream

    • Parameters

      • Optionaloptions: Options | {
            allowHalfOpen: boolean;
            emitClose: boolean;
            highWaterMark: number;
        }

      Returns UnpackrStream

    Methods

    Optional_construct

    • _construct(callback): void

    • Parameters

      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _destroy

    • _destroy(error, callback): void

    • Parameters

      • error: Error
      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _final

    • _final(callback): void

    • Parameters

      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    _flush

    • _flush(callback): void

    • Parameters

      • callback: TransformCallback

      Returns void

    _read

    • _read(size): void

    • Parameters

      • size: number

      Returns void

    _transform

    • _transform(chunk, encoding, callback): void

    • Parameters

      • chunk: any
      • encoding: BufferEncoding
      • callback: TransformCallback

      Returns void

    _write

    • _write(chunk, encoding, callback): void

    • Parameters

      • chunk: any
      • encoding: BufferEncoding
      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    Optional_writev

    • _writev(chunks, callback): void

    • Parameters

      • chunks: {
            chunk: any;
            encoding: BufferEncoding;
        }[]
      • callback: ((error?: Error) => void)
          • (error?): void

          • Parameters

            Returns void

      Returns void

    [asyncDispose]

    • [asyncDispose](): Promise<void>

    • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

      +

      Returns Promise<void>

      Since

      v20.4.0

      +

    [asyncIterator]

    Optional[captureRejectionSymbol]

    • [captureRejectionSymbol](error, event, ...args): void

    • Parameters

      • error: Error
      • event: string
      • Rest...args: any[]

      Returns void

    addListener

    • addListener(event, listener): this

    • Event emitter The defined events on documents including:

      1. close
        2. @@ -108,54 +119,218 @@
      2. resume
      3. unpipe
      -

      Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    asIndexedPairs

    • asIndexedPairs(options?): Readable

    • This method returns a new stream with chunks of the underlying stream paired with a counter +

      Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +The defined events on documents including:

      +
        +
      1. close
        2. +
      2. data
        3. +
      3. end
        4. +
      4. error
        5. +
      5. pause
        6. +
      6. readable
        7. +
      7. resume
        8. +
      +

      Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    asIndexedPairs

    • asIndexedPairs(options?): Readable

    • This method returns a new stream with chunks of the underlying stream paired with a counter in the form [index, chunk]. The first index value is 0 and it increases by 1 for each chunk produced.

      -

      Parameters

      • Optional options: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream of indexed pairs.

      -

      Since

      v17.5.0

      -

    compose

    • compose<T>(stream, options?): T

    • Type Parameters

      • T extends ReadableStream

      Parameters

      Returns T

    cork

    • cork(): void

    • Returns void

    destroy

    • destroy(error?): this

    • Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable +

      Parameters

      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream of indexed pairs.

      +

      Since

      v17.5.0

      +

    compose

    • compose<T>(stream, options?): T

    • Type Parameters

      • T extends ReadableStream

      Parameters

      Returns T

    cork

    • cork(): void

    • The writable.cork() method forces all written data to be buffered in memory. +The buffered data will be flushed when either the uncork or end methods are called.

      +

      The primary intent of writable.cork() is to accommodate a situation in which +several small chunks are written to the stream in rapid succession. Instead of +immediately forwarding them to the underlying destination, writable.cork()buffers all the chunks until writable.uncork() is called, which will pass them +all to writable._writev(), if present. This prevents a head-of-line blocking +situation where data is being buffered while waiting for the first small chunk +to be processed. However, use of writable.cork() without implementingwritable._writev() may have an adverse effect on throughput.

      +

      See also: writable.uncork(), writable._writev().

      +

      Returns void

      Since

      v0.11.2

      +

    destroy

    • destroy(error?): this

    • Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable stream will release any internal resources and subsequent calls to push()will be ignored.

      Once destroy() has been called any further calls will be a no-op and no further errors except from _destroy() may be emitted as 'error'.

      Implementors should not override this method, but instead implement readable._destroy().

      -

      Parameters

      • Optional error: Error

        Error which will be passed as payload in 'error' event

        -

      Returns this

      Since

      v8.0.0

      +

      Parameters

      • Optionalerror: Error

        Error which will be passed as payload in 'error' event

        +

      Returns this

      Since

      v8.0.0

    drop

    • drop(limit, options?): Readable

    • This method returns a new stream with the first limit chunks dropped from the start.

      Parameters

      • limit: number

        the number of chunks to drop from the readable.

        -
      • Optional options: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream with limit chunks dropped from the start.

      -

      Since

      v17.5.0

      -

    emit

    • emit(event): boolean

    • Parameters

      • event: "close"

      Returns boolean

    • emit(event, chunk): boolean

    • Parameters

      • event: "data"
      • chunk: any

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "drain"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "end"

      Returns boolean

    • emit(event, err): boolean

    • Parameters

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "finish"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "pause"

      Returns boolean

    • emit(event, src): boolean

    • Parameters

      • event: "pipe"
      • src: Readable

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "readable"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "resume"

      Returns boolean

    • emit(event, src): boolean

    • Parameters

      • event: "unpipe"
      • src: Readable

      Returns boolean

    • emit(event, ...args): boolean

    • Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

    end

    • end(cb?): this

    • Parameters

      • Optional cb: (() => void)
          • (): void

          • Returns void

      Returns this

    • end(chunk, cb?): this

    • Parameters

      • chunk: any
      • Optional cb: (() => void)
          • (): void

          • Returns void

      Returns this

    • end(chunk, encoding?, cb?): this

    • Parameters

      • chunk: any
      • Optional encoding: BufferEncoding
      • Optional cb: (() => void)
          • (): void

          • Returns void

      Returns this

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered +

    • Optionaloptions: Pick<ArrayOptions, "signal">

    Returns Readable

    a stream with limit chunks dropped from the start.

    +

    Since

    v17.5.0

    +

    emit

    • emit(event): boolean

    • Parameters

      • event: "close"

      Returns boolean

    • emit(event, chunk): boolean

    • Parameters

      • event: "data"
      • chunk: any

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "drain"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "end"

      Returns boolean

    • emit(event, err): boolean

    • Parameters

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "finish"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "pause"

      Returns boolean

    • emit(event, src): boolean

    • Parameters

      • event: "pipe"
      • src: Readable

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "readable"

      Returns boolean

    • emit(event): boolean

    • Parameters

      • event: "resume"

      Returns boolean

    • emit(event, src): boolean

    • Parameters

      • event: "unpipe"
      • src: Readable

      Returns boolean

    • emit(event, ...args): boolean

    • Parameters

      • event: string | symbol
      • Rest...args: any[]

      Returns boolean

    end

    • end(cb?): this

    • Calling the writable.end() method signals that no more data will be written +to the Writable. The optional chunk and encoding arguments allow one +final additional chunk of data to be written immediately before closing the +stream.

      +

      Calling the write method after calling end will raise an error.

      +
      // Write 'hello, ' and then end with 'world!'.
      const fs = require('node:fs');
      const file = fs.createWriteStream('example.txt');
      file.write('hello, ');
      file.end('world!');
      // Writing more now is not allowed!
+
      + +

      Parameters

      • Optionalcb: (() => void)
          • (): void

          • Returns void

      Returns this

      Since

      v0.9.4

      +
    • end(chunk, cb?): this

    • Calling the writable.end() method signals that no more data will be written +to the Writable. The optional chunk and encoding arguments allow one +final additional chunk of data to be written immediately before closing the +stream.

      +

      Calling the write method after calling end will raise an error.

      +
      // Write 'hello, ' and then end with 'world!'.
      const fs = require('node:fs');
      const file = fs.createWriteStream('example.txt');
      file.write('hello, ');
      file.end('world!');
      // Writing more now is not allowed!
+
      + +

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any +JavaScript value other than null.

        +
      • Optionalcb: (() => void)
          • (): void

          • Returns void

      Returns this

      Since

      v0.9.4

      +
    • end(chunk, encoding?, cb?): this

    • Calling the writable.end() method signals that no more data will be written +to the Writable. The optional chunk and encoding arguments allow one +final additional chunk of data to be written immediately before closing the +stream.

      +

      Calling the write method after calling end will raise an error.

      +
      // Write 'hello, ' and then end with 'world!'.
      const fs = require('node:fs');
      const file = fs.createWriteStream('example.txt');
      file.write('hello, ');
      file.end('world!');
      // Writing more now is not allowed!
+
      + +

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any +JavaScript value other than null.

        +
      • Optionalencoding: BufferEncoding

        The encoding if chunk is a string

        +
      • Optionalcb: (() => void)
          • (): void

          • Returns void

      Returns this

      Since

      v0.9.4

      +

    eventNames

    • eventNames(): (string | symbol)[]

    • Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

      -
      import { EventEmitter } from 'node:events';

      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
      -

      Returns (string | symbol)[]

      Since

      v6.0.0

      +
      import { EventEmitter } from 'node:events';

      const myEE = new EventEmitter();
      myEE.on('foo', () => {});
      myEE.on('bar', () => {});

      const sym = Symbol('symbol');
      myEE.on(sym, () => {});

      console.log(myEE.eventNames());
      // Prints: [ 'foo', 'bar', Symbol(symbol) ]
+
      + +

      Returns (string | symbol)[]

      Since

      v6.0.0

    every

    • every(fn, options?): Promise<boolean>

    • This method is similar to Array.prototype.every and calls fn on each chunk in the stream to check if all awaited return values are truthy value for fn. Once an fn call on a chunk awaited return value is falsy, the stream is destroyed and the promise is fulfilled with false. If all of the fn calls on the chunks return a truthy value, the promise is fulfilled with true.

      -

      Parameters

      • fn: ((data, options?) => boolean | Promise<boolean>)

        a function to call on each chunk of the stream. Async or not.

        -
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optional options: ArrayOptions

      Returns Promise<boolean>

      a promise evaluating to true if fn returned a truthy value for every one of the chunks.

      -

      Since

      v17.5.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)

        a function to call on each chunk of the stream. Async or not.

        +
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optionaloptions: ArrayOptions

      Returns Promise<boolean>

      a promise evaluating to true if fn returned a truthy value for every one of the chunks.

      +

      Since

      v17.5.0

    filter

    • filter(fn, options?): Readable

    • This method allows filtering the stream. For each chunk in the stream the fn function will be called and if it returns a truthy value, the chunk will be passed to the result stream. If the fn function returns a promise - that promise will be awaited.

      -

      Parameters

      • fn: ((data, options?) => boolean | Promise<boolean>)

        a function to filter chunks from the stream. Async or not.

        -
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optional options: ArrayOptions

      Returns Readable

      a stream filtered with the predicate fn.

      -

      Since

      v17.4.0, v16.14.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)

        a function to filter chunks from the stream. Async or not.

        +
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream filtered with the predicate fn.

      +

      Since

      v17.4.0, v16.14.0

    find

    • find<T>(fn, options?): Promise<T>

    • This method is similar to Array.prototype.find and calls fn on each chunk in the stream to find a chunk with a truthy value for fn. Once an fn call's awaited return value is truthy, the stream is destroyed and the promise is fulfilled with value for which fn returned a truthy value. If all of the fn calls on the chunks return a falsy value, the promise is fulfilled with undefined.

      -

      Type Parameters

      • T

      Parameters

      • fn: ((data, options?) => data is T)

        a function to call on each chunk of the stream. Async or not.

        -
          • (data, options?): data is T

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns data is T

      • Optional options: ArrayOptions

      Returns Promise<T>

      a promise evaluating to the first chunk for which fn evaluated with a truthy value, +

    Type Parameters

    • T

    Parameters

    • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => data is T)

      a function to call on each chunk of the stream. Async or not.

      +
        • (data, options?): data is T

        • Parameters

          • data: any
          • Optionaloptions: Pick<ArrayOptions, "signal">

          Returns data is T

    • Optionaloptions: ArrayOptions

    Returns Promise<T>

    a promise evaluating to the first chunk for which fn evaluated with a truthy value, or undefined if no element was found.

    -

    Since

    v17.5.0

    -
  • find(fn, options?): Promise<any>

  • Parameters

    • fn: ((data, options?) => boolean | Promise<boolean>)
        • (data, options?): boolean | Promise<boolean>

        • Parameters

          • data: any
          • Optional options: Pick<ArrayOptions, "signal">

          Returns boolean | Promise<boolean>

    • Optional options: ArrayOptions

    Returns Promise<any>

    • flatMap

    • flatMap(fn, options?): Readable

    • This method returns a new stream by applying the given callback to each chunk of the stream +

      Since

      v17.5.0

      +
    • find(fn, options?): Promise<any>

    • Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optionaloptions: ArrayOptions

      Returns Promise<any>

    flatMap

    • flatMap(fn, options?): Readable

    • This method returns a new stream by applying the given callback to each chunk of the stream and then flattening the result.

      It is possible to return a stream or another iterable or async iterable from fn and the result streams will be merged (flattened) into the returned stream.

      -

      Parameters

      • fn: ((data, options?) => any)

        a function to map over every chunk in the stream. May be async. May be a stream or generator.

        -
          • (data, options?): any

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns any

      • Optional options: ArrayOptions

      Returns Readable

      a stream flat-mapped with the function fn.

      -

      Since

      v17.5.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => any)

        a function to map over every chunk in the stream. May be async. May be a stream or generator.

        +
          • (data, options?): any

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns any

      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream flat-mapped with the function fn.

      +

      Since

      v17.5.0

    forEach

    • forEach(fn, options?): Promise<void>

    • This method allows iterating a stream. For each chunk in the stream the fn function will be called. If the fn function returns a promise - that promise will be awaited.

      This method is different from for await...of loops in that it can optionally process chunks concurrently. @@ -164,54 +339,58 @@ In either case the stream will be destroyed.

      This method is different from listening to the 'data' event in that it uses the readable event in the underlying machinary and can limit the number of concurrent fn calls.

      -

      Parameters

      • fn: ((data, options?) => void | Promise<void>)

        a function to call on each chunk of the stream. Async or not.

        -
          • (data, options?): void | Promise<void>

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns void | Promise<void>

      • Optional options: ArrayOptions

      Returns Promise<void>

      a promise for when the stream has finished.

      -

      Since

      v17.5.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => void | Promise<void>)

        a function to call on each chunk of the stream. Async or not.

        +
          • (data, options?): void | Promise<void>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns void | Promise<void>

      • Optionaloptions: ArrayOptions

      Returns Promise<void>

      a promise for when the stream has finished.

      +

      Since

      v17.5.0

    getMaxListeners

    • getMaxListeners(): number

    • Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

      -

      Returns number

      Since

      v1.0.0

      +

      Returns number

      Since

      v1.0.0

    isPaused

    • isPaused(): boolean

    • The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most typical cases, there will be no reason to use this method directly.

      -
      const readable = new stream.Readable();

      readable.isPaused(); // === false
      readable.pause();
      readable.isPaused(); // === true
      readable.resume();
      readable.isPaused(); // === false
-
      -

      Returns boolean

      Since

      v0.11.14

      +
      const readable = new stream.Readable();

      readable.isPaused(); // === false
      readable.pause();
      readable.isPaused(); // === true
      readable.resume();
      readable.isPaused(); // === false
+
      + +

      Returns boolean

      Since

      v0.11.14

    iterator

    • iterator(options?): AsyncIterableIterator<any>

    • The iterator created by this method gives users the option to cancel the destruction of the stream if the for await...of loop is exited by return, break, or throw, or if the iterator should destroy the stream if the stream emitted an error during iteration.

      -

      Parameters

      • Optional options: {
            destroyOnReturn?: boolean;
        }
        • Optional destroyOnReturn?: boolean

          When set to false, calling return on the async iterator, +

          Parameters

          • Optionaloptions: {
                destroyOnReturn?: boolean;
            }
            • OptionaldestroyOnReturn?: boolean

              When set to false, calling return on the async iterator, or exiting a for await...of iteration using a break, return, or throw will not destroy the stream. Default: true.

              -

          Returns AsyncIterableIterator<any>

          Since

          v16.3.0

          +

      Returns AsyncIterableIterator<any>

      Since

      v16.3.0

    listenerCount

    • listenerCount(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

        -
      • Optional listener: Function

        The event handler function

        -

      Returns number

      Since

      v3.2.0

      +
    • Optionallistener: Function

      The event handler function

      +

    Returns number

    Since

    v3.2.0

    listeners

    • listeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      -
      server.on('connection', (stream) => {
        console.log('someone connected!');
      });
      console.log(util.inspect(server.listeners('connection')));
      // Prints: [ [Function] ]
-
      -

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v0.1.26

      +
      server.on('connection', (stream) => {
        console.log('someone connected!');
      });
      console.log(util.inspect(server.listeners('connection')));
      // Prints: [ [Function] ]
+
      + +

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v0.1.26

    map

    • map(fn, options?): Readable

    • This method allows mapping over the stream. The fn function will be called for every chunk in the stream. If the fn function returns a promise - that promise will be awaited before being passed to the result stream.

      -

      Parameters

      • fn: ((data, options?) => any)

        a function to map over every chunk in the stream. Async or not.

        -
          • (data, options?): any

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns any

      • Optional options: ArrayOptions

      Returns Readable

      a stream mapped with the function fn.

      -

      Since

      v17.4.0, v16.14.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => any)

        a function to map over every chunk in the stream. Async or not.

        +
          • (data, options?): any

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns any

      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream mapped with the function fn.

      +

      Since

      v17.4.0, v16.14.0

    off

    • off(eventName, listener): this

    • Alias for emitter.removeListener().

      -

      Parameters

      • eventName: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

      Since

      v10.0.0

      -

    on

    • on(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    once

    • once(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    pause

    • pause(): this

    • The readable.pause() method will cause a stream in flowing mode to stop +

      Parameters

      • eventName: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

      Since

      v10.0.0

      +

    on

    • on(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • on(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    once

    • once(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • once(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    pause

    • pause(): this

    • The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

      -
      const readable = getReadableStreamSomehow();
      readable.on('data', (chunk) => {
        console.log(`Received ${chunk.length} bytes of data.`);
        readable.pause();
        console.log('There will be no additional data for 1 second.');
        setTimeout(() => {
          console.log('Now data will start flowing again.');
          readable.resume();
        }, 1000);
      });
-
      +
      const readable = getReadableStreamSomehow();
      readable.on('data', (chunk) => {
        console.log(`Received ${chunk.length} bytes of data.`);
        readable.pause();
        console.log('There will be no additional data for 1 second.');
        setTimeout(() => {
          console.log('Now data will start flowing again.');
          readable.resume();
        }, 1000);
      });
+
      +

      The readable.pause() method has no effect if there is a 'readable'event listener.

      -

      Returns this

      Since

      v0.9.4

      -

    pipe

    • pipe<T>(destination, options?): T

    • Type Parameters

      • T extends WritableStream

      Parameters

      • destination: T
      • Optional options: {
            end?: boolean;
        }
        • Optional end?: boolean

      Returns T

    prependListener

    • prependListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    prependOnceListener

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    push

    • push(chunk, encoding?): boolean

    • Parameters

      • chunk: any
      • Optional encoding: BufferEncoding

      Returns boolean

    rawListeners

    • rawListeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName, +

      Returns this

      Since

      v0.9.4

      +

    pipe

    • pipe<T>(destination, options?): T

    • Type Parameters

      • T extends WritableStream

      Parameters

      • destination: T
      • Optionaloptions: {
            end?: boolean;
        }
        • Optionalend?: boolean

      Returns T

    prependListener

    • prependListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    prependOnceListener

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • prependOnceListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    push

    • push(chunk, encoding?): boolean

    • Parameters

      • chunk: any
      • Optionalencoding: BufferEncoding

      Returns boolean

    rawListeners

    • rawListeners(eventName): Function[]

    • Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

      -
      import { EventEmitter } from 'node:events';
      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');
-
      -

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v9.4.0

      +
      import { EventEmitter } from 'node:events';
      const emitter = new EventEmitter();
      emitter.once('log', () => console.log('log once'));

      // Returns a new Array with a function `onceWrapper` which has a property
      // `listener` which contains the original listener bound above
      const listeners = emitter.rawListeners('log');
      const logFnWrapper = listeners[0];

      // Logs "log once" to the console and does not unbind the `once` event
      logFnWrapper.listener();

      // Logs "log once" to the console and removes the listener
      logFnWrapper();

      emitter.on('log', () => console.log('log persistently'));
      // Will return a new Array with a single function bound by `.on()` above
      const newListeners = emitter.rawListeners('log');

      // Logs "log persistently" twice
      newListeners[0]();
      emitter.emit('log');
+
      + +

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v9.4.0

    read

    • read(size?): any

    • The readable.read() method reads data out of the internal buffer and returns it. If no data is available to be read, null is returned. By default, the data is returned as a Buffer object unless an encoding has been @@ -226,8 +405,9 @@

      The readable.read() method should only be called on Readable streams operating in paused mode. In flowing mode, readable.read() is called automatically until the internal buffer is fully drained.

      -
      const readable = getReadableStreamSomehow();

      // 'readable' may be triggered multiple times as data is buffered in
      readable.on('readable', () => {
        let chunk;
        console.log('Stream is readable (new data received in buffer)');
        // Use a loop to make sure we read all currently available data
        while (null !== (chunk = readable.read())) {
          console.log(`Read ${chunk.length} bytes of data...`);
        }
      });

      // 'end' will be triggered once when there is no more data available
      readable.on('end', () => {
        console.log('Reached end of stream.');
      });
-
      +
      const readable = getReadableStreamSomehow();

      // 'readable' may be triggered multiple times as data is buffered in
      readable.on('readable', () => {
        let chunk;
        console.log('Stream is readable (new data received in buffer)');
        // Use a loop to make sure we read all currently available data
        while (null !== (chunk = readable.read())) {
          console.log(`Read ${chunk.length} bytes of data...`);
        }
      });

      // 'end' will be triggered once when there is no more data available
      readable.on('end', () => {
        console.log('Reached end of stream.');
      });
+
      +

      Each call to readable.read() returns a chunk of data, or null. The chunks are not concatenated. A while loop is necessary to consume all data currently in the buffer. When reading a large file .read() may return null, @@ -237,41 +417,46 @@ emitted when there is no more data to come.

      Therefore to read a file's whole contents from a readable, it is necessary to collect chunks across multiple 'readable' events:

      -
      const chunks = [];

      readable.on('readable', () => {
        let chunk;
        while (null !== (chunk = readable.read())) {
          chunks.push(chunk);
        }
      });

      readable.on('end', () => {
        const content = chunks.join('');
      });
-
      +
      const chunks = [];

      readable.on('readable', () => {
        let chunk;
        while (null !== (chunk = readable.read())) {
          chunks.push(chunk);
        }
      });

      readable.on('end', () => {
        const content = chunks.join('');
      });
+
      +

      A Readable stream in object mode will always return a single item from a call to readable.read(size), regardless of the value of thesize argument.

      If the readable.read() method returns a chunk of data, a 'data' event will also be emitted.

      Calling read after the 'end' event has been emitted will return null. No runtime error will be raised.

      -

      Parameters

      • Optional size: number

        Optional argument to specify how much data to read.

        -

      Returns any

      Since

      v0.9.4

      +

      Parameters

      • Optionalsize: number

        Optional argument to specify how much data to read.

        +

      Returns any

      Since

      v0.9.4

    reduce

    • reduce<T>(fn, initial?, options?): Promise<T>

    • This method calls fn on each chunk of the stream in order, passing it the result from the calculation on the previous element. It returns a promise for the final value of the reduction.

      If no initial value is supplied the first chunk of the stream is used as the initial value. If the stream is empty, the promise is rejected with a TypeError with the ERR_INVALID_ARGS code property.

      The reducer function iterates the stream element-by-element which means that there is no concurrency parameter or parallelism. To perform a reduce concurrently, you can extract the async function to readable.map method.

      -

      Type Parameters

      • T = any

      Parameters

      • fn: ((previous, data, options?) => T)

        a reducer function to call over every chunk in the stream. Async or not.

        -
          • (previous, data, options?): T

          • Parameters

            • previous: any
            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns T

      • Optional initial: undefined

        the initial value to use in the reduction.

        -
      • Optional options: Pick<ArrayOptions, "signal">

      Returns Promise<T>

      a promise for the final value of the reduction.

      -

      Since

      v17.5.0

      -
    • reduce<T>(fn, initial, options?): Promise<T>

    • Type Parameters

      • T = any

      Parameters

      • fn: ((previous, data, options?) => T)
          • (previous, data, options?): T

          • Parameters

            • previous: T
            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns T

      • initial: T
      • Optional options: Pick<ArrayOptions, "signal">

      Returns Promise<T>

    removeAllListeners

    • removeAllListeners(event?): this

    • Removes all listeners, or those of the specified eventName.

      +

      Type Parameters

      • T = any

      Parameters

      • fn: ((previous: any, data: any, options?: Pick<ArrayOptions, "signal">) => T)

        a reducer function to call over every chunk in the stream. Async or not.

        +
          • (previous, data, options?): T

          • Parameters

            • previous: any
            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns T

      • Optionalinitial: undefined

        the initial value to use in the reduction.

        +
      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Promise<T>

      a promise for the final value of the reduction.

      +

      Since

      v17.5.0

      +
    • reduce<T>(fn, initial, options?): Promise<T>

    • Type Parameters

      • T = any

      Parameters

      • fn: ((previous: T, data: any, options?: Pick<ArrayOptions, "signal">) => T)
          • (previous, data, options?): T

          • Parameters

            • previous: T
            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns T

      • initial: T
      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Promise<T>

    removeAllListeners

    • removeAllListeners(event?): this

    • Removes all listeners, or those of the specified eventName.

      It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

      Returns a reference to the EventEmitter, so that calls can be chained.

      -

      Parameters

      • Optional event: string | symbol

      Returns this

      Since

      v0.1.26

      -

    removeListener

    • removeListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args) => void)
          • (...args): void

          • Parameters

            • Rest ...args: any[]

            Returns void

      Returns this

    resume

    • resume(): this

    • The readable.resume() method causes an explicitly paused Readable stream to +

      Parameters

      • Optionalevent: string | symbol

      Returns this

      Since

      v0.1.26

      +

    removeListener

    • removeListener(event, listener): this

    • Parameters

      • event: "close"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "data"
      • listener: ((chunk: any) => void)
          • (chunk): void

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "drain"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "end"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "error"
      • listener: ((err: Error) => void)
          • (err): void

          • Parameters

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "finish"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "pause"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "pipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "readable"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "resume"
      • listener: (() => void)
          • (): void

          • Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: "unpipe"
      • listener: ((src: Readable) => void)
          • (src): void

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • removeListener(event, listener): this

    • Parameters

      • event: string | symbol
      • listener: ((...args: any[]) => void)
          • (...args): void

          • Parameters

            • Rest...args: any[]

            Returns void

      Returns this

    resume

    • resume(): this

    • The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

      The readable.resume() method can be used to fully consume the data from a stream without actually processing any of that data:

      -
      getReadableStreamSomehow()
        .resume()
        .on('end', () => {
          console.log('Reached the end, but did not read anything.');
        });
-
      +
      getReadableStreamSomehow()
        .resume()
        .on('end', () => {
          console.log('Reached the end, but did not read anything.');
        });
+
      +

      The readable.resume() method has no effect if there is a 'readable'event listener.

      -

      Returns this

      Since

      v0.9.4

      -

    setDefaultEncoding

    • setDefaultEncoding(encoding): this

    • Parameters

      • encoding: BufferEncoding

      Returns this

    setEncoding

    • setEncoding(encoding): this

    • The readable.setEncoding() method sets the character encoding for +

      Returns this

      Since

      v0.9.4

      +

    setDefaultEncoding

    • setDefaultEncoding(encoding): this

    • The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

      +

      Parameters

      • encoding: BufferEncoding

        The new default encoding

        +

      Returns this

      Since

      v0.11.15

      +

    setEncoding

    • setEncoding(encoding): this

    • The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

      By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the @@ -280,41 +465,58 @@

      The Readable stream will properly handle multi-byte characters delivered through the stream that would otherwise become improperly decoded if simply pulled from the stream as Buffer objects.

      -
      const readable = getReadableStreamSomehow();
      readable.setEncoding('utf8');
      readable.on('data', (chunk) => {
        assert.equal(typeof chunk, 'string');
        console.log('Got %d characters of string data:', chunk.length);
      });
-
      +
      const readable = getReadableStreamSomehow();
      readable.setEncoding('utf8');
      readable.on('data', (chunk) => {
        assert.equal(typeof chunk, 'string');
        console.log('Got %d characters of string data:', chunk.length);
      });
+
      +

      Parameters

      • encoding: BufferEncoding

        The encoding to use.

        -

      Returns this

      Since

      v0.9.4

      +

    Returns this

    Since

    v0.9.4

    setMaxListeners

    • setMaxListeners(n): this

    • By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

      Returns a reference to the EventEmitter, so that calls can be chained.

      -

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

      +

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

    some

    • some(fn, options?): Promise<boolean>

    • This method is similar to Array.prototype.some and calls fn on each chunk in the stream until the awaited return value is true (or any truthy value). Once an fn call on a chunk awaited return value is truthy, the stream is destroyed and the promise is fulfilled with true. If none of the fn calls on the chunks return a truthy value, the promise is fulfilled with false.

      -

      Parameters

      • fn: ((data, options?) => boolean | Promise<boolean>)

        a function to call on each chunk of the stream. Async or not.

        -
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optional options: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optional options: ArrayOptions

      Returns Promise<boolean>

      a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

      -

      Since

      v17.5.0

      +

      Parameters

      • fn: ((data: any, options?: Pick<ArrayOptions, "signal">) => boolean | Promise<boolean>)

        a function to call on each chunk of the stream. Async or not.

        +
          • (data, options?): boolean | Promise<boolean>

          • Parameters

            • data: any
            • Optionaloptions: Pick<ArrayOptions, "signal">

            Returns boolean | Promise<boolean>

      • Optionaloptions: ArrayOptions

      Returns Promise<boolean>

      a promise evaluating to true if fn returned a truthy value for at least one of the chunks.

      +

      Since

      v17.5.0

    take

    • take(limit, options?): Readable

    • This method returns a new stream with the first limit chunks.

      Parameters

      • limit: number

        the number of chunks to take from the readable.

        -
      • Optional options: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream with limit chunks taken.

      -

      Since

      v17.5.0

      +
    • Optionaloptions: Pick<ArrayOptions, "signal">

    Returns Readable

    a stream with limit chunks taken.

    +

    Since

    v17.5.0

    toArray

    • toArray(options?): Promise<any[]>

    • This method allows easily obtaining the contents of a stream.

      As this method reads the entire stream into memory, it negates the benefits of streams. It's intended for interoperability and convenience, not as the primary way to consume streams.

      -

      Parameters

      • Optional options: Pick<ArrayOptions, "signal">

      Returns Promise<any[]>

      a promise containing an array with the contents of the stream.

      -

      Since

      v17.5.0

      -

    uncork

    • uncork(): void

    • Returns void

    unpipe

    • unpipe(destination?): this

    • The readable.unpipe() method detaches a Writable stream previously attached +

      Parameters

      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Promise<any[]>

      a promise containing an array with the contents of the stream.

      +

      Since

      v17.5.0

      +

    uncork

    • uncork(): void

    • The writable.uncork() method flushes all data buffered since cork was called.

      +

      When using writable.cork() and writable.uncork() to manage the buffering +of writes to a stream, defer calls to writable.uncork() usingprocess.nextTick(). Doing so allows batching of allwritable.write() calls that occur within a given Node.js event +loop phase.

      +
      stream.cork();
      stream.write('some ');
      stream.write('data ');
      process.nextTick(() => stream.uncork());
+
      + +

      If the writable.cork() method is called multiple times on a stream, the +same number of calls to writable.uncork() must be called to flush the buffered +data.

      +
      stream.cork();
      stream.write('some ');
      stream.cork();
      stream.write('data ');
      process.nextTick(() => {
        stream.uncork();
        // The data will not be flushed until uncork() is called a second time.
        stream.uncork();
      });
+
      + +

      See also: writable.cork().

      +

      Returns void

      Since

      v0.11.2

      +

    unpipe

    • unpipe(destination?): this

    • The readable.unpipe() method detaches a Writable stream previously attached using the pipe method.

      If the destination is not specified, then all pipes are detached.

      If the destination is specified, but no pipe is set up for it, then the method does nothing.

      -
      const fs = require('node:fs');
      const readable = getReadableStreamSomehow();
      const writable = fs.createWriteStream('file.txt');
      // All the data from readable goes into 'file.txt',
      // but only for the first second.
      readable.pipe(writable);
      setTimeout(() => {
        console.log('Stop writing to file.txt.');
        readable.unpipe(writable);
        console.log('Manually close the file stream.');
        writable.end();
      }, 1000);
-
      -

      Parameters

      • Optional destination: WritableStream

        Optional specific stream to unpipe

        -

      Returns this

      Since

      v0.9.4

      +
      const fs = require('node:fs');
      const readable = getReadableStreamSomehow();
      const writable = fs.createWriteStream('file.txt');
      // All the data from readable goes into 'file.txt',
      // but only for the first second.
      readable.pipe(writable);
      setTimeout(() => {
        console.log('Stop writing to file.txt.');
        readable.unpipe(writable);
        console.log('Manually close the file stream.');
        writable.end();
      }, 1000);
+
      + +

      Parameters

      • Optionaldestination: WritableStream

        Optional specific stream to unpipe

        +

      Returns this

      Since

      v0.9.4

    unshift

    • unshift(chunk, encoding?): void

    • Passing chunk as null signals the end of the stream (EOF) and behaves the same as readable.push(null), after which no more data can be written. The EOF signal is put at the end of the buffer and any buffered data will still be @@ -327,8 +529,9 @@ has been emitted or a runtime error will be thrown.

      Developers using stream.unshift() often should consider switching to use of a Transform stream instead. See the API for stream implementers section for more information.

      -
      // Pull off a header delimited by \n\n.
      // Use unshift() if we get too much.
      // Call the callback with (error, header, stream).
      const { StringDecoder } = require('node:string_decoder');
      function parseHeader(stream, callback) {
        stream.on('error', callback);
        stream.on('readable', onReadable);
        const decoder = new StringDecoder('utf8');
        let header = '';
        function onReadable() {
          let chunk;
          while (null !== (chunk = stream.read())) {
            const str = decoder.write(chunk);
            if (str.includes('\n\n')) {
              // Found the header boundary.
              const split = str.split(/\n\n/);
              header += split.shift();
              const remaining = split.join('\n\n');
              const buf = Buffer.from(remaining, 'utf8');
              stream.removeListener('error', callback);
              // Remove the 'readable' listener before unshifting.
              stream.removeListener('readable', onReadable);
              if (buf.length)
                stream.unshift(buf);
              // Now the body of the message can be read from the stream.
              callback(null, header, stream);
              return;
            }
            // Still reading the header.
            header += str;
          }
        }
      }
-
      +
      // Pull off a header delimited by \n\n.
      // Use unshift() if we get too much.
      // Call the callback with (error, header, stream).
      const { StringDecoder } = require('node:string_decoder');
      function parseHeader(stream, callback) {
        stream.on('error', callback);
        stream.on('readable', onReadable);
        const decoder = new StringDecoder('utf8');
        let header = '';
        function onReadable() {
          let chunk;
          while (null !== (chunk = stream.read())) {
            const str = decoder.write(chunk);
            if (str.includes('\n\n')) {
              // Found the header boundary.
              const split = str.split(/\n\n/);
              header += split.shift();
              const remaining = split.join('\n\n');
              const buf = Buffer.from(remaining, 'utf8');
              stream.removeListener('error', callback);
              // Remove the 'readable' listener before unshifting.
              stream.removeListener('readable', onReadable);
              if (buf.length)
                stream.unshift(buf);
              // Now the body of the message can be read from the stream.
              callback(null, header, stream);
              return;
            }
            // Still reading the header.
            header += str;
          }
        }
      }
+
      +

      Unlike push, stream.unshift(chunk) will not end the reading process by resetting the internal reading state of the stream. This can cause unexpected results if readable.unshift() is called during a @@ -338,8 +541,8 @@ process of performing a read.

      Parameters

      • chunk: any

        Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array, or null. For object mode streams, chunk may be any JavaScript value.

        -
      • Optional encoding: BufferEncoding

        Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

        -

      Returns void

      Since

      v0.9.11

      +
    • Optionalencoding: BufferEncoding

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      +

    Returns void

    Since

    v0.9.11

    wrap

    • wrap(stream): this

    • Prior to Node.js 0.10, streams did not implement the entire node:streammodule API as it is currently defined. (See Compatibility for more information.)

      When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable @@ -348,11 +551,83 @@

      It will rarely be necessary to use readable.wrap() but the method has been provided as a convenience for interacting with older Node.js applications and libraries.

      -
      const { OldReader } = require('./old-api-module.js');
      const { Readable } = require('node:stream');
      const oreader = new OldReader();
      const myReader = new Readable().wrap(oreader);

      myReader.on('readable', () => {
        myReader.read(); // etc.
      });
-
      +
      const { OldReader } = require('./old-api-module.js');
      const { Readable } = require('node:stream');
      const oreader = new OldReader();
      const myReader = new Readable().wrap(oreader);

      myReader.on('readable', () => {
        myReader.read(); // etc.
      });
+
      +

      Parameters

      • stream: ReadableStream

        An "old style" readable stream

        -

      Returns this

      Since

      v0.9.4

      -

    write

    • write(chunk, encoding?, cb?): boolean

    • Parameters

      • chunk: any
      • Optional encoding: BufferEncoding
      • Optional cb: ((error) => void)
          • (error): void

          • Parameters

            Returns void

      Returns boolean

    • write(chunk, cb?): boolean

    • Parameters

      • chunk: any
      • Optional cb: ((error) => void)
          • (error): void

          • Parameters

            Returns void

      Returns boolean

    Static addAbortListener

    • addAbortListener(signal, resource): Disposable
    • Experimental

      Listens once to the abort event on the provided signal.

      +

    Returns this

    Since

    v0.9.4

    +

    write

    • write(chunk, encoding?, cb?): boolean

    • The writable.write() method writes some data to the stream, and calls the +supplied callback once the data has been fully handled. If an error +occurs, the callback will be called with the error as its +first argument. The callback is called asynchronously and before 'error' is +emitted.

      +

      The return value is true if the internal buffer is less than thehighWaterMark configured when the stream was created after admitting chunk. +If false is returned, further attempts to write data to the stream should +stop until the 'drain' event is emitted.

      +

      While a stream is not draining, calls to write() will buffer chunk, and +return false. Once all currently buffered chunks are drained (accepted for +delivery by the operating system), the 'drain' event will be emitted. +Once write() returns false, do not write more chunks +until the 'drain' event is emitted. While calling write() on a stream that +is not draining is allowed, Node.js will buffer all written chunks until +maximum memory usage occurs, at which point it will abort unconditionally. +Even before it aborts, high memory usage will cause poor garbage collector +performance and high RSS (which is not typically released back to the system, +even after the memory is no longer required). Since TCP sockets may never +drain if the remote peer does not read the data, writing a socket that is +not draining may lead to a remotely exploitable vulnerability.

      +

      Writing data while the stream is not draining is particularly +problematic for a Transform, because the Transform streams are paused +by default until they are piped or a 'data' or 'readable' event handler +is added.

      +

      If the data to be written can be generated or fetched on demand, it is +recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is +possible to respect backpressure and avoid memory issues using the 'drain' event:

      +
      function write(data, cb) {
        if (!stream.write(data)) {
          stream.once('drain', cb);
        } else {
          process.nextTick(cb);
        }
      }

      // Wait for cb to be called before doing any other write.
      write('hello', () => {
        console.log('Write completed, do more writes now.');
      });
+
      + +

      A Writable stream in object mode will always ignore the encoding argument.

      +

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any +JavaScript value other than null.

        +
      • Optionalencoding: BufferEncoding

        The encoding, if chunk is a string.

        +
      • Optionalcb: ((error: Error) => void)
          • (error): void

          • Parameters

            Returns void

      Returns boolean

      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

      +

      Since

      v0.9.4

      +
    • write(chunk, cb?): boolean

    • The writable.write() method writes some data to the stream, and calls the +supplied callback once the data has been fully handled. If an error +occurs, the callback will be called with the error as its +first argument. The callback is called asynchronously and before 'error' is +emitted.

      +

      The return value is true if the internal buffer is less than thehighWaterMark configured when the stream was created after admitting chunk. +If false is returned, further attempts to write data to the stream should +stop until the 'drain' event is emitted.

      +

      While a stream is not draining, calls to write() will buffer chunk, and +return false. Once all currently buffered chunks are drained (accepted for +delivery by the operating system), the 'drain' event will be emitted. +Once write() returns false, do not write more chunks +until the 'drain' event is emitted. While calling write() on a stream that +is not draining is allowed, Node.js will buffer all written chunks until +maximum memory usage occurs, at which point it will abort unconditionally. +Even before it aborts, high memory usage will cause poor garbage collector +performance and high RSS (which is not typically released back to the system, +even after the memory is no longer required). Since TCP sockets may never +drain if the remote peer does not read the data, writing a socket that is +not draining may lead to a remotely exploitable vulnerability.

      +

      Writing data while the stream is not draining is particularly +problematic for a Transform, because the Transform streams are paused +by default until they are piped or a 'data' or 'readable' event handler +is added.

      +

      If the data to be written can be generated or fetched on demand, it is +recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is +possible to respect backpressure and avoid memory issues using the 'drain' event:

      +
      function write(data, cb) {
        if (!stream.write(data)) {
          stream.once('drain', cb);
        } else {
          process.nextTick(cb);
        }
      }

      // Wait for cb to be called before doing any other write.
      write('hello', () => {
        console.log('Write completed, do more writes now.');
      });
+
      + +

      A Writable stream in object mode will always ignore the encoding argument.

      +

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any +JavaScript value other than null.

        +
      • Optionalcb: ((error: Error) => void)
          • (error): void

          • Parameters

            Returns void

      Returns boolean

      false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

      +

      Since

      v0.9.4

      +

    StaticaddAbortListener

    • addAbortListener(signal, resource): Disposable
    • Experimental

      Listens once to the abort event on the provided signal.

      Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -362,11 +637,12 @@ two issues by listening to the event such that stopImmediatePropagation does not prevent the listener from running.

      Returns a disposable so that it may be unsubscribed from more easily.

      -
      import { addAbortListener } from 'node:events';

      function example(signal) {
        let disposable;
        try {
          signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
          disposable = addAbortListener(signal, (e) => {
            // Do something when signal is aborted.
          });
        } finally {
          disposable?.[Symbol.dispose]();
        }
      }
-
      -

      Parameters

      • signal: AbortSignal
      • resource: ((event) => void)
          • (event): void

          • Parameters

            Returns void

      Returns Disposable

      Disposable that removes the abort listener.

      -

      Since

      v20.5.0

      -

    Static from

    • from(src): Duplex

    • A utility method for creating duplex streams.

      +
      import { addAbortListener } from 'node:events';

      function example(signal) {
        let disposable;
        try {
          signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
          disposable = addAbortListener(signal, (e) => {
            // Do something when signal is aborted.
          });
        } finally {
          disposable?.[Symbol.dispose]();
        }
      }
+
      + +

      Parameters

      Returns Disposable

      Disposable that removes the abort listener.

      +

      Since

      v20.5.0

      +

    Staticfrom

    • from(src): Duplex

    • A utility method for creating duplex streams.

      • Stream converts writable stream into writable Duplex and readable stream to Duplex.
        • @@ -384,107 +660,141 @@ Duplex will write to the writable and read from the readable.
      • Promise converts into readable Duplex. Value null is ignored.
      -

      Parameters

      Returns Duplex

      Since

      v16.8.0

      -

    Static fromWeb

    • fromWeb(duplexStream, options?): Duplex
    • Experimental

      A utility method for creating a Duplex from a web ReadableStream and WritableStream.

      -

      Parameters

      • duplexStream: {
            readable: ReadableStream<any>;
            writable: WritableStream<any>;
        }
        • readable: ReadableStream<any>
        • writable: WritableStream<any>
      • Optional options: Pick<DuplexOptions, "signal" | "encoding" | "highWaterMark" | "objectMode" | "decodeStrings" | "allowHalfOpen">

      Returns Duplex

      Since

      v17.0.0

      -

    Static getEventListeners

    • getEventListeners(emitter, name): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      +

      Parameters

      Returns Duplex

      Since

      v16.8.0

      +

    StaticfromWeb

    • fromWeb(duplexStream, options?): Duplex
    • Experimental

      A utility method for creating a Duplex from a web ReadableStream and WritableStream.

      +

      Parameters

      • duplexStream: {
            readable: ReadableStream<any>;
            writable: WritableStream<any>;
        }
        • readable: ReadableStream<any>
        • writable: WritableStream<any>
      • Optionaloptions: Pick<DuplexOptions,
            | "signal"
            | "encoding"
            | "highWaterMark"
            | "objectMode"
            | "decodeStrings"
            | "allowHalfOpen">

      Returns Duplex

      Since

      v17.0.0

      +

    StaticgetEventListeners

    • getEventListeners(emitter, name): Function[]

    • Returns a copy of the array of listeners for the event named eventName.

      For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

      For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

      -
      import { getEventListeners, EventEmitter } from 'node:events';

      {
        const ee = new EventEmitter();
        const listener = () => console.log('Events are fun');
        ee.on('foo', listener);
        console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
      }
      {
        const et = new EventTarget();
        const listener = () => console.log('Events are fun');
        et.addEventListener('foo', listener);
        console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
      }
-
      -

      Parameters

      • emitter: EventEmitter | _DOMEventTarget
      • name: string | symbol

      Returns Function[]

      Since

      v15.2.0, v14.17.0

      -

    Static getMaxListeners

    • getMaxListeners(emitter): number

    • Returns the currently set max amount of listeners.

      +
      import { getEventListeners, EventEmitter } from 'node:events';

      {
        const ee = new EventEmitter();
        const listener = () => console.log('Events are fun');
        ee.on('foo', listener);
        console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
      }
      {
        const et = new EventTarget();
        const listener = () => console.log('Events are fun');
        et.addEventListener('foo', listener);
        console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
      }
+
      + +

      Parameters

      • emitter: EventEmitter | _DOMEventTarget
      • name: string | symbol

      Returns Function[]

      Since

      v15.2.0, v14.17.0

      +

    StaticgetMaxListeners

    • getMaxListeners(emitter): number

    • Returns the currently set max amount of listeners.

      For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

      For EventTargets this is the only way to get the max event listeners for the event target. If the number of event handlers on a single EventTarget exceeds the max set, the EventTarget will print a warning.

      -
      import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

      {
        const ee = new EventEmitter();
        console.log(getMaxListeners(ee)); // 10
        setMaxListeners(11, ee);
        console.log(getMaxListeners(ee)); // 11
      }
      {
        const et = new EventTarget();
        console.log(getMaxListeners(et)); // 10
        setMaxListeners(11, et);
        console.log(getMaxListeners(et)); // 11
      }
-
      -

      Parameters

      • emitter: EventEmitter | _DOMEventTarget

      Returns number

      Since

      v19.9.0

      -

    Static isDisturbed

    • isDisturbed(stream): boolean

    • Returns whether the stream has been read from or cancelled.

      -

      Parameters

      • stream: Readable | ReadableStream

      Returns boolean

      Since

      v16.8.0

      -

    Static listenerCount

    • listenerCount(emitter, eventName): number

    • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

      -
      import { EventEmitter, listenerCount } from 'node:events';

      const myEmitter = new EventEmitter();
      myEmitter.on('event', () => {});
      myEmitter.on('event', () => {});
      console.log(listenerCount(myEmitter, 'event'));
      // Prints: 2
-
      +
      import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

      {
        const ee = new EventEmitter();
        console.log(getMaxListeners(ee)); // 10
        setMaxListeners(11, ee);
        console.log(getMaxListeners(ee)); // 11
      }
      {
        const et = new EventTarget();
        console.log(getMaxListeners(et)); // 10
        setMaxListeners(11, et);
        console.log(getMaxListeners(et)); // 11
      }
+
      + +

      Parameters

      • emitter: EventEmitter | _DOMEventTarget

      Returns number

      Since

      v19.9.0

      +

    StaticisDisturbed

    • isDisturbed(stream): boolean

    • Returns whether the stream has been read from or cancelled.

      +

      Parameters

      • stream: Readable | ReadableStream

      Returns boolean

      Since

      v16.8.0

      +

    StaticlistenerCount

    • listenerCount(emitter, eventName): number

    • A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

      +
      import { EventEmitter, listenerCount } from 'node:events';

      const myEmitter = new EventEmitter();
      myEmitter.on('event', () => {});
      myEmitter.on('event', () => {});
      console.log(listenerCount(myEmitter, 'event'));
      // Prints: 2
+
      +

      Parameters

      • emitter: EventEmitter

        The emitter to query

      • eventName: string | symbol

        The event name

        -

      Returns number

      Since

      v0.9.12

      -

      Deprecated

      Since v3.2.0 - Use listenerCount instead.

      -

    Static on

    • on(emitter, eventName, options?): AsyncIterableIterator<any>
    • import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
-
      +

    Returns number

    Since

    v0.9.12

    +

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    +

    Staticon

    • on(emitter, eventName, options?): AsyncIterableIterator<any>
    • import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo')) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
+
      +

      Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

      An AbortSignal can be used to cancel waiting on events:

      -
      import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ac = new AbortController();

      (async () => {
        const ee = new EventEmitter();

        // Emit later on
        process.nextTick(() => {
          ee.emit('foo', 'bar');
          ee.emit('foo', 42);
        });

        for await (const event of on(ee, 'foo', { signal: ac.signal })) {
          // The execution of this inner block is synchronous and it
          // processes one event at a time (even with await). Do not use
          // if concurrent execution is required.
          console.log(event); // prints ['bar'] [42]
        }
        // Unreachable here
      })();

      process.nextTick(() => ac.abort());
-
      +
      import { on, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ac = new AbortController();

      (async () => {
        const ee = new EventEmitter();

        // Emit later on
        process.nextTick(() => {
          ee.emit('foo', 'bar');
          ee.emit('foo', 42);
        });

        for await (const event of on(ee, 'foo', { signal: ac.signal })) {
          // The execution of this inner block is synchronous and it
          // processes one event at a time (even with await). Do not use
          // if concurrent execution is required.
          console.log(event); // prints ['bar'] [42]
        }
        // Unreachable here
      })();

      process.nextTick(() => ac.abort());
+
      +

      Parameters

      • emitter: EventEmitter
      • eventName: string

        The name of the event being listened for

        -
      • Optional options: StaticEventEmitterOptions

      Returns AsyncIterableIterator<any>

      that iterates eventName events emitted by the emitter

      -

      Since

      v13.6.0, v12.16.0

      -

    Static once

    • once(emitter, eventName, options?): Promise<any[]>

    • Creates a Promise that is fulfilled when the EventEmitter emits the given +

    • Optionaloptions: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    +

    Since

    v13.6.0, v12.16.0

    +

    Staticonce

    • once(emitter, eventName, options?): Promise<any[]>

    • Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

      -

      This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event +

      This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

      -
      import { once, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.error('error happened', err);
      }
-
      +
      import { once, EventEmitter } from 'node:events';
      import process from 'node:process';

      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.error('error happened', err);
      }
+
      +

      The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

      -
      import { EventEmitter, once } from 'node:events';

      const ee = new EventEmitter();

      once(ee, 'error')
        .then(([err]) => console.log('ok', err.message))
        .catch((err) => console.error('error', err.message));

      ee.emit('error', new Error('boom'));

      // Prints: ok boom
-
      +
      import { EventEmitter, once } from 'node:events';

      const ee = new EventEmitter();

      once(ee, 'error')
        .then(([err]) => console.log('ok', err.message))
        .catch((err) => console.error('error', err.message));

      ee.emit('error', new Error('boom'));

      // Prints: ok boom
+
      +

      An AbortSignal can be used to cancel waiting for the event:

      -
      import { EventEmitter, once } from 'node:events';

      const ee = new EventEmitter();
      const ac = new AbortController();

      async function foo(emitter, event, signal) {
        try {
          await once(emitter, event, { signal });
          console.log('event emitted!');
        } catch (error) {
          if (error.name === 'AbortError') {
            console.error('Waiting for the event was canceled!');
          } else {
            console.error('There was an error', error.message);
          }
        }
      }

      foo(ee, 'foo', ac.signal);
      ac.abort(); // Abort waiting for the event
      ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
      -

      Parameters

      • emitter: _NodeEventTarget
      • eventName: string | symbol
      • Optional options: StaticEventEmitterOptions

      Returns Promise<any[]>

      Since

      v11.13.0, v10.16.0

      -
    • once(emitter, eventName, options?): Promise<any[]>

    • Parameters

      • emitter: _DOMEventTarget
      • eventName: string
      • Optional options: StaticEventEmitterOptions

      Returns Promise<any[]>

    Static setMaxListeners

    • setMaxListeners(n?, ...eventTargets): void
    • import { setMaxListeners, EventEmitter } from 'node:events';

      const target = new EventTarget();
      const emitter = new EventEmitter();

      setMaxListeners(5, target, emitter);
-
      -

      Parameters

      • Optional n: number

        A non-negative number. The maximum number of listeners per EventTarget event.

        -
      • Rest ...eventTargets: (EventEmitter | _DOMEventTarget)[]

      Returns void

      Since

      v15.4.0

      -

    Static toWeb

    • toWeb(streamDuplex): {
          readable: ReadableStream<any>;
          writable: WritableStream<any>;
      }
    • Experimental

      A utility method for creating a web ReadableStream and WritableStream from a Duplex.

      -

      Parameters

      • streamDuplex: Duplex

      Returns {
          readable: ReadableStream<any>;
          writable: WritableStream<any>;
      }

      • readable: ReadableStream<any>
      • writable: WritableStream<any>

      Since

      v17.0.0

      -

    Properties

    allowHalfOpen

    allowHalfOpen: boolean

    If false then the stream will automatically end the writable side when the +

    import { EventEmitter, once } from 'node:events';

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
+
    + +

    Parameters

    • emitter: _NodeEventTarget
    • eventName: string | symbol
    • Optionaloptions: StaticEventEmitterOptions

    Returns Promise<any[]>

    Since

    v11.13.0, v10.16.0

    +
  • once(emitter, eventName, options?): Promise<any[]>

  • Parameters

    • emitter: _DOMEventTarget
    • eventName: string
    • Optionaloptions: StaticEventEmitterOptions

    Returns Promise<any[]>

    • StaticsetMaxListeners

    • setMaxListeners(n?, ...eventTargets): void
    • import { setMaxListeners, EventEmitter } from 'node:events';

      const target = new EventTarget();
      const emitter = new EventEmitter();

      setMaxListeners(5, target, emitter);
+
      + +

      Parameters

      • Optionaln: number

        A non-negative number. The maximum number of listeners per EventTarget event.

        +
      • Rest...eventTargets: (EventEmitter | _DOMEventTarget)[]

      Returns void

      Since

      v15.4.0

      +

    StatictoWeb

    • toWeb(streamDuplex): {
          readable: ReadableStream<any>;
          writable: WritableStream<any>;
      }
    • Experimental

      A utility method for creating a web ReadableStream and WritableStream from a Duplex.

      +

      Parameters

      • streamDuplex: Duplex

      Returns {
          readable: ReadableStream<any>;
          writable: WritableStream<any>;
      }

      • Experimentalreadable: ReadableStream<any>
      • Experimentalwritable: WritableStream<any>

      Since

      v17.0.0

      +

    Properties

    allowHalfOpen

    allowHalfOpen: boolean

    If false then the stream will automatically end the writable side when the readable side ends. Set initially by the allowHalfOpen constructor option, which defaults to true.

    This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is emitted.

    -

    Since

    v0.9.4

    -

    Readonly closed

    closed: boolean

    destroyed

    destroyed: boolean

    Is true after readable.destroy() has been called.

    -

    Since

    v8.0.0

    -

    Readonly errored

    errored: Error

    readable

    readable: boolean

    Is true if it is safe to call readable.read(), which means +

    Since

    v0.9.4

    +

    Readonlyclosed

    closed: boolean

    Is true after 'close' has been emitted.

    +

    Since

    v18.0.0

    +

    destroyed

    destroyed: boolean

    Is true after readable.destroy() has been called.

    +

    Since

    v8.0.0

    +

    Readonlyerrored

    errored: Error

    Returns error if the stream has been destroyed with an error.

    +

    Since

    v18.0.0

    +

    readable

    readable: boolean

    Is true if it is safe to call readable.read(), which means the stream has not been destroyed or emitted 'error' or 'end'.

    -

    Since

    v11.4.0

    -

    Readonly Experimental readableAborted

    readableAborted: boolean

    Returns whether the stream was destroyed or errored before emitting 'end'.

    -

    Since

    v16.8.0

    -

    Readonly Experimental readableDidRead

    readableDidRead: boolean

    Returns whether 'data' has been emitted.

    -

    Since

    v16.7.0, v14.18.0

    -

    Readonly readableEncoding

    readableEncoding: BufferEncoding

    Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

    -

    Since

    v12.7.0

    -

    Readonly readableEnded

    readableEnded: boolean

    Becomes true when 'end' event is emitted.

    -

    Since

    v12.9.0

    -

    Readonly readableFlowing

    readableFlowing: boolean

    This property reflects the current state of a Readable stream as described +

    Since

    v11.4.0

    +

    Readonly ExperimentalreadableAborted

    readableAborted: boolean

    Returns whether the stream was destroyed or errored before emitting 'end'.

    +

    Since

    v16.8.0

    +

    Readonly ExperimentalreadableDidRead

    readableDidRead: boolean

    Returns whether 'data' has been emitted.

    +

    Since

    v16.7.0, v14.18.0

    +

    ReadonlyreadableEncoding

    readableEncoding: BufferEncoding

    Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

    +

    Since

    v12.7.0

    +

    ReadonlyreadableEnded

    readableEnded: boolean

    Becomes true when 'end' event is emitted.

    +

    Since

    v12.9.0

    +

    ReadonlyreadableFlowing

    readableFlowing: boolean

    This property reflects the current state of a Readable stream as described in the Three states section.

    -

    Since

    v9.4.0

    -

    Readonly readableHighWaterMark

    readableHighWaterMark: number

    Returns the value of highWaterMark passed when creating this Readable.

    -

    Since

    v9.3.0

    -

    Readonly readableLength

    readableLength: number

    This property contains the number of bytes (or objects) in the queue +

    Since

    v9.4.0

    +

    ReadonlyreadableHighWaterMark

    readableHighWaterMark: number

    Returns the value of highWaterMark passed when creating this Readable.

    +

    Since

    v9.3.0

    +

    ReadonlyreadableLength

    readableLength: number

    This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the highWaterMark.

    -

    Since

    v9.4.0

    -

    Readonly readableObjectMode

    readableObjectMode: boolean

    Getter for the property objectMode of a given Readable stream.

    -

    Since

    v12.3.0

    -

    Readonly writable

    writable: boolean

    Readonly writableCorked

    writableCorked: number

    Readonly writableEnded

    writableEnded: boolean

    Readonly writableFinished

    writableFinished: boolean

    Readonly writableHighWaterMark

    writableHighWaterMark: number

    Readonly writableLength

    writableLength: number

    Readonly writableNeedDrain

    writableNeedDrain: boolean

    Readonly writableObjectMode

    writableObjectMode: boolean

    Static Readonly captureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    -

    See how to write a custom rejection handler.

    -

    Since

    v13.4.0, v12.16.0

    -

    Static captureRejections

    captureRejections: boolean

    Value: boolean

    +

    Since

    v9.4.0

    +

    ReadonlyreadableObjectMode

    readableObjectMode: boolean

    Getter for the property objectMode of a given Readable stream.

    +

    Since

    v12.3.0

    +

    Readonlywritable

    writable: boolean

    Is true if it is safe to call writable.write(), which means +the stream has not been destroyed, errored, or ended.

    +

    Since

    v11.4.0

    +

    ReadonlywritableCorked

    writableCorked: number

    Number of times writable.uncork() needs to be +called in order to fully uncork the stream.

    +

    Since

    v13.2.0, v12.16.0

    +

    ReadonlywritableEnded

    writableEnded: boolean

    Is true after writable.end() has been called. This property +does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

    +

    Since

    v12.9.0

    +

    ReadonlywritableFinished

    writableFinished: boolean

    Is set to true immediately before the 'finish' event is emitted.

    +

    Since

    v12.6.0

    +

    ReadonlywritableHighWaterMark

    writableHighWaterMark: number

    Return the value of highWaterMark passed when creating this Writable.

    +

    Since

    v9.3.0

    +

    ReadonlywritableLength

    writableLength: number

    This property contains the number of bytes (or objects) in the queue +ready to be written. The value provides introspection data regarding +the status of the highWaterMark.

    +

    Since

    v9.4.0

    +

    ReadonlywritableNeedDrain

    writableNeedDrain: boolean

    Is true if the stream's buffer has been full and stream will emit 'drain'.

    +

    Since

    v15.2.0, v14.17.0

    +

    ReadonlywritableObjectMode

    writableObjectMode: boolean

    Getter for the property objectMode of a given Writable stream.

    +

    Since

    v12.3.0

    +

    StaticcaptureRejections

    captureRejections: boolean

    Value: boolean

    Change the default captureRejections option on all new EventEmitter objects.

    -

    Since

    v13.4.0, v12.16.0

    -

    Static defaultMaxListeners

    defaultMaxListeners: number

    By default, a maximum of 10 listeners can be registered for any single +

    Since

    v13.4.0, v12.16.0

    +

    Static ReadonlycaptureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    +

    See how to write a custom rejection handler.

    +

    Since

    v13.4.0, v12.16.0

    +

    StaticdefaultMaxListeners

    defaultMaxListeners: number

    By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListenersproperty can be used. If this value is not a positive number, a RangeErroris thrown.

    @@ -496,8 +806,9 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    more listeners to be added but will output a trace warning to stderr indicating that a "possible EventEmitter memory leak" has been detected. For any singleEventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners()methods can be used to temporarily avoid this warning:

    -
    import { EventEmitter } from 'node:events';
    const emitter = new EventEmitter();
    emitter.setMaxListeners(emitter.getMaxListeners() + 1);
    emitter.once('event', () => {
      // do stuff
      emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
    });
-
    +
    import { EventEmitter } from 'node:events';
    const emitter = new EventEmitter();
    emitter.setMaxListeners(emitter.getMaxListeners() + 1);
    emitter.once('event', () => {
      // do stuff
      emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
    });
+
    +

    The --trace-warnings command-line flag can be used to display the stack trace for such warnings.

    The emitted warning can be inspected with process.on('warning') and will @@ -505,9 +816,9 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    the event emitter instance, the event's name and the number of attached listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

    -

    Since

    v0.11.2

    -

    Static Readonly errorMonitor

    errorMonitor: typeof errorMonitor

    This symbol shall be used to install a listener for only monitoring 'error'events. Listeners installed using this symbol are called before the regular'error' listeners are called.

    +

    Since

    v0.11.2

    +

    Static ReadonlyerrorMonitor

    errorMonitor: typeof errorMonitor

    This symbol shall be used to install a listener for only monitoring 'error'events. Listeners installed using this symbol are called before the regular'error' listeners are called.

    Installing a listener using this symbol does not change the behavior once an'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

    -

    Since

    v13.6.0, v12.17.0

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructor[asyncDispose][asyncIterator][captureRejectionSymbol]_construct_destroy_final_flush_read_transform_write_writevaddListenerasIndexedPairscomposecorkdestroydropemitendeventNameseveryfilterfindflatMapforEachgetMaxListenersisPausediteratorlistenerCountlistenersmapoffononcepausepipeprependListenerprependOnceListenerpushrawListenersreadreduceremoveAllListenersremoveListenerresumesetDefaultEncodingsetEncodingsetMaxListenerssometaketoArrayuncorkunpipeunshiftwrapwriteaddAbortListenerfromfromWebgetEventListenersgetMaxListenersisDisturbedlistenerCountononcesetMaxListenerstoWeballowHalfOpencloseddestroyederroredreadablereadableAbortedreadableDidReadreadableEncodingreadableEndedreadableFlowingreadableHighWaterMarkreadableLengthreadableObjectModewritablewritableCorkedwritableEndedwritableFinishedwritableHighWaterMarkwritableLengthwritableNeedDrainwritableObjectModecaptureRejectionSymbolcaptureRejectionsdefaultMaxListenerserrorMonitor
    \ No newline at end of file +

    Since

    v13.6.0, v12.17.0

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_struct_cache_quick_lru.QuickLRU.html b/docs/classes/_runtime_data_struct_cache_quick_lru.QuickLRU.html index 99919257..601fca8b 100644 --- a/docs/classes/_runtime_data_struct_cache_quick_lru.QuickLRU.html +++ b/docs/classes/_runtime_data_struct_cache_quick_lru.QuickLRU.html @@ -1,4 +1,15 @@ -QuickLRU | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class QuickLRU<KeyType, ValueType>

    Type Parameters

    • KeyType
    • ValueType

    Hierarchy

    Implements

    Constructors

    constructor +QuickLRU | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class QuickLRU<KeyType, ValueType>

    Type Parameters

    • KeyType
    • ValueType
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Implements

    Constructors

    constructor

    Accessors

    maxSize size

    Methods

    [iterator] @@ -17,20 +28,21 @@ values

    Properties

    [toStringTag] [species] -

    Constructors

    constructor

    Constructors

    constructor

    Accessors

    maxSize

    • get maxSize(): number

    • The set max size.

      + +

    Accessors

    maxSize

    • get maxSize(): number

    • The set max size.

      Returns number

    size

    • get size(): number

    • The stored item count.

      -

      Returns number

    Methods

    [iterator]

    clear

    • clear(): void

    • Delete all items.

      +

      Returns number

    Methods

    [iterator]

    clear

    • clear(): void

    • Delete all items.

      Returns void

    delete

    • delete(key): boolean

    • Delete an item.

      Parameters

      Returns boolean

      true if the item is removed or false if the item doesn't exist.

    entries

    entriesAscending

    entriesDescending

    forEach

    • forEach(callbackfn, thisArg?): void

    • Executes a provided function once per each key/value pair in the Map, in insertion order.

      -

      Parameters

      Returns void

    get

    get

    has

    • has(key): boolean

    • Check if an item exists.

      Parameters

      Returns boolean

    keys

    • keys(): IterableIterator<KeyType>

    • Iterable for all the keys.

      @@ -40,6 +52,6 @@

      Useful for on-the-fly tuning of cache sizes in live systems.

      Parameters

      • maxSize: number

      Returns void

    set

    • set(key, value, options?): this

    • Set an item. Returns the instance.

      Individual expiration of an item can be specified with the maxAge option. If not specified, the global maxAge value will be used in case it is specified in the constructor, otherwise the item will never expire.

      -

      Parameters

      • key: KeyType
      • value: ValueType
      • Optional options: {
            maxAge?: number;
        }
        • Optional maxAge?: number

      Returns this

      The list instance.

      +

    Parameters

    • key: KeyType
    • value: ValueType
    • Optionaloptions: {
          maxAge?: number;
      }
      • OptionalmaxAge?: number

    Returns this

    The list instance.

    values

    Properties

    Readonly [toStringTag]

    [toStringTag]: string

    Static Readonly [species]

    [species]: MapConstructor

    Settings

    Member Visibility

    Theme

    On This Page

    constructormaxSizesize[iterator]cleardeleteentriesentriesAscendingentriesDescendingforEachgethaskeyspeekresizesetvalues[toStringTag][species]
    \ No newline at end of file +

    Returns IterableIterator<ValueType>

    Properties

    Readonly[toStringTag]

    [toStringTag]: string

    Static Readonly[species]

    [species]: MapConstructor

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_struct_hash_array.HashArray.html b/docs/classes/_runtime_data_struct_hash_array.HashArray.html index ac671825..8b94f6b3 100644 --- a/docs/classes/_runtime_data_struct_hash_array.HashArray.html +++ b/docs/classes/_runtime_data_struct_hash_array.HashArray.html @@ -1,6 +1,7 @@ -HashArray | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class HashArray<T>

    HashArray is a data structure that combines the best feature of a hash (O(1) retrieval) and an array +HashArray | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class HashArray<T>

    HashArray is a data structure that combines the best feature of a hash (O(1) retrieval) and an array (length and ordering). Think of it as a super-lightweight, extensible, self-indexing set database in memory.

    -

    Type Parameters

    • T extends object

    Constructors

    constructor +

    Type Parameters

    • T extends object

    Constructors

    constructor

    Accessors

    keyFields size sizeFlat @@ -27,44 +28,44 @@ values valuesFlat

    Properties

    CloneOps -

    Constructors

    constructor

    • new HashArray<T>(keyFields?, options?): HashArray<T>

    • Type Parameters

      • T extends object

      Parameters

      • Optional keyFields: string | KeyFields

        A single string or an array of strings / arrays representing what +

    Constructors

    constructor

    • new HashArray<T>(keyFields?, options?): HashArray<T>

    • Type Parameters

      • T extends object

      Parameters

      • OptionalkeyFields: string | KeyFields

        A single string or an array of strings / arrays representing what fields on added objects are to be used as keys for the trie search / HashArray.

        -
      • Optional options: HashArrayOptions<T>

        Options.

        -

      Returns HashArray<T>

    Accessors

    keyFields

  • Optionaloptions: HashArrayOptions<T>

    Options.

    +

    • Returns HashArray<T>

    Accessors

    keyFields

    size

    • get size(): number

    • Returns number

      The mapped size; number of keys in HashArray.

    sizeFlat

    • get sizeFlat(): number

    • Returns number

      The flattened size; number of items in HashArray.

      -

    Methods

    add

    • add(...items): this

    • Add items or list of items to the HashArray instance.

      -

      Parameters

    Methods

    add

    • add(...items): this

    • Add items or list of items to the HashArray instance.

      +

      Parameters

      Returns this

      This instance.

    clear

    • clear(): this

    • Clears all items.

      Returns this

      This instance.

    clone

    • clone(opts?): HashArray<T>

    • Clones this HashArray. By default, returning an empty HashArray with cloned KeyFields. Set items in options to CloneOps.SHALLOW to copy the items. To fully clone all items set CloneOps.DEEP.

      -

      Parameters

      • Optional opts: {
            items?: CloneOps;
            options?: HashArrayOptions<T>;
        }

        Optional parameters.

        -
        • Optional items?: CloneOps

          Clone operation for items. By default, - no items are included in the clone. Supply SHALLOW and items are copied. Supply DEEP and items are - cloned as well.

          -
        • Optional options?: HashArrayOptions<T>

          Optional change to options for the clone that is merged with - current HashArray options.

          +

          Parameters

          • Optionalopts: {
                items?: CloneOps;
                options?: HashArrayOptions<T>;
            }

            Optional parameters.

            +
            • Optionalitems?: CloneOps

              Clone operation for items. By default, +no items are included in the clone. Supply SHALLOW and items are copied. Supply DEEP and items are +cloned as well.

              +
            • Optionaloptions?: HashArrayOptions<T>

              Optional change to options for the clone that is merged with +current HashArray options.

          Returns HashArray<T>

    collides

    • collides(item): boolean

    • Detects if the given item collides with an existing key / item pair.

      Parameters

      • item: Partial<T>

        A partial item to check for collision.

      Returns boolean

      Is there a collision?

    entries

    entriesFlat

    filter

    • filter(key, callbackOrIndex): HashArray<T>

    • Filters this HashArray returning a new HashArray with the items that pass the given filter test.

      +

      Yields

    filter

    • filter(key, callbackOrIndex): HashArray<T>

    • Filters this HashArray returning a new HashArray with the items that pass the given filter test.

      Parameters

      • key: Key

        The Key to retrieve item(s) to iterate.

        -
      • callbackOrIndex: Key | ((item) => boolean)

        A Key to lookup for filter inclusion or a callback - function returning the filter result for the item.

        +
      • callbackOrIndex: Key | ((item: T) => boolean)

        A Key to lookup for filter inclusion or a callback +function returning the filter result for the item.

      Returns HashArray<T>

    forEach

    • forEach(key, callback): this

    • Iterates over all items retrieved by the given key invoking the callback function for each item.

      Parameters

      • key: Key

        The Key to retrieve items to iterate.

        -
      • callback: ((item) => void)

        A callback invoked for each item.

        +
      • callback: ((item: T) => void)

        A callback invoked for each item.

          • (item): void

          • Parameters

            • item: T

            Returns void

      Returns this

      This instance.

    forEachDeep

    • forEachDeep(key, index, callback): this

    • Iterates over all items retrieved by the given key invoking the callback function for each item with the value found by the index Key and the item itself.

      Parameters

      • key: Key

        The Key to retrieve item(s) to iterate.

      • index: Key

        A specific Key in each item to lookup.

        -
      • callback: ((value, item) => void)

        A callback invoked for each item with value of index - and item.

        +
      • callback: ((value: any, item: T) => void)

        A callback invoked for each item with value of index +and item.

          • (value, item): void

          • Parameters

            • value: any
            • item: T

            Returns void

      Returns this

      This instance.

    get

    • get(key): T | T[]

    • Gets item(s) by the given key.

      Parameters

      • key: string

        The key for an item to retrieve.

        @@ -82,15 +83,15 @@

      Returns boolean

      Whether this HashArray already has the given key.

    intersection

    • intersection(target, output?): HashArray<T>

    • Returns the intersection of this HashArray and a target HashArray.

      Parameters

      • target: HashArray<T>

        Another HashArray.

        -
      • Optional output: HashArray<T>

        Optional output HashArray.

        +
      • Optionaloutput: HashArray<T>

        Optional output HashArray.

      Returns HashArray<T>

      Returns a new HashArray that contains the intersection between this (A) and the HashArray - passed in (B). Returns A ^ B.

      +passed in (B). Returns A ^ B.

    keys

    remove

    • remove(...items): this

    • Removes all item(s) given.

      -

      Parameters

      • Rest ...items: T[]

        Items to remove.

        +

        Parameters

        • Rest...items: T[]

          Items to remove.

        Returns this

        This instance.

    removeByKey

    • removeByKey(...keys): this

    • Remove item(s) associated with the given keys from the HashArray.

      -

      Parameters

      • Rest ...keys: string[]

        Keys associated with the item(s) to be removed.

        +

        Parameters

        • Rest...keys: string[]

          Keys associated with the item(s) to be removed.

        Returns this

        This instance.

    removeFirst

    • removeFirst(): this

    • When treating HashArray as a cache removing the first item removes the oldest item.

      Returns this

      This instance.

      @@ -98,5 +99,5 @@

    Returns this

    This instance.

    values

    valuesFlat

    Properties

    Static Readonly CloneOps

    CloneOps: typeof CloneOps

    An enum used in HashArray.clone determining how items are handled.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorkeyFieldssizesizeFlataddclearclonecollidesentriesentriesFlatfilterforEachforEachDeepgetgetAllgetAsArraygetAthasintersectionkeysremoveremoveByKeyremoveFirstremoveLastvaluesvaluesFlatCloneOps
    \ No newline at end of file +

    Properties

    Static ReadonlyCloneOps

    CloneOps: typeof CloneOps

    An enum used in HashArray.clone determining how items are handled.

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_struct_hash_array.HashArrayUtil.html b/docs/classes/_runtime_data_struct_hash_array.HashArrayUtil.html index 732436b4..fd0905c1 100644 --- a/docs/classes/_runtime_data_struct_hash_array.HashArrayUtil.html +++ b/docs/classes/_runtime_data_struct_hash_array.HashArrayUtil.html @@ -1,35 +1,36 @@ -HashArrayUtil | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class HashArrayUtil

    Provides extra examples of how various additional operations can be added on top of HashArray. These operations +HashArrayUtil | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class HashArrayUtil

    Provides extra examples of how various additional operations can be added on top of HashArray. These operations are not included with HashArray to keep it lean and mean for TrieSearch. By all means though extend HashArray and add the operations that you need.

    There are tests for all operations below in ./test/hash/HAExtra.test.ts.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    average difference sample sum -

    Constructors

    constructor

    Methods

    Static average

    • average<T>(source, key, index, weightKey?): number

    • Iterates deeply over items specified by key and index with an optional weightKey and calculates the +

    Constructors

    constructor

    Methods

    Staticaverage

    • average<T>(source, key, index, weightKey?): number

    • Iterates deeply over items specified by key and index with an optional weightKey and calculates the average value.

      Type Parameters

      • T extends object

      Parameters

      • source: HashArray<T>

        Source HashArray.

      • key: Key

        The Key to retrieve item(s) to iterate.

      • index: Key

        A specific Key in each item to lookup.

        -
      • Optional weightKey: Key

        A specific Key in each item to provide a weighting value.

        +
      • OptionalweightKey: Key

        A specific Key in each item to provide a weighting value.

      Returns number

      The average value for the given iteration.

      -

    Static difference

    • difference<T>(source, target, output?): HashArray<T>

    • Returns the difference of this HashArray and a target HashArray. If no output HashArray is provided the source +

    Staticdifference

    • difference<T>(source, target, output?): HashArray<T>

    • Returns the difference of this HashArray and a target HashArray. If no output HashArray is provided the source is cloned.

      Type Parameters

      • T extends object

      Parameters

      Returns HashArray<T>

      Returns a new HashArray that contains the difference between source (A) and target (B) - HashArrays. Returns A - B.

      -

    Static sample

    • sample<T>(source, count, key?): T[]

    • Type Parameters

      • T extends object

      Parameters

      • source: HashArray<T>

        Source HashArray.

        +HashArrays. Returns A - B.

        +

    Staticsample

    • sample<T>(source, count, key?): T[]

    • Type Parameters

      • T extends object

      Parameters

      • source: HashArray<T>

        Source HashArray.

      • count: number

        How many items to sample.

        -
      • Optional key: Key

        The Key for item(s) to sample.

        +
      • Optionalkey: Key

        The Key for item(s) to sample.

      Returns T[]

      Random subset of items.

      -

      See

      http://en.wikipedia.org/wiki/Image_(mathematics)

      -

    Static sum

    Staticsum

    • sum<T>(source, key, index, weightKey?): number

    • Iterates deeply over items specified by key and index with an optional weightKey and calculates the sum.

      Type Parameters

      • T extends object

      Parameters

      • source: HashArray<T>

        Source HashArray.

      • key: Key

        The Key to retrieve item(s) to iterate.

      • index: Key

        A specific Key in each item to lookup.

        -
      • Optional weightKey: Key

        A specific Key in each item to provide a weighting value.

        +
      • OptionalweightKey: Key

        A specific Key in each item to provide a weighting value.

      Returns number

      The sum for the given iteration.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructoraveragedifferencesamplesum
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_struct_search_trie.TrieSearch.html b/docs/classes/_runtime_data_struct_search_trie.TrieSearch.html index 202aae22..6f43d8d2 100644 --- a/docs/classes/_runtime_data_struct_search_trie.TrieSearch.html +++ b/docs/classes/_runtime_data_struct_search_trie.TrieSearch.html @@ -1,4 +1,5 @@ -TrieSearch | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class TrieSearch<T>

    A Trie is a data structure designed for quick reTRIEval of objects by string search. This was designed for use with +TrieSearch | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class TrieSearch<T>

    A Trie is a data structure designed for quick reTRIEval of objects by string search. This was designed for use with a type-ahead search (e.g. like a dropdown) but could be used in a variety of situations.

    This data structure indexes sentences / words to objects for searching by full or partial matches. So you can map 'hello' to an Object, and then search by 'hel', 'hell', or 'hello' and get the Object or an Array of all objects @@ -8,7 +9,7 @@ like 'qui' or 'qu' or 'fo'. Boundaries can be customized using the splitOnRegEx option.

    By default, the trie-search is internationalized for a common set of vowels in the ASCII set. So if you insert 'ö', then searching on 'o' will return that result. You can customize this by providing your own expandRegexes object.

    -

    Type Parameters

    • T extends object

    Constructors

    constructor +

    Type Parameters

    • T extends object

    Constructors

    constructor

    Accessors

    isDestroyed keyFields root @@ -19,15 +20,15 @@ map search subscribe -

    Constructors

    constructor

    • new TrieSearch<T>(keyFields?, options?): TrieSearch<T>

    • Type Parameters

      • T extends object

      Parameters

      • Optional keyFields: string | KeyFields

        A single string or an array of strings / arrays representing what +

    Constructors

    constructor

    • new TrieSearch<T>(keyFields?, options?): TrieSearch<T>

    • Type Parameters

      • T extends object

      Parameters

      • OptionalkeyFields: string | KeyFields

        A single string or an array of strings / arrays representing what fields on added objects are to be used as keys for the trie search / HashArray.

        -
      • Optional options: TrieSearchOptions

        Options.

        -

      Returns TrieSearch<T>

    Accessors

    isDestroyed

    • get isDestroyed(): boolean

    • Returns boolean

      Whether this TrieSearch instance has been destroyed.

      +
  • Optionaloptions: TrieSearchOptions

    Options.

    +

    • Returns TrieSearch<T>

    Accessors

    isDestroyed

    • get isDestroyed(): boolean

    • Returns boolean

      Whether this TrieSearch instance has been destroyed.

    keyFields

    root

    size

    • get size(): number

    • Returns number

      Number of nodes in the trie data structure.

      -

    Methods

    add

    • add(...items): this

    • Add items or list of items to the TrieSearch instance.

      -

      Parameters

    Methods

    add

    • add(...items): this

    • Add items or list of items to the TrieSearch instance.

      +

      Parameters

      Returns this

    clear

    • clear(): this

    • Clears all items.

      Returns this

      This instance.

    destroy

    • destroy(): this

    • Destroys this TrieSearch instance. Removing all data and preventing new data from being added. Any subscribers @@ -39,10 +40,10 @@ TrieSearchOptions.splitOnGetRegEx and matches found for each word resulting in a OR lookup. You may provide a reducer function to change the behavior

      Parameters

      • phrases: string | Iterable<string>

        The phrases to parse and search in the trie data structure.

        -
      • Optional options: {
            limit?: number;
            list?: T[];
            reducer?: ITrieSearchReducer<T>;
        }

        Search Options.

        -
        • Optional limit?: number

          The limit for search results returned.

          -
        • Optional list?: T[]

          An external array to use for storing search results.

          -
        • Optional reducer?: ITrieSearchReducer<T>

          A trie reducer instance to apply to this search.

          +
        • Optionaloptions: {
              limit?: number;
              list?: T[];
              reducer?: ITrieSearchReducer<T>;
          }

          Search Options.

          +
          • Optionallimit?: number

            The limit for search results returned.

            +
          • Optionallist?: T[]

            An external array to use for storing search results.

            +
          • Optionalreducer?: ITrieSearchReducer<T>

            A trie reducer instance to apply to this search.

      Returns T[]

      Found matches.

    subscribe

    • subscribe(handler): (() => void)

    • Subscribe for change notification on add / clear / destroy.

      Note: There is no data defined regarding what changed only that one of three actions occurred. This TrieSearch @@ -51,4 +52,4 @@

      Parameters

      Returns (() => void)

      Unsubscribe function.

      -
        • (): void

        • Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisDestroyedkeyFieldsrootsizeaddcleardestroymapsearchsubscribe
    \ No newline at end of file +
      • (): void

      • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_struct_search_trie.UnionReducer.html b/docs/classes/_runtime_data_struct_search_trie.UnionReducer.html index f8f64fd8..d8a239dd 100644 --- a/docs/classes/_runtime_data_struct_search_trie.UnionReducer.html +++ b/docs/classes/_runtime_data_struct_search_trie.UnionReducer.html @@ -1,14 +1,15 @@ -UnionReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class UnionReducer<T>

    Provides an ITrieSearchReducer implementation to accumulate a union / AND of matches across all phrases provided in +UnionReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class UnionReducer<T>

    Provides an ITrieSearchReducer implementation to accumulate a union / AND of matches across all phrases provided in a search query.

    -

    Type Parameters

    • T extends object

    Implements

    Constructors

    constructor +

    Type Parameters

    • T extends object

    Implements

    Constructors

    constructor

    Accessors

    keyFields matches

    Methods

    reduce reset -

    Constructors

    constructor

    Accessors

    keyFields

    Constructors

    constructor

    Accessors

    keyFields

    • get keyFields(): Key | KeyFields

    • Returns Key | KeyFields

      Returns the index field key.

    matches

    • get matches(): T[]

    • Returns T[]

      Returns the union of all matches.

      -

    Methods

    reduce

    • reduce(data): void

    • Accumulates and reduces each batch of matches for one or more phrases.

      +

    Methods

    reduce

    reset

    Settings

    Member Visibility

    Theme

    On This Page

    constructorkeyFieldsmatchesreducereset
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_data_struct_search_trie_query.TrieSearchQuery.html b/docs/classes/_runtime_data_struct_search_trie_query.TrieSearchQuery.html index 8ec1a227..a24d5cb4 100644 --- a/docs/classes/_runtime_data_struct_search_trie_query.TrieSearchQuery.html +++ b/docs/classes/_runtime_data_struct_search_trie_query.TrieSearchQuery.html @@ -1,6 +1,17 @@ -TrieSearchQuery | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class TrieSearchQuery<T>

    Provides a reactive query interface to TrieSearch in addition to dynamic filtering / sorting of search +TrieSearchQuery | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class TrieSearchQuery<T>

    Provides a reactive query interface to TrieSearch in addition to dynamic filtering / sorting of search results.

    -

    Type Parameters

    • T extends object

    Hierarchy (view full)

    Constructors

    constructor +

    Type Parameters

    • T extends object
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Constructors

    constructor

    Accessors

    data derived destroyed @@ -19,9 +30,9 @@ initialize setData subscribe -

    Constructors

    constructor

    Accessors

    data

    • get data(): T[]

    • Returns the internal data of this instance. Be careful!

      +

    Constructors

    constructor

    Accessors

    data

    • get data(): T[]

    • Returns the internal data of this instance. Be careful!

      Note: if an array is set as initial data then that array is used as the internal data. If any changes are performed to the data externally do invoke update via DynArrayReducer.index with true to recalculate the index and notify all subscribers.

      @@ -43,17 +54,17 @@

    trieReducer

    trieSearch

    Methods

    [iterator]

    • [iterator](): IterableIterator<T>

    • Provides an iterator for data stored in DynArrayReducer.

      +

    Methods

    [iterator]

    destroy

    • destroy(): void

    • Destroys and disconnects this query from the local stores and any associated TrieSearch instance.

      -

      Returns void

    Protected initialize

    • initialize(): void
    • Protected

      Provides a callback for custom reducers to initialize any data / custom configuration. This allows +

      Yields

    destroy

    • destroy(): void

    • Destroys and disconnects this query from the local stores and any associated TrieSearch instance.

      +

      Returns void

    Protectedinitialize

    • initialize(): void
    • Protected

      Provides a callback for custom reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.

      Returns void

    setData

    • setData(data, replace?): void

    • Removes internal data and pushes new data. This does not destroy any initial array set to internal data unless replace is set to true.

      Parameters

      • data: Iterable<T> | T[]

        New data to set to internal data.

        -
      • Optional replace: boolean

        New data to set to internal data.

        +
      • Optionalreplace: boolean

        New data to set to internal data.

      Returns void

    subscribe

    • subscribe(handler): (() => void)

    • Add a subscriber to this DynArrayReducer instance.

      -

      Parameters

      • handler: ((value) => void)

        Callback function that is invoked on update / changes. - Receives this reference.

        +

        Parameters

        • handler: ((value: DynArrayReducer<T>) => void)

          Callback function that is invoked on update / changes. +Receives this reference.

        Returns (() => void)

        Unsubscribe function.

        -
          • (): void

          • Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructordataderiveddestroyedfiltersindexisDestroyedlengthlimitqueryreversedsorttrieReducertrieSearch[iterator]destroyinitializesetDatasubscribe
    \ No newline at end of file +
      • (): void

      • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_gl_matrix.Mat2.html b/docs/classes/_runtime_math_gl_matrix.Mat2.html index 9d799118..1976c953 100644 --- a/docs/classes/_runtime_math_gl_matrix.Mat2.html +++ b/docs/classes/_runtime_math_gl_matrix.Mat2.html @@ -1,14 +1,25 @@ -Mat2 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Mat2

    A 2x2 Matrix

    -

    Hierarchy

    Other

    constructor -BYTES_PER_ELEMENT +Mat2 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Mat2

    A 2x2 Matrix

    +
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Other

    constructor [toStringTag] buffer byteLength byteOffset +BYTES_PER_ELEMENT length BYTES_PER_ELEMENT -BYTE_LENGTH str +BYTE_LENGTH [iterator] at copy @@ -47,8 +58,7 @@ values from of -

    Static

    LDU -add +

    Static

    add adjoint clone copy @@ -62,6 +72,7 @@ fromValues identity invert +LDU mul multiply multiplyScalar @@ -73,17 +84,17 @@ sub subtract transpose -

    Other

    constructor

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Float32Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Static Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Static Readonly BYTE_LENGTH

    BYTE_LENGTH: number

    The number of bytes in a Mat2.

    -

    str

    • get str(): string

    • A string representation of this +

    Other

    constructor

    Readonly[toStringTag]

    [toStringTag]: "Float32Array"

    Readonlybuffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    ReadonlybyteLength

    byteLength: number

    The length in bytes of the array.

    +

    ReadonlybyteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Readonlylength

    length: number

    The length of the array.

    +

    Static ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    str

    • get str(): string

    • A string representation of this Equivalent to Mat2.str(this);

      -

      Returns string

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      +

      Returns string

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Mat2.

      +

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

      Returns number

    copy

    • copy(a): Mat2

    • Copy the values from another Mat2 into this.

      Parameters

      • a: Readonly<Mat2Like>

        the source vector

        @@ -94,70 +105,70 @@ length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

        -
      • Optional end: number

        If not specified, length of the this object is used as its default value.

        +
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    fill

    • fill(value, start?, end?): this

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter(predicate, thisArg?): Float32Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => any)

          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

          -
            • (value, index, array): any

            • Parameters

              Returns any

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): any

            • Parameters

              Returns any

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    find

    • find(predicate, thisArg?): number

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): void

            • Parameters

              Returns void

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): void

            • Parameters

              Returns void

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    identity

    • identity(): Mat2

    • Set this to the identity matrix Equivalent to Mat2.identity(this)

      Returns Mat2

      this

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +
      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        +
      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      Returns number

    invert

    • invert(): Mat2

    • Inverts this Mat2 Equivalent to Mat4.invert(this, this);

      Returns Mat2

      this

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +

        Parameters

        • Optionalseparator: string

          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

        Returns string

    keys

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    map

    • map(callbackfn, thisArg?): Float32Array

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => number)

          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): number

            • Parameters

              Returns number

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): number

            • Parameters

              Returns number

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    mul

    multiply

    • multiply(b): Mat2

    • Multiplies this Mat2 against another one @@ -167,12 +178,12 @@

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduce(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduce<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array. The return value of +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -180,12 +191,12 @@

        Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduceRight(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduceRight<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array, in descending order. +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -201,26 +212,27 @@

        Returns Mat2

        this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +
      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    slice

    • slice(start?, end?): Float32Array

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

        Parameters

        • Optionalstart: number

          The beginning of the specified portion of the array.

          +
        • Optionalend: number

          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        Returns Float32Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    sort

    • sort(compareFn?): this

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +

        Parameters

        • OptionalcompareFn: ((a: number, b: number) => number)

          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

          -
          [11,2,22,1].sort((a, b) => a - b)
-
          +
          [11,2,22,1].sort((a, b) => a - b)
+
          +
            • (a, b): number

            • Parameters

              • a: number
              • b: number

              Returns number

        Returns this

    subarray

    • subarray(begin?, end?): Float32Array

    • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        +

        Parameters

        • Optionalbegin: number

          The index of the beginning of the array.

          +
        • Optionalend: number

          The index of the end of the array.

        Returns Float32Array

    toLocaleString

    • toLocaleString(): string

    • Converts a number to a string by using the current locale.

      Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      Returns string

    transpose

    • transpose(): Mat2

    • Transpose this Mat2 @@ -228,121 +240,123 @@

      Returns Mat2

      this

    valueOf

    • valueOf(): Float32Array

    • Returns the primitive value of the specified object.

      Returns Float32Array

    values

    Static from

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      +

      Returns IterableIterator<number>

    Staticfrom

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<number>

        An array-like or iterable object to convert to an array.

      Returns Float32Array

    • from<T>(arrayLike, mapfn, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like or iterable object to convert to an array.

        -
      • mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        +
      • mapfn: ((v: T, k: number) => number)

        A mapping function to call on every element of the array.

        +
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns Float32Array

    • from(arrayLike, mapfn?, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: Iterable<number>

        An array-like or iterable object to convert to an array.

        -
      • Optional mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: number
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -

      Returns Float32Array

    Static of

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      -

      Parameters

      • Rest ...items: number[]

        A set of elements to include in the new array object.

        -

      Returns Float32Array

    Static

    Static LDU

    • LDU(L, D, U, a): (readonly [number, number, number, number] | Readonly<Float32Array>)[]

    • Returns L, D and U matrices (Lower triangular, Diagonal and Upper triangular) by factorizing the input matrix

      -

      Parameters

      Returns (readonly [number, number, number, number] | Readonly<Float32Array>)[]

    Static add

    • add(out, a, b): Mat2Like

    • Adds two Mat2's

      +
    • Optionalmapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

      +
        • (v, k): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array

    Staticof

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      +

      Parameters

      • Rest...items: number[]

        A set of elements to include in the new array object.

        +

      Returns Float32Array

    Static

    Staticadd

    Static adjoint

    • adjoint(out, a): Mat2Like

    • Calculates the adjugate of a Mat2

      +

    Staticadjoint

    Static clone

    • clone(a): Mat2

    • Creates a new Mat2 initialized with values from an existing matrix

      +

    Staticclone

    Static copy

    • copy(out, a): Mat2Like

    • Copy the values from one Mat2 to another

      +

    Staticcopy

    Static create

    • create(): Mat2

    • Creates a new, identity Mat2

      +

    Staticcreate

    Static determinant

    • determinant(a): number

    • Calculates the determinant of a Mat2

      +

    Staticdeterminant

    • determinant(a): number

    • Calculates the determinant of a Mat2

      Parameters

      Returns number

      determinant of a

      -

    Static equals

    • equals(a, b): boolean

    • Returns whether or not two Mat2s have approximately the same elements in the same position.

      +

    Staticequals

    • equals(a, b): boolean

    • Returns whether or not two Mat2s have approximately the same elements in the same position.

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    Static exactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not two Mat2s have exactly the same elements in the same position (when compared with ===)

      +

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not two Mat2s have exactly the same elements in the same position (when compared with ===)

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    Static frob

    • frob(a): number

    • Returns Frobenius norm of a Mat2

      +

    Staticfrob

    • frob(a): number

    • Returns Frobenius norm of a Mat2

      Parameters

      Returns number

      Frobenius norm

      -

    Static fromRotation

    • fromRotation(out, rad): Mat2Like

    • Creates a Mat2 from a given angle around a given axis +

    StaticfromRotation

    • fromRotation(out, rad): Mat2Like

    • Creates a Mat2 from a given angle around a given axis This is equivalent to (but much faster than):

      -
      mat2.identity(dest);
      mat2.rotate(dest, dest, rad);
-
      +
      mat2.identity(dest);
+mat2.rotate(dest, dest, rad);
+

      Parameters

      • out: Mat2Like

        Mat2 receiving operation result

      • rad: number

        the angle to rotate the matrix by

      Returns Mat2Like

      out

      -

    Static fromScaling

    • fromScaling(out, v): Mat2Like

    • Creates a Mat2 from a vector scaling +

    StaticfromScaling

    • fromScaling(out, v): Mat2Like

    • Creates a Mat2 from a vector scaling This is equivalent to (but much faster than):

      -
      mat2.identity(dest);
      mat2.scale(dest, dest, vec);
-
      +
      mat2.identity(dest);
+mat2.scale(dest, dest, vec);
+

      Parameters

      Returns Mat2Like

      out

      -

    Static fromValues

    • fromValues(...values): Mat2

    • Create a new Mat2 with the given values

      -

      Parameters

      • Rest ...values: number[]

        Matrix components

        +

    StaticfromValues

    • fromValues(...values): Mat2

    • Create a new Mat2 with the given values

      +

      Parameters

      • Rest...values: number[]

        Matrix components

      Returns Mat2

      A new Mat2

      -

    Static identity

    Staticidentity

    Static invert

    Staticinvert

    Static mul

    Static multiply

    Returns Mat2Like

    out or null if the matrix is not invertable

    +

    StaticLDU

    Staticmul

    Staticmultiply

    Static multiplyScalar

    • multiplyScalar(out, a, b): Mat2Like

    • Multiply each element of a Mat2 by a scalar.

      +

    StaticmultiplyScalar

    • multiplyScalar(out, a, b): Mat2Like

    • Multiply each element of a Mat2 by a scalar.

      Parameters

      • out: Mat2Like

        the receiving matrix

      • a: Readonly<Mat2Like>

        the matrix to scale

      • b: number

        amount to scale the matrix's elements by

      Returns Mat2Like

      out

      -

    Static multiplyScalarAndAdd

    • multiplyScalarAndAdd(out, a, b, scale): Mat2Like

    • Adds two Mat2's after multiplying each element of the second operand by a scalar value.

      +

    StaticmultiplyScalarAndAdd

    • multiplyScalarAndAdd(out, a, b, scale): Mat2Like

    • Adds two Mat2's after multiplying each element of the second operand by a scalar value.

      Parameters

      Returns Mat2Like

      out

      -

    Static rotate

    • rotate(out, a, rad): Mat2Like

    • Rotates a Mat2 by the given angle

      +

    Staticrotate

    Static scale

    Staticscale

    Static set

    • set(out, ...values): Mat2Like

    • Set the components of a Mat2 to the given values

      +

    Staticset

    • set(out, ...values): Mat2Like

    • Set the components of a Mat2 to the given values

      Parameters

      • out: Mat2Like

        The receiving matrix

        -
      • Rest ...values: number[]

        Matrix components

        +
      • Rest...values: number[]

        Matrix components

      Returns Mat2Like

      out

      -

    Static str

    • str(a): string

    • Returns a string representation of a Mat2

      +

    Staticstr

    • str(a): string

    • Returns a string representation of a Mat2

      Parameters

      Returns string

      string representation of the matrix

      -

    Static sub

    Static subtract

    • subtract(out, a, b): Mat2Like

    • Subtracts matrix b from matrix a

      +

    Staticsub

    Staticsubtract

    Static transpose

    Statictranspose

    Settings

    Member Visibility

    Theme

    On This Page

    constructorBYTES_PER_ELEMENT[toStringTag]bufferbyteLengthbyteOffsetlengthBYTES_PER_ELEMENTBYTE_LENGTHstr[iterator]atcopycopyWithinentrieseveryfillfilterfindfindIndexforEachidentityincludesindexOfinvertjoinkeyslastIndexOfmapmulmultiplyreducereduceRightreverserotatescalesetslicesomesortsubarraytoLocaleStringtoStringtransposevalueOfvaluesfromofLDUaddadjointclonecopycreatedeterminantequalsexactEqualsfrobfromRotationfromScalingfromValuesidentityinvertmulmultiplymultiplyScalarmultiplyScalarAndAddrotatescalesetstrsubsubtracttranspose
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Other
    Static
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_gl_matrix.Mat2d.html b/docs/classes/_runtime_math_gl_matrix.Mat2d.html index 7429f709..1693cf5a 100644 --- a/docs/classes/_runtime_math_gl_matrix.Mat2d.html +++ b/docs/classes/_runtime_math_gl_matrix.Mat2d.html @@ -1,14 +1,25 @@ -Mat2d | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Mat2d

    A 2x3 Matrix

    -

    Hierarchy

    Other

    constructor -BYTES_PER_ELEMENT +Mat2d | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Mat2d

    A 2x3 Matrix

    +
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Other

    constructor [toStringTag] buffer byteLength byteOffset +BYTES_PER_ELEMENT length BYTES_PER_ELEMENT -BYTE_LENGTH str +BYTE_LENGTH [iterator] at copy @@ -71,17 +82,17 @@ sub subtract translate -

    Other

    constructor

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Float32Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Static Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Static Readonly BYTE_LENGTH

    BYTE_LENGTH: number

    The number of bytes in a Mat2d.

    -

    str

    • get str(): string

    • A string representation of this +

    Other

    constructor

    Readonly[toStringTag]

    [toStringTag]: "Float32Array"

    Readonlybuffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    ReadonlybyteLength

    byteLength: number

    The length in bytes of the array.

    +

    ReadonlybyteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Readonlylength

    length: number

    The length of the array.

    +

    Static ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    str

    • get str(): string

    • A string representation of this Equivalent to Mat2d.str(this);

      -

      Returns string

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      +

      Returns string

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Mat2d.

      +

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

      Returns number

    copy

    • copy(a): Mat2d

    • Copy the values from another Mat2d into this.

      Parameters

      • a: Readonly<Mat2dLike>

        the source vector

        @@ -92,67 +103,67 @@ length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

        -
      • Optional end: number

        If not specified, length of the this object is used as its default value.

        +
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    fill

    • fill(value, start?, end?): this

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter(predicate, thisArg?): Float32Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => any)

          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

          -
            • (value, index, array): any

            • Parameters

              Returns any

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): any

            • Parameters

              Returns any

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    find

    • find(predicate, thisArg?): number

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): void

            • Parameters

              Returns void

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): void

            • Parameters

              Returns void

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    identity

    • identity(): Mat2d

    • Set this to the identity matrix Equivalent to Mat2d.identity(this)

      Returns Mat2d

      this

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +
      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        +
      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      Returns number

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +

        Parameters

        • Optionalseparator: string

          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

        Returns string

    keys

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    map

    • map(callbackfn, thisArg?): Float32Array

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => number)

          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): number

            • Parameters

              Returns number

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): number

            • Parameters

              Returns number

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    mul

    multiply

    • multiply(b): Mat2d

    • Multiplies this Mat2d against another one @@ -162,12 +173,12 @@

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduce(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduce<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array. The return value of +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -175,12 +186,12 @@

        Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduceRight(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduceRight<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array, in descending order. +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -196,26 +207,27 @@

        Returns Mat2d

        this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +
      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    slice

    • slice(start?, end?): Float32Array

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

        Parameters

        • Optionalstart: number

          The beginning of the specified portion of the array.

          +
        • Optionalend: number

          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        Returns Float32Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    sort

    • sort(compareFn?): this

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +

        Parameters

        • OptionalcompareFn: ((a: number, b: number) => number)

          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

          -
          [11,2,22,1].sort((a, b) => a - b)
-
          +
          [11,2,22,1].sort((a, b) => a - b)
+
          +
            • (a, b): number

            • Parameters

              • a: number
              • b: number

              Returns number

        Returns this

    subarray

    • subarray(begin?, end?): Float32Array

    • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        +

        Parameters

        • Optionalbegin: number

          The index of the beginning of the array.

          +
        • Optionalend: number

          The index of the end of the array.

        Returns Float32Array

    toLocaleString

    • toLocaleString(): string

    • Converts a number to a string by using the current locale.

      Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      Returns string

    translate

    • translate(v): Mat2d

    • Translate this Mat2d by the given vector @@ -224,120 +236,123 @@

    Returns Mat2d

    this

    valueOf

    • valueOf(): Float32Array

    • Returns the primitive value of the specified object.

      Returns Float32Array

    values

    Static from

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      +

      Returns IterableIterator<number>

    Staticfrom

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<number>

        An array-like or iterable object to convert to an array.

      Returns Float32Array

    • from<T>(arrayLike, mapfn, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like or iterable object to convert to an array.

        -
      • mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        +
      • mapfn: ((v: T, k: number) => number)

        A mapping function to call on every element of the array.

        +
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns Float32Array

    • from(arrayLike, mapfn?, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: Iterable<number>

        An array-like or iterable object to convert to an array.

        -
      • Optional mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: number
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -

      Returns Float32Array

    Static of

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      -

      Parameters

      • Rest ...items: number[]

        A set of elements to include in the new array object.

        -

      Returns Float32Array

    Static

    Static add

    • add(out, a, b): Mat2dLike

    • Adds two Mat2d's

      +
    • Optionalmapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

      +
        • (v, k): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array

    Staticof

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      +

      Parameters

      • Rest...items: number[]

        A set of elements to include in the new array object.

        +

      Returns Float32Array

    Static

    Staticadd

    Static clone

    • clone(a): Mat2d

    • Creates a new Mat2d initialized with values from an existing matrix

      +

    Staticclone

    Static copy

    Staticcopy

    Static create

    Staticcreate

    Static determinant

    • determinant(a): number

    • Calculates the determinant of a Mat2d

      +

    Staticdeterminant

    • determinant(a): number

    • Calculates the determinant of a Mat2d

      Parameters

      Returns number

      determinant of a

      -

    Static equals

    • equals(a, b): boolean

    • Returns whether or not two Mat2ds have approximately the same elements in the same position.

      +

    Staticequals

    • equals(a, b): boolean

    • Returns whether or not two Mat2ds have approximately the same elements in the same position.

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    Static exactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not two Mat2ds have exactly the same elements in the same position (when compared with ===)

      +

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not two Mat2ds have exactly the same elements in the same position (when compared with ===)

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    Static frob

    • frob(a): number

    • Returns Frobenius norm of a Mat2d

      +

    Staticfrob

    • frob(a): number

    • Returns Frobenius norm of a Mat2d

      Parameters

      Returns number

      Frobenius norm

      -

    Static fromRotation

    • fromRotation(out, rad): Mat2dLike

    • Creates a Mat2d from a given angle around a given axis +

    StaticfromRotation

    • fromRotation(out, rad): Mat2dLike

    • Creates a Mat2d from a given angle around a given axis This is equivalent to (but much faster than):

      -
      Mat2d.identity(dest);
      Mat2d.rotate(dest, dest, rad);
-
      +
      Mat2d.identity(dest);
+Mat2d.rotate(dest, dest, rad);
+

      Parameters

      • out: Mat2dLike

        Mat2d receiving operation result

      • rad: number

        the angle to rotate the matrix by

      Returns Mat2dLike

      out

      -

    Static fromScaling

    StaticfromScaling

    • fromScaling(out, v): Mat2dLike

    • Creates a Mat2d from a vector scaling This is equivalent to (but much faster than):

      -
      Mat2d.identity(dest);
      Mat2d.scale(dest, dest, vec);
-
      +
      Mat2d.identity(dest);
+Mat2d.scale(dest, dest, vec);
+

      Parameters

      Returns Mat2dLike

      out

      -

    Static fromTranslation

    • fromTranslation(out, v): Mat2dLike

    • Creates a Mat2d from a vector translation +

    StaticfromTranslation

    • fromTranslation(out, v): Mat2dLike

    • Creates a Mat2d from a vector translation This is equivalent to (but much faster than):

      -
      Mat2d.identity(dest);
      Mat2d.translate(dest, dest, vec);
-
      +
      Mat2d.identity(dest);
+Mat2d.translate(dest, dest, vec);
+

      Parameters

      Returns Mat2dLike

      out

      -

    Static fromValues

    • fromValues(...values): Mat2d

    • Create a new Mat2d with the given values

      -

      Parameters

      • Rest ...values: number[]

        Matrix components

        +

    StaticfromValues

    • fromValues(...values): Mat2d

    • Create a new Mat2d with the given values

      +

      Parameters

      • Rest...values: number[]

        Matrix components

      Returns Mat2d

      A new Mat2d

      -

    Static identity

    Staticidentity

    Static invert

    Staticinvert

    Static mul

    Static multiply

    Returns Mat2dLike

    out or null if the matrix is not invertable

    +

    Staticmul

    Staticmultiply

    Static multiplyScalar

    • multiplyScalar(out, a, b): Mat2dLike

    • Multiply each element of a Mat2d by a scalar.

      +

    StaticmultiplyScalar

    Static multiplyScalarAndAdd

    • multiplyScalarAndAdd(out, a, b, scale): Mat2dLike

    • Adds two Mat2d's after multiplying each element of the second operand by a scalar value.

      +

    StaticmultiplyScalarAndAdd

    • multiplyScalarAndAdd(out, a, b, scale): Mat2dLike

    • Adds two Mat2d's after multiplying each element of the second operand by a scalar value.

      Parameters

      Returns Mat2dLike

      out

      -

    Static rotate

    Staticrotate

    Static scale

    Staticscale

    Static set

    • set(out, ...values): Mat2dLike

    • Set the components of a Mat2d to the given values

      +

    Staticset

    • set(out, ...values): Mat2dLike

    • Set the components of a Mat2d to the given values

      Parameters

      • out: Mat2dLike

        The receiving matrix

        -
      • Rest ...values: number[]

        Matrix components

        +
      • Rest...values: number[]

        Matrix components

      Returns Mat2dLike

      out

      -

    Static str

    • str(a): string

    • Returns a string representation of a Mat2d

      +

    Staticstr

    • str(a): string

    • Returns a string representation of a Mat2d

      Parameters

      Returns string

      string representation of the matrix

      -

    Static sub

    Static subtract

    • subtract(out, a, b): Mat2dLike

    • Subtracts matrix b from matrix a

      +

    Staticsub

    Staticsubtract

    Static translate

    • translate(out, a, v): Mat2dLike

    • Translate a Mat2d by the given vector

      +

    Statictranslate

    Settings

    Member Visibility

    Theme

    On This Page

    constructorBYTES_PER_ELEMENT[toStringTag]bufferbyteLengthbyteOffsetlengthBYTES_PER_ELEMENTBYTE_LENGTHstr[iterator]atcopycopyWithinentrieseveryfillfilterfindfindIndexforEachidentityincludesindexOfjoinkeyslastIndexOfmapmulmultiplyreducereduceRightreverserotatescalesetslicesomesortsubarraytoLocaleStringtoStringtranslatevalueOfvaluesfromofaddclonecopycreatedeterminantequalsexactEqualsfrobfromRotationfromScalingfromTranslationfromValuesidentityinvertmulmultiplymultiplyScalarmultiplyScalarAndAddrotatescalesetstrsubsubtracttranslate
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Other
    Static
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_gl_matrix.Mat3.html b/docs/classes/_runtime_math_gl_matrix.Mat3.html index 04b3ec19..7e989d2c 100644 --- a/docs/classes/_runtime_math_gl_matrix.Mat3.html +++ b/docs/classes/_runtime_math_gl_matrix.Mat3.html @@ -1,14 +1,25 @@ -Mat3 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Mat3

    A 3x3 Matrix

    -

    Hierarchy

    Other

    constructor -BYTES_PER_ELEMENT +Mat3 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Mat3

    A 3x3 Matrix

    +
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Other

    constructor [toStringTag] buffer byteLength byteOffset +BYTES_PER_ELEMENT length BYTES_PER_ELEMENT -BYTE_LENGTH str +BYTE_LENGTH [iterator] at copy @@ -71,6 +82,7 @@ multiplyScalar multiplyScalarAndAdd normalFromMat4 +normalFromMat4Fast projection rotate scale @@ -80,17 +92,17 @@ subtract translate transpose -

    Other

    constructor

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Float32Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Static Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Static Readonly BYTE_LENGTH

    BYTE_LENGTH: number

    The number of bytes in a Mat3.

    -

    str

    • get str(): string

    • A string representation of this +

    Other

    constructor

    Readonly[toStringTag]

    [toStringTag]: "Float32Array"

    Readonlybuffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    ReadonlybyteLength

    byteLength: number

    The length in bytes of the array.

    +

    ReadonlybyteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Readonlylength

    length: number

    The length of the array.

    +

    Static ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    str

    • get str(): string

    • A string representation of this Equivalent to Mat3.str(this);

      -

      Returns string

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      +

      Returns string

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Mat3.

      +

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

      Returns number

    copy

    • copy(a): Mat3

    • Copy the values from another Mat3 into this.

      Parameters

      • a: Readonly<Mat3Like>

        the source vector

        @@ -101,70 +113,70 @@ length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

        -
      • Optional end: number

        If not specified, length of the this object is used as its default value.

        +
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    fill

    • fill(value, start?, end?): this

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter(predicate, thisArg?): Float32Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => any)

          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

          -
            • (value, index, array): any

            • Parameters

              Returns any

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): any

            • Parameters

              Returns any

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    find

    • find(predicate, thisArg?): number

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): void

            • Parameters

              Returns void

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): void

            • Parameters

              Returns void

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    identity

    • identity(): Mat3

    • Set this to the identity matrix Equivalent to Mat3.identity(this)

      Returns Mat3

      this

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +
      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        +
      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      Returns number

    invert

    • invert(): Mat3

    • Inverts this Mat3 Equivalent to Mat4.invert(this, this);

      Returns Mat3

      this

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +

        Parameters

        • Optionalseparator: string

          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

        Returns string

    keys

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    map

    • map(callbackfn, thisArg?): Float32Array

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => number)

          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): number

            • Parameters

              Returns number

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): number

            • Parameters

              Returns number

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    mul

    multiply

    • multiply(b): Mat3

    • Multiplies this Mat3 against another one @@ -174,12 +186,12 @@

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduce(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduce<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array. The return value of +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -187,12 +199,12 @@

        Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduceRight(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduceRight<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array, in descending order. +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -208,26 +220,27 @@

        Returns Mat3

        this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +
      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    slice

    • slice(start?, end?): Float32Array

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

        Parameters

        • Optionalstart: number

          The beginning of the specified portion of the array.

          +
        • Optionalend: number

          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        Returns Float32Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    sort

    • sort(compareFn?): this

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +

        Parameters

        • OptionalcompareFn: ((a: number, b: number) => number)

          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

          -
          [11,2,22,1].sort((a, b) => a - b)
-
          +
          [11,2,22,1].sort((a, b) => a - b)
+
          +
            • (a, b): number

            • Parameters

              • a: number
              • b: number

              Returns number

        Returns this

    subarray

    • subarray(begin?, end?): Float32Array

    • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        +

        Parameters

        • Optionalbegin: number

          The index of the beginning of the array.

          +
        • Optionalend: number

          The index of the end of the array.

        Returns Float32Array

    toLocaleString

    • toLocaleString(): string

    • Converts a number to a string by using the current locale.

      Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      Returns string

    translate

    • translate(v): Mat3

    • Translate this Mat3 by the given vector @@ -239,151 +252,161 @@

      Returns Mat3

      this

    valueOf

    • valueOf(): Float32Array

    • Returns the primitive value of the specified object.

      Returns Float32Array

    values

    Static from

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      +

      Returns IterableIterator<number>

    Staticfrom

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<number>

        An array-like or iterable object to convert to an array.

      Returns Float32Array

    • from<T>(arrayLike, mapfn, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like or iterable object to convert to an array.

        -
      • mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        +
      • mapfn: ((v: T, k: number) => number)

        A mapping function to call on every element of the array.

        +
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns Float32Array

    • from(arrayLike, mapfn?, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: Iterable<number>

        An array-like or iterable object to convert to an array.

        -
      • Optional mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: number
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -

      Returns Float32Array

    Static fromQuat

    • fromQuat(out, q): Mat3Like

    • Calculates a Mat3 from the given quaternion

      +
    • Optionalmapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

      +
        • (v, k): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array

    StaticfromQuat

    Static of

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      -

      Parameters

      • Rest ...items: number[]

        A set of elements to include in the new array object.

        -

      Returns Float32Array

    Static

    Static add

    Staticof

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      +

      Parameters

      • Rest...items: number[]

        A set of elements to include in the new array object.

        +

      Returns Float32Array

    Static

    Staticadd

    Static adjoint

    • adjoint(out, a): Mat3Like

    • Calculates the adjugate of a Mat3

      +

    Staticadjoint

    Static clone

    • clone(a): Mat3

    • Creates a new Mat3 initialized with values from an existing matrix

      +

    Staticclone

    Static copy

    • copy(out, a): Mat3Like

    • Copy the values from one Mat3 to another

      +

    Staticcopy

    Static create

    • create(): Mat3

    • Creates a new, identity Mat3

      +

    Staticcreate

    Static determinant

    • determinant(a): number

    • Calculates the determinant of a Mat3

      +

    Staticdeterminant

    • determinant(a): number

    • Calculates the determinant of a Mat3

      Parameters

      Returns number

      determinant of a

      -

    Static equals

    • equals(a, b): boolean

    • Returns whether or not two Mat3s have approximately the same elements in the same position.

      +

    Staticequals

    • equals(a, b): boolean

    • Returns whether or not two Mat3s have approximately the same elements in the same position.

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    Static exactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not two Mat3s have exactly the same elements in the same position (when compared with ===)

      +

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not two Mat3s have exactly the same elements in the same position (when compared with ===)

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    Static frob

    • frob(a): number

    • Returns Frobenius norm of a Mat3

      +

    Staticfrob

    • frob(a): number

    • Returns Frobenius norm of a Mat3

      Parameters

      Returns number

      Frobenius norm

      -

    Static fromMat2d

    • fromMat2d(out, a): Mat3Like

    • Copies the upper-left 3x3 values of a Mat2d into the given +

    StaticfromMat2d

    Static fromMat4

    • fromMat4(out, a): Mat3Like

    • Copies the upper-left 3x3 values of a Mat4 into the given +

    StaticfromMat4

    Static fromRotation

    • fromRotation(out, rad): Mat3Like

    • Creates a Mat3 from a given angle around a given axis +

    StaticfromRotation

    • fromRotation(out, rad): Mat3Like

    • Creates a Mat3 from a given angle around a given axis This is equivalent to (but much faster than):

      -
      mat3.identity(dest);
      mat3.rotate(dest, dest, rad);
-
      +
      mat3.identity(dest);
+mat3.rotate(dest, dest, rad);
+

      Parameters

      • out: Mat3Like

        Mat3 receiving operation result

      • rad: number

        the angle to rotate the matrix by

      Returns Mat3Like

      out

      -

    Static fromScaling

    • fromScaling(out, v): Mat3Like

    • Creates a Mat3 from a vector scaling +

    StaticfromScaling

    • fromScaling(out, v): Mat3Like

    • Creates a Mat3 from a vector scaling This is equivalent to (but much faster than):

      -
      mat3.identity(dest);
      mat3.scale(dest, dest, vec);
-
      +
      mat3.identity(dest);
+mat3.scale(dest, dest, vec);
+

      Parameters

      Returns Mat3Like

      out

      -

    Static fromTranslation

    • fromTranslation(out, v): Mat3Like

    • Creates a Mat3 from a vector translation +

    StaticfromTranslation

    • fromTranslation(out, v): Mat3Like

    • Creates a Mat3 from a vector translation This is equivalent to (but much faster than):

      -
      mat3.identity(dest);
      mat3.translate(dest, dest, vec);
-
      +
      mat3.identity(dest);
+mat3.translate(dest, dest, vec);
+

      Parameters

      Returns Mat3Like

      out

      -

    Static fromValues

    • fromValues(...values): Mat3

    • Create a new Mat3 with the given values

      -

      Parameters

      • Rest ...values: number[]

        Matrix components

        +

    StaticfromValues

    • fromValues(...values): Mat3

    • Create a new Mat3 with the given values

      +

      Parameters

      • Rest...values: number[]

        Matrix components

      Returns Mat3

      A new Mat3

      -

    Static identity

    Staticidentity

    Static invert

    Staticinvert

    Static mul

    Static multiply

    Returns Mat3Like

    out or null if the matrix is not invertable

    +

    Staticmul

    Staticmultiply

    Static multiplyScalar

    • multiplyScalar(out, a, b): Mat3Like

    • Multiply each element of a Mat3 by a scalar.

      +

    StaticmultiplyScalar

    • multiplyScalar(out, a, b): Mat3Like

    • Multiply each element of a Mat3 by a scalar.

      Parameters

      • out: Mat3Like

        the receiving matrix

      • a: Readonly<Mat3Like>

        the matrix to scale

      • b: number

        amount to scale the matrix's elements by

      Returns Mat3Like

      out

      -

    Static multiplyScalarAndAdd

    • multiplyScalarAndAdd(out, a, b, scale): Mat3Like

    • Adds two Mat3's after multiplying each element of the second operand by a scalar value.

      +

    StaticmultiplyScalarAndAdd

    • multiplyScalarAndAdd(out, a, b, scale): Mat3Like

    • Adds two Mat3's after multiplying each element of the second operand by a scalar value.

      Parameters

      Returns Mat3Like

      out

      -

    Static normalFromMat4

    • normalFromMat4(out, a): Mat3Like

    • Calculates a 3x3 normal matrix (transpose inverse) from the 4x4 matrix

      +

    StaticnormalFromMat4

    • normalFromMat4(out, a): Mat3Like

    • Calculates a 3x3 normal matrix (transpose inverse) from the 4x4 matrix

      Parameters

      Returns Mat3Like

      out or null if the matrix is not invertable

      +

    StaticnormalFromMat4Fast

    Static projection

    • projection(out, width, height): Mat3Like

    • Generates a 2D projection matrix with the given bounds

      +

    Staticprojection

    • projection(out, width, height): Mat3Like

    • Generates a 2D projection matrix with the given bounds

      Parameters

      • out: Mat3Like

        mat3 frustum matrix will be written into

      • width: number

        Width of your gl context

      • height: number

        Height of gl context

      Returns Mat3Like

      out

      -

    Static rotate

    • rotate(out, a, rad): Mat3Like

    • Rotates a Mat3 by the given angle

      +

    Staticrotate

    Static scale

    Staticscale

    Static set

    • set(out, ...values): Mat3Like

    • Set the components of a Mat3 to the given values

      +

    Staticset

    • set(out, ...values): Mat3Like

    • Set the components of a Mat3 to the given values

      Parameters

      • out: Mat3Like

        The receiving matrix

        -
      • Rest ...values: number[]

        Matrix components

        +
      • Rest...values: number[]

        Matrix components

      Returns Mat3Like

      out

      -

    Static str

    • str(a): string

    • Returns a string representation of a Mat3

      +

    Staticstr

    • str(a): string

    • Returns a string representation of a Mat3

      Parameters

      Returns string

      string representation of the matrix

      -

    Static sub

    Static subtract

    • subtract(out, a, b): Mat3Like

    • Subtracts matrix b from matrix a

      +

    Staticsub

    Staticsubtract

    Static translate

    • translate(out, a, v): Mat3Like

    • Translate a Mat3 by the given vector

      +

    Statictranslate

    Static transpose

    Statictranspose

    Settings

    Member Visibility

    Theme

    On This Page

    constructorBYTES_PER_ELEMENT[toStringTag]bufferbyteLengthbyteOffsetlengthBYTES_PER_ELEMENTBYTE_LENGTHstr[iterator]atcopycopyWithinentrieseveryfillfilterfindfindIndexforEachidentityincludesindexOfinvertjoinkeyslastIndexOfmapmulmultiplyreducereduceRightreverserotatescalesetslicesomesortsubarraytoLocaleStringtoStringtranslatetransposevalueOfvaluesfromfromQuatofaddadjointclonecopycreatedeterminantequalsexactEqualsfrobfromMat2dfromMat4fromRotationfromScalingfromTranslationfromValuesidentityinvertmulmultiplymultiplyScalarmultiplyScalarAndAddnormalFromMat4projectionrotatescalesetstrsubsubtracttranslatetranspose
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Other
    Static
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_gl_matrix.Mat4.html b/docs/classes/_runtime_math_gl_matrix.Mat4.html index 18a1a31c..6308016b 100644 --- a/docs/classes/_runtime_math_gl_matrix.Mat4.html +++ b/docs/classes/_runtime_math_gl_matrix.Mat4.html @@ -1,14 +1,25 @@ -Mat4 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Mat4

    A 4x4 Matrix

    -

    Hierarchy

    Other

    constructor -BYTES_PER_ELEMENT +Mat4 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Mat4

    A 4x4 Matrix

    +
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Other

    constructor [toStringTag] buffer byteLength byteOffset +BYTES_PER_ELEMENT length BYTES_PER_ELEMENT -BYTE_LENGTH str +BYTE_LENGTH [iterator] at copy @@ -77,7 +88,9 @@ fromXRotation fromYRotation fromZRotation -frustum +frustum +frustumNO +frustumZO getRotation getScaling getTranslation @@ -88,6 +101,8 @@ multiply multiplyScalar multiplyScalarAndAdd +normalFromMat4 +normalFromMat4Fast ortho orthoNO orthoZO @@ -107,17 +122,17 @@ targetTo translate transpose -

    Other

    constructor

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Float32Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Static Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Static Readonly BYTE_LENGTH

    BYTE_LENGTH: number

    The number of bytes in a Mat4.

    -

    str

    • get str(): string

    • A string representation of this +

    Other

    constructor

    Readonly[toStringTag]

    [toStringTag]: "Float32Array"

    Readonlybuffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    ReadonlybyteLength

    byteLength: number

    The length in bytes of the array.

    +

    ReadonlybyteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Readonlylength

    length: number

    The length of the array.

    +

    Static ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    str

    • get str(): string

    • A string representation of this Equivalent to Mat4.str(this);

      -

      Returns string

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      +

      Returns string

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Mat4.

      +

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

      Returns number

    copy

    • copy(a): Mat4

    • Copy the values from another Mat4 into this.

      Parameters

      • a: Readonly<Mat4Like>

        the source vector

        @@ -128,70 +143,70 @@ length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

        -
      • Optional end: number

        If not specified, length of the this object is used as its default value.

        +
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    fill

    • fill(value, start?, end?): this

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter(predicate, thisArg?): Float32Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => any)

          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

          -
            • (value, index, array): any

            • Parameters

              Returns any

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): any

            • Parameters

              Returns any

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    find

    • find(predicate, thisArg?): number

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): void

            • Parameters

              Returns void

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): void

            • Parameters

              Returns void

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    identity

    • identity(): Mat4

    • Set this to the identity matrix Equivalent to Mat4.identity(this)

      Returns Mat4

      this

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +
      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        +
      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      Returns number

    invert

    • invert(): Mat4

    • Inverts this Mat4 Equivalent to Mat4.invert(this, this);

      Returns Mat4

      this

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +

        Parameters

        • Optionalseparator: string

          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

        Returns string

    keys

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    map

    • map(callbackfn, thisArg?): Float32Array

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => number)

          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): number

            • Parameters

              Returns number

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): number

            • Parameters

              Returns number

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    mul

    multiply

    • multiply(b): Mat4

    • Multiplies this Mat4 against another one @@ -243,12 +258,12 @@

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduce(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduce<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array. The return value of +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -256,12 +271,12 @@

        Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduceRight(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduceRight<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array, in descending order. +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -290,26 +305,27 @@

        Returns Mat4

        this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +
      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    slice

    • slice(start?, end?): Float32Array

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

        Parameters

        • Optionalstart: number

          The beginning of the specified portion of the array.

          +
        • Optionalend: number

          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        Returns Float32Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    sort

    • sort(compareFn?): this

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +

        Parameters

        • OptionalcompareFn: ((a: number, b: number) => number)

          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

          -
          [11,2,22,1].sort((a, b) => a - b)
-
          +
          [11,2,22,1].sort((a, b) => a - b)
+
          +
            • (a, b): number

            • Parameters

              • a: number
              • b: number

              Returns number

        Returns this

    subarray

    • subarray(begin?, end?): Float32Array

    • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        +

        Parameters

        • Optionalbegin: number

          The index of the beginning of the array.

          +
        • Optionalend: number

          The index of the end of the array.

        Returns Float32Array

    toLocaleString

    • toLocaleString(): string

    • Converts a number to a string by using the current locale.

      Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      Returns string

    translate

    • translate(v): Mat4

    • Translate this Mat4 by the given vector @@ -321,203 +337,253 @@

      Returns Mat4

      this

    valueOf

    • valueOf(): Float32Array

    • Returns the primitive value of the specified object.

      Returns Float32Array

    values

    Static from

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      +

      Returns IterableIterator<number>

    Staticfrom

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<number>

        An array-like or iterable object to convert to an array.

      Returns Float32Array

    • from<T>(arrayLike, mapfn, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like or iterable object to convert to an array.

        -
      • mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        +
      • mapfn: ((v: T, k: number) => number)

        A mapping function to call on every element of the array.

        +
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns Float32Array

    • from(arrayLike, mapfn?, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: Iterable<number>

        An array-like or iterable object to convert to an array.

        -
      • Optional mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: number
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -

      Returns Float32Array

    Static of

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      -

      Parameters

      • Rest ...items: number[]

        A set of elements to include in the new array object.

        -

      Returns Float32Array

    Static

    Static add

    • add(out, a, b): Mat4Like

    • Adds two Mat4's

      +
    • Optionalmapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

      +
        • (v, k): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array

    Staticof

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      +

      Parameters

      • Rest...items: number[]

        A set of elements to include in the new array object.

        +

      Returns Float32Array

    Static

    Staticadd

    Static adjoint

    • adjoint(out, a): Mat4Like

    • Calculates the adjugate of a Mat4

      +

    Staticadjoint

    Static clone

    • clone(a): Mat4

    • Creates a new Mat4 initialized with values from an existing matrix

      +

    Staticclone

    Static copy

    • copy(out, a): Mat4Like

    • Copy the values from one Mat4 to another

      +

    Staticcopy

    Static create

    • create(): Mat4

    • Creates a new, identity Mat4

      +

    Staticcreate

    Static decompose

    • decompose(out_r, out_t, out_s, mat): Vec4Like

    • Decomposes a transformation matrix into its rotation, translation +

    Staticdecompose

    • decompose(out_r, out_t, out_s, mat): Vec4Like

    • Decomposes a transformation matrix into its rotation, translation and scale components. Returns only the rotation component

      Parameters

      • out_r: Vec4Like

        Quaternion to receive the rotation component

      • out_t: Vec3Like

        Vector to receive the translation vector

      • out_s: Vec3Like

        Vector to receive the scaling factor

      • mat: Readonly<Mat4Like>

        Matrix to be decomposed (input)

      Returns Vec4Like

      out_r

      -

    Static determinant

    • determinant(a): number

    • Calculates the determinant of a Mat4

      +

    Staticdeterminant

    • determinant(a): number

    • Calculates the determinant of a Mat4

      Parameters

      Returns number

      determinant of a

      -

    Static equals

    • equals(a, b): boolean

    • Returns whether or not two Mat4s have approximately the same elements in the same position.

      +

    Staticequals

    • equals(a, b): boolean

    • Returns whether or not two Mat4s have approximately the same elements in the same position.

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    Static exactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not two Mat4s have exactly the same elements in the same position (when compared with ===)

      +

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not two Mat4s have exactly the same elements in the same position (when compared with ===)

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    Static frob

    • frob(a): number

    • Returns Frobenius norm of a Mat4

      +

    Staticfrob

    • frob(a): number

    • Returns Frobenius norm of a Mat4

      Parameters

      Returns number

      Frobenius norm

      -

    Static fromQuat

    • fromQuat(out, q): Mat4Like

    • Calculates a 4x4 matrix from the given quaternion

      +

    StaticfromQuat

    • fromQuat(out, q): Mat4Like

    • Calculates a 4x4 matrix from the given quaternion

      Parameters

      Returns Mat4Like

      out

      -

    Static fromQuat2

    StaticfromQuat2

    Static fromRotation

    • fromRotation(out, rad, axis): Mat4Like

    • Creates a Mat4 from a given angle around a given axis +

    StaticfromRotation

    • fromRotation(out, rad, axis): Mat4Like

    • Creates a Mat4 from a given angle around a given axis This is equivalent to (but much faster than):

      -
      mat4.identity(dest);
      mat4.rotate(dest, dest, rad, axis);
-
      +
      mat4.identity(dest);
+mat4.rotate(dest, dest, rad, axis);
+

      Parameters

      • out: Mat4Like

        Mat4 receiving operation result

      • rad: number

        the angle to rotate the matrix by

      • axis: Readonly<Vec3Like>

        the axis to rotate around

        -

      Returns Mat4Like

      out

      -

    Static fromRotationTranslation

    • fromRotationTranslation(out, q, v): Mat4Like

    • Creates a matrix from a quaternion rotation and vector translation +

    Returns Mat4Like

    out or null if axis has a length of 0

    +

    StaticfromRotationTranslation

    • fromRotationTranslation(out, q, v): Mat4Like

    • Creates a matrix from a quaternion rotation and vector translation This is equivalent to (but much faster than):

      -
      mat4.identity(dest);
      mat4.translate(dest, vec);
      let quatMat = mat4.create();
      quat4.toMat4(quat, quatMat);
      mat4.multiply(dest, quatMat);
-
      +
      mat4.identity(dest);
+mat4.translate(dest, vec);
+let quatMat = mat4.create();
+quat4.toMat4(quat, quatMat);
+mat4.multiply(dest, quatMat);
+

      Parameters

      Returns Mat4Like

      out

      -

    Static fromRotationTranslationScale

    • fromRotationTranslationScale(out, q, v, s): Mat4Like

    • Creates a matrix from a quaternion rotation, vector translation and vector scale +

    StaticfromRotationTranslationScale

    • fromRotationTranslationScale(out, q, v, s): Mat4Like

    • Creates a matrix from a quaternion rotation, vector translation and vector scale This is equivalent to (but much faster than):

      -
      mat4.identity(dest);
      mat4.translate(dest, vec);
      let quatMat = mat4.create();
      quat4.toMat4(quat, quatMat);
      mat4.multiply(dest, quatMat);
      mat4.scale(dest, scale);
-
      +
      mat4.identity(dest);
+mat4.translate(dest, vec);
+let quatMat = mat4.create();
+quat4.toMat4(quat, quatMat);
+mat4.multiply(dest, quatMat);
+mat4.scale(dest, scale);
+

      Parameters

      Returns Mat4Like

      out

      -

    Static fromRotationTranslationScaleOrigin

    • fromRotationTranslationScaleOrigin(out, q, v, s, o): Mat4Like

    • Creates a matrix from a quaternion rotation, vector translation and vector scale, rotating and scaling around the given origin +

    StaticfromRotationTranslationScaleOrigin

    • fromRotationTranslationScaleOrigin(out, q, v, s, o): Mat4Like

    • Creates a matrix from a quaternion rotation, vector translation and vector scale, rotating and scaling around the given origin This is equivalent to (but much faster than):

      -
      mat4.identity(dest);
      mat4.translate(dest, vec);
      mat4.translate(dest, origin);
      let quatMat = mat4.create();
      quat4.toMat4(quat, quatMat);
      mat4.multiply(dest, quatMat);
      mat4.scale(dest, scale)
      mat4.translate(dest, negativeOrigin);
-
      +
      mat4.identity(dest);
+mat4.translate(dest, vec);
+mat4.translate(dest, origin);
+let quatMat = mat4.create();
+quat4.toMat4(quat, quatMat);
+mat4.multiply(dest, quatMat);
+mat4.scale(dest, scale)
+mat4.translate(dest, negativeOrigin);
+

      Parameters

      Returns Mat4Like

      out

      -

    Static fromScaling

    • fromScaling(out, v): Mat4Like

    • Creates a Mat4 from a vector scaling +

    StaticfromScaling

    • fromScaling(out, v): Mat4Like

    • Creates a Mat4 from a vector scaling This is equivalent to (but much faster than):

      -
      mat4.identity(dest);
      mat4.scale(dest, dest, vec);
-
      +
      mat4.identity(dest);
+mat4.scale(dest, dest, vec);
+

      Parameters

      Returns Mat4Like

      out

      -

    Static fromTranslation

    • fromTranslation(out, v): Mat4Like

    • Creates a Mat4 from a vector translation +

    StaticfromTranslation

    • fromTranslation(out, v): Mat4Like

    • Creates a Mat4 from a vector translation This is equivalent to (but much faster than):

      -
      mat4.identity(dest);
      mat4.translate(dest, dest, vec);
-
      +
      mat4.identity(dest);
+mat4.translate(dest, dest, vec);
+

      Parameters

      Returns Mat4Like

      out

      -

    Static fromValues

    • fromValues(...values): Mat4

    • Create a new mat4 with the given values

      -

      Parameters

      • Rest ...values: number[]

        Matrix components

        +

    StaticfromValues

    • fromValues(...values): Mat4

    • Create a new mat4 with the given values

      +

      Parameters

      • Rest...values: number[]

        Matrix components

      Returns Mat4

      A new Mat4

      -

    Static fromXRotation

    • fromXRotation(out, rad): Mat4Like

    • Creates a matrix from the given angle around the X axis +

    StaticfromXRotation

    • fromXRotation(out, rad): Mat4Like

    • Creates a matrix from the given angle around the X axis This is equivalent to (but much faster than):

      -
      mat4.identity(dest);
      mat4.rotateX(dest, dest, rad);
-
      +
      mat4.identity(dest);
+mat4.rotateX(dest, dest, rad);
+

      Parameters

      • out: Mat4Like

        mat4 receiving operation result

      • rad: number

        the angle to rotate the matrix by

      Returns Mat4Like

      out

      -

    Static fromYRotation

    • fromYRotation(out, rad): Mat4Like

    • Creates a matrix from the given angle around the Y axis +

    StaticfromYRotation

    • fromYRotation(out, rad): Mat4Like

    • Creates a matrix from the given angle around the Y axis This is equivalent to (but much faster than):

      -
      mat4.identity(dest);
      mat4.rotateY(dest, dest, rad);
-
      +
      mat4.identity(dest);
+mat4.rotateY(dest, dest, rad);
+

      Parameters

      • out: Mat4Like

        mat4 receiving operation result

      • rad: number

        the angle to rotate the matrix by

      Returns Mat4Like

      out

      -

    Static fromZRotation

    • fromZRotation(out, rad): Mat4Like

    • Creates a matrix from the given angle around the Z axis +

    StaticfromZRotation

    • fromZRotation(out, rad): Mat4Like

    • Creates a matrix from the given angle around the Z axis This is equivalent to (but much faster than):

      -
      mat4.identity(dest);
      mat4.rotateZ(dest, dest, rad);
-
      +
      mat4.identity(dest);
+mat4.rotateZ(dest, dest, rad);
+

      Parameters

      • out: Mat4Like

        mat4 receiving operation result

      • rad: number

        the angle to rotate the matrix by

      Returns Mat4Like

      out

      -

    Static frustum

    • frustum(out, left, right, bottom, top, near, far): Mat4Like

    • Generates a frustum matrix with the given bounds

      +

    Staticfrustum

    StaticfrustumNO

    • frustumNO(out, left, right, bottom, top, near, far?): Mat4Like

    • Generates a frustum matrix with the given bounds +The near/far clip planes correspond to a normalized device coordinate Z range of [-1, 1], +which matches WebGL/OpenGL's clip volume. +Passing null/undefined/no value for far will generate infinite projection matrix.

      Parameters

      • out: Mat4Like

        mat4 frustum matrix will be written into

      • left: number

        Left bound of the frustum

      • right: number

        Right bound of the frustum

      • bottom: number

        Bottom bound of the frustum

      • top: number

        Top bound of the frustum

      • near: number

        Near bound of the frustum

        -
      • far: number

        Far bound of the frustum

        +
      • Optionalfar: number

        Far bound of the frustum, can be null or Infinity

        +

      Returns Mat4Like

      out

      +

    StaticfrustumZO

    • frustumZO(out, left, right, bottom, top, near, far?): Mat4Like

    • Generates a frustum matrix with the given bounds +The near/far clip planes correspond to a normalized device coordinate Z range of [0, 1], +which matches WebGPU/Vulkan/DirectX/Metal's clip volume. +Passing null/undefined/no value for far will generate infinite projection matrix.

      +

      Parameters

      • out: Mat4Like

        mat4 frustum matrix will be written into

        +
      • left: number

        Left bound of the frustum

        +
      • right: number

        Right bound of the frustum

        +
      • bottom: number

        Bottom bound of the frustum

        +
      • top: number

        Top bound of the frustum

        +
      • near: number

        Near bound of the frustum

        +
      • Optionalfar: number

        Far bound of the frustum, can be null or Infinity

      Returns Mat4Like

      out

      -

    Static getRotation

    • getRotation(out, mat): Vec4Like

    • Returns a quaternion representing the rotational component +

    StaticgetRotation

    • getRotation(out, mat): Vec4Like

    • Returns a quaternion representing the rotational component of a transformation matrix. If a matrix is built with fromRotationTranslation, the returned quaternion will be the same as the quaternion originally supplied.

      Parameters

      Returns Vec4Like

      out

      -

    Static getScaling

    • getScaling(out, mat): Vec3Like

    • Returns the scaling factor component of a transformation +

    StaticgetScaling

    • getScaling(out, mat): Vec3Like

    • Returns the scaling factor component of a transformation matrix. If a matrix is built with fromRotationTranslationScale -with a normalized Quaternion paramter, the returned vector will be +with a normalized Quaternion parameter, the returned vector will be the same as the scaling vector originally supplied.

      Parameters

      Returns Vec3Like

      out

      -

    Static getTranslation

    • getTranslation(out, mat): Vec3Like

    • Returns the translation vector component of a transformation +

    StaticgetTranslation

    • getTranslation(out, mat): Vec3Like

    • Returns the translation vector component of a transformation matrix. If a matrix is built with fromRotationTranslation, the returned vector will be the same as the translation vector originally supplied.

      Parameters

      Returns Vec3Like

      out

      -

    Static identity

    Staticidentity

    Static invert

    Staticinvert

    Static lookAt

    • lookAt(out, eye, center, up): Mat4Like

    • Generates a look-at matrix with the given eye position, focal point, and up axis. +

    Returns Mat4Like

    out or null if the matrix is not invertable

    +

    StaticlookAt

    • lookAt(out, eye, center, up): Mat4Like

    • Generates a look-at matrix with the given eye position, focal point, and up axis. If you want a matrix that actually makes an object look at another object, you should use targetTo instead.

      Parameters

      Returns Mat4Like

      out

      -

    Static mul

    Static multiply

    Staticmul

    Staticmultiply

    Static multiplyScalar

    • multiplyScalar(out, a, b): Mat4Like

    • Multiply each element of the matrix by a scalar.

      +

    StaticmultiplyScalar

    • multiplyScalar(out, a, b): Mat4Like

    • Multiply each element of the matrix by a scalar.

      Parameters

      • out: Mat4Like

        the receiving matrix

      • a: Readonly<Mat4Like>

        the matrix to scale

      • b: number

        amount to scale the matrix's elements by

      Returns Mat4Like

      out

      -

    Static multiplyScalarAndAdd

    • multiplyScalarAndAdd(out, a, b, scale): Mat4Like

    • Adds two mat4's after multiplying each element of the second operand by a scalar value.

      +

    StaticmultiplyScalarAndAdd

    • multiplyScalarAndAdd(out, a, b, scale): Mat4Like

    • Adds two mat4's after multiplying each element of the second operand by a scalar value.

      Parameters

      Returns Mat4Like

      out

      -

    Static ortho

    Static orthoNO

    • orthoNO(out, left, right, bottom, top, near, far): Mat4Like

    • Generates a orthogonal projection matrix with the given bounds. +

    StaticnormalFromMat4

    • normalFromMat4(out, a): Mat4Like

    • Calculates a Mat4 normal matrix (transpose inverse) from a Mat4

      +

      Parameters

      Returns Mat4Like

      out or null if the matrix is not invertable

      +

    StaticnormalFromMat4Fast

    Staticortho

    StaticorthoNO

    • orthoNO(out, left, right, bottom, top, near, far): Mat4Like

    • Generates a orthogonal projection matrix with the given bounds. The near/far clip planes correspond to a normalized device coordinate Z range of [-1, 1], which matches WebGL/OpenGL's clip volume.

      Parameters

      • out: Mat4Like

        mat4 frustum matrix will be written into

        @@ -528,7 +594,7 @@
      • near: number

        Near bound of the frustum

      • far: number

        Far bound of the frustum

      Returns Mat4Like

      out

      -

    Static orthoZO

    • orthoZO(out, left, right, bottom, top, near, far): Mat4Like

    • Generates a orthogonal projection matrix with the given bounds. +

    StaticorthoZO

    • orthoZO(out, left, right, bottom, top, near, far): Mat4Like

    • Generates a orthogonal projection matrix with the given bounds. The near/far clip planes correspond to a normalized device coordinate Z range of [0, 1], which matches WebGPU/Vulkan/DirectX/Metal's clip volume.

      Parameters

      • out: Mat4Like

        mat4 frustum matrix will be written into

        @@ -539,9 +605,9 @@
      • near: number

        Near bound of the frustum

      • far: number

        Far bound of the frustum

      Returns Mat4Like

      out

      -

    Static perspective

    Static perspectiveFromFieldOfView

    • perspectiveFromFieldOfView(out, fov, near, far): Mat4Like

    • Generates a perspective projection matrix with the given field of view. +

    Staticperspective

    StaticperspectiveFromFieldOfView

    • perspectiveFromFieldOfView(out, fov, near, far): Mat4Like

    • Generates a perspective projection matrix with the given field of view. This is primarily useful for generating projection matrices to be used with the still experiemental WebVR API.

      Parameters

      • out: Mat4Like

        mat4 frustum matrix will be written into

        @@ -549,7 +615,7 @@
      • near: number

        Near bound of the frustum

      • far: number

        Far bound of the frustum

      Returns Mat4Like

      out

      -

      Deprecated

    Static perspectiveNO

    • perspectiveNO(out, fovy, aspect, near, far): Mat4Like

    • Generates a perspective projection matrix with the given bounds. +

      Deprecated

    StaticperspectiveNO

    • perspectiveNO(out, fovy, aspect, near, far?): Mat4Like

    • Generates a perspective projection matrix with the given bounds. The near/far clip planes correspond to a normalized device coordinate Z range of [-1, 1], which matches WebGL/OpenGL's clip volume. Passing null/undefined/no value for far will generate infinite projection matrix.

      @@ -557,9 +623,9 @@
    • fovy: number

      Vertical field of view in radians

    • aspect: number

      Aspect ratio. typically viewport width/height

    • near: number

      Near bound of the frustum

      -
    • far: number

      Far bound of the frustum, can be null or Infinity

      +
    • Optionalfar: number

      Far bound of the frustum, can be null or Infinity

    Returns Mat4Like

    out

    -

    Static perspectiveZO

    • perspectiveZO(out, fovy, aspect, near, far): Mat4Like

    • Generates a perspective projection matrix suitable for WebGPU with the given bounds. +

    StaticperspectiveZO

    • perspectiveZO(out, fovy, aspect, near, far?): Mat4Like

    • Generates a perspective projection matrix suitable for WebGPU with the given bounds. The near/far clip planes correspond to a normalized device coordinate Z range of [0, 1], which matches WebGPU/Vulkan/DirectX/Metal's clip volume. Passing null/undefined/no value for far will generate infinite projection matrix.

      @@ -567,60 +633,60 @@
    • fovy: number

      Vertical field of view in radians

    • aspect: number

      Aspect ratio. typically viewport width/height

    • near: number

      Near bound of the frustum

      -
    • far: number

      Far bound of the frustum, can be null or Infinity

      +
    • Optionalfar: number

      Far bound of the frustum, can be null or Infinity

    Returns Mat4Like

    out

    -

    Static rotate

    • rotate(out, a, rad, axis): Mat4Like

    • Rotates a Mat4 by the given angle around the given axis

      +

    Staticrotate

    Static rotateX

    • rotateX(out, a, rad): Mat4Like

    • Rotates a matrix by the given angle around the X axis

      +

    Returns Mat4Like

    out or null if axis has a length of 0

    +

    StaticrotateX

    • rotateX(out, a, rad): Mat4Like

    • Rotates a matrix by the given angle around the X axis

      Parameters

      • out: Mat4Like

        the receiving matrix

      • a: Readonly<Mat4Like>

        the matrix to rotate

      • rad: number

        the angle to rotate the matrix by

      Returns Mat4Like

      out

      -

    Static rotateY

    • rotateY(out, a, rad): Mat4Like

    • Rotates a matrix by the given angle around the Y axis

      +

    StaticrotateY

    • rotateY(out, a, rad): Mat4Like

    • Rotates a matrix by the given angle around the Y axis

      Parameters

      • out: Mat4Like

        the receiving matrix

      • a: Readonly<Mat4Like>

        the matrix to rotate

      • rad: number

        the angle to rotate the matrix by

      Returns Mat4Like

      out

      -

    Static rotateZ

    • rotateZ(out, a, rad): Mat4Like

    • Rotates a matrix by the given angle around the Z axis

      +

    StaticrotateZ

    • rotateZ(out, a, rad): Mat4Like

    • Rotates a matrix by the given angle around the Z axis

      Parameters

      • out: Mat4Like

        the receiving matrix

      • a: Readonly<Mat4Like>

        the matrix to rotate

      • rad: number

        the angle to rotate the matrix by

      Returns Mat4Like

      out

      -

    Static scale

    • scale(out, a, v): Mat4Like

    • Scales the Mat4 by the dimensions in the given Vec3 not using vectorization

      +

    Staticscale

    Static set

    • set(out, ...values): Mat4Like

    • Set the components of a mat4 to the given values

      +

    Staticset

    • set(out, ...values): Mat4Like

    • Set the components of a mat4 to the given values

      Parameters

      • out: Mat4Like

        The receiving matrix

        -
      • Rest ...values: number[]

        Matrix components

        +
      • Rest...values: number[]

        Matrix components

      Returns Mat4Like

      out

      -

    Static str

    • str(a): string

    • Returns a string representation of a Mat4

      +

    Staticstr

    • str(a): string

    • Returns a string representation of a Mat4

      Parameters

      Returns string

      string representation of the matrix

      -

    Static sub

    Static subtract

    • subtract(out, a, b): Mat4Like

    • Subtracts matrix b from matrix a

      +

    Staticsub

    Staticsubtract

    Static targetTo

    • targetTo(out, eye, target, up): Mat4Like

    • Generates a matrix that makes something look at something else.

      +

    StatictargetTo

    Static translate

    • translate(out, a, v): Mat4Like

    • Translate a Mat4 by the given vector

      +

    Statictranslate

    Static transpose

    Statictranspose

    Settings

    Member Visibility

    Theme

    On This Page

    constructorBYTES_PER_ELEMENT[toStringTag]bufferbyteLengthbyteOffsetlengthBYTES_PER_ELEMENTBYTE_LENGTHstr[iterator]atcopycopyWithinentrieseveryfillfilterfindfindIndexforEachidentityincludesindexOfinvertjoinkeyslastIndexOfmapmulmultiplyorthoNOorthoZOperspectiveNOperspectiveZOreducereduceRightreverserotaterotateXrotateYrotateZscalesetslicesomesortsubarraytoLocaleStringtoStringtranslatetransposevalueOfvaluesfromofaddadjointclonecopycreatedecomposedeterminantequalsexactEqualsfrobfromQuatfromQuat2fromRotationfromRotationTranslationfromRotationTranslationScalefromRotationTranslationScaleOriginfromScalingfromTranslationfromValuesfromXRotationfromYRotationfromZRotationfrustumgetRotationgetScalinggetTranslationidentityinvertlookAtmulmultiplymultiplyScalarmultiplyScalarAndAddorthoorthoNOorthoZOperspectiveperspectiveFromFieldOfViewperspectiveNOperspectiveZOrotaterotateXrotateYrotateZscalesetstrsubsubtracttargetTotranslatetranspose
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Other
    Static
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_gl_matrix.Quat.html b/docs/classes/_runtime_math_gl_matrix.Quat.html index 61a0f23d..9749f861 100644 --- a/docs/classes/_runtime_math_gl_matrix.Quat.html +++ b/docs/classes/_runtime_math_gl_matrix.Quat.html @@ -1,16 +1,27 @@ -Quat | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Quat

    Quaternion

    -

    Hierarchy

    Other

    constructor -BYTES_PER_ELEMENT +Quat | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Quat

    Quaternion

    +
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Other

    constructor [toStringTag] buffer byteLength byteOffset +BYTES_PER_ELEMENT length BYTES_PER_ELEMENT -BYTE_LENGTH mag magnitude str +BYTE_LENGTH [iterator] at copy @@ -95,22 +106,22 @@ sqrLen squaredLength str -

    Other

    constructor

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Float32Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Static Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Static Readonly BYTE_LENGTH

    BYTE_LENGTH: number

    The number of bytes in a Quat.

    -

    mag

    Other

    constructor

    Readonly[toStringTag]

    [toStringTag]: "Float32Array"

    Readonlybuffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    ReadonlybyteLength

    byteLength: number

    The length in bytes of the array.

    +

    ReadonlybyteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Readonlylength

    length: number

    The length of the array.

    +

    Static ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    mag

    magnitude

    • get magnitude(): number

    • The magnitude (length) of this. Equivalent to Quat.magnitude(this);

      Magnitude is used because the length attribute is already defined by -Float32Array to mean the number of elements in the array.

      +TypedArrays to mean the number of elements in the array.

      Returns number

    str

    • get str(): string

    • A string representation of this Equivalent to Quat.str(this);

      -

      Returns string

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      +

      Returns string

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Quat.

      +

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

      Returns number

    copy

    • copy(a): Quat

    • Copy the values from another Quat into this.

      Parameters

      • a: Readonly<Vec4Like>

        the source quaternion

        @@ -121,74 +132,74 @@ length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

        -
      • Optional end: number

        If not specified, length of the this object is used as its default value.

        +
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

      Returns this

    dot

    • dot(b): number

    • Calculates the dot product of this and another Quat Equivalent to Quat.dot(this, b);

      Parameters

      Returns number

      dot product of this and b

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    fill

    • fill(value, start?, end?): this

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter(predicate, thisArg?): Float32Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => any)

          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

          -
            • (value, index, array): any

            • Parameters

              Returns any

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): any

            • Parameters

              Returns any

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    find

    • find(predicate, thisArg?): number

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): void

            • Parameters

              Returns void

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): void

            • Parameters

              Returns void

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    identity

    • identity(): Quat

    • Set this to the identity quaternion Equivalent to Quat.identity(this)

      Returns Quat

      this

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +
      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        +
      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      Returns number

    invert

    • invert(): Quat

    • Inverts this Equivalent to Quat.invert(this, this);

      Returns Quat

      this

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +

        Parameters

        • Optionalseparator: string

          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

        Returns string

    keys

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    map

    • map(callbackfn, thisArg?): Float32Array

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => number)

          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): number

            • Parameters

              Returns number

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): number

            • Parameters

              Returns number

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    mul

    multiply

    • multiply(b): Quat

    • Multiplies this by a Quat. @@ -198,12 +209,12 @@

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduce(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduce<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array. The return value of +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -211,12 +222,12 @@

        Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduceRight(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduceRight<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array, in descending order. +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -240,214 +251,216 @@

        Returns Vec4Like

        this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +
      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    slice

    • slice(start?, end?): Float32Array

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

        Parameters

        • Optionalstart: number

          The beginning of the specified portion of the array.

          +
        • Optionalend: number

          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        Returns Float32Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    sort

    • sort(compareFn?): this

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +

        Parameters

        • OptionalcompareFn: ((a: number, b: number) => number)

          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

          -
          [11,2,22,1].sort((a, b) => a - b)
-
          +
          [11,2,22,1].sort((a, b) => a - b)
+
          +
            • (a, b): number

            • Parameters

              • a: number
              • b: number

              Returns number

        Returns this

    subarray

    • subarray(begin?, end?): Float32Array

    • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        +

        Parameters

        • Optionalbegin: number

          The index of the beginning of the array.

          +
        • Optionalend: number

          The index of the end of the array.

        Returns Float32Array

    toLocaleString

    • toLocaleString(): string

    • Converts a number to a string by using the current locale.

      Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      Returns string

    valueOf

    • valueOf(): Float32Array

    • Returns the primitive value of the specified object.

      Returns Float32Array

    values

    Static from

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      +

      Returns IterableIterator<number>

    Staticfrom

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<number>

        An array-like or iterable object to convert to an array.

      Returns Float32Array

    • from<T>(arrayLike, mapfn, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like or iterable object to convert to an array.

        -
      • mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        +
      • mapfn: ((v: T, k: number) => number)

        A mapping function to call on every element of the array.

        +
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns Float32Array

    • from(arrayLike, mapfn?, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: Iterable<number>

        An array-like or iterable object to convert to an array.

        -
      • Optional mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: number
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -

      Returns Float32Array

    Static of

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      -

      Parameters

      • Rest ...items: number[]

        A set of elements to include in the new array object.

        -

      Returns Float32Array

    Quaternion components

    w

    • get w(): number

    • The w component of the quaternion. Equivalent to this[3];

      +
    • Optionalmapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

      +
        • (v, k): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array

    Staticof

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      +

      Parameters

      • Rest...items: number[]

        A set of elements to include in the new array object.

        +

      Returns Float32Array

    Quaternion components

    w

    • get w(): number

    • The w component of the quaternion. Equivalent to this[3];

      Returns number

    • set w(value): void

    • Parameters

      • value: number

      Returns void

    x

    • get x(): number

    • The x component of the quaternion. Equivalent to this[0];

      Returns number

    • set x(value): void

    • Parameters

      • value: number

      Returns void

    y

    • get y(): number

    • The y component of the quaternion. Equivalent to this[1];

      Returns number

    • set y(value): void

    • Parameters

      • value: number

      Returns void

    z

    • get z(): number

    • The z component of the quaternion. Equivalent to this[2];

      -

      Returns number

    • set z(value): void

    • Parameters

      • value: number

      Returns void

    Static

    Static add

    • add(out, a, b): Vec4Like

    • Adds two Quat's

      +

      Returns number

    • set z(value): void

    • Parameters

      • value: number

      Returns void

    Static

    Staticadd

    Static calculateW

    • calculateW(out, a): Vec4Like

    • Calculates the W component of a quat from the X, Y, and Z components. +

    StaticcalculateW

    • calculateW(out, a): Vec4Like

    • Calculates the W component of a quat from the X, Y, and Z components. Assumes that quaternion is 1 unit in length. Any existing W component will be ignored.

      Parameters

      Returns Vec4Like

      out

      -

    Static clone

    • clone(a): Quat

    • Creates a new quat initialized with values from an existing quaternion

      +

    Staticclone

    • clone(a): Quat

    • Creates a new quat initialized with values from an existing quaternion

      Parameters

      Returns Quat

      a new quaternion

      -

    Static conjugate

    • conjugate(out, a): Vec4Like

    • Calculates the conjugate of a quat +

    Staticconjugate

    • conjugate(out, a): Vec4Like

    • Calculates the conjugate of a quat If the quaternion is normalized, this function is faster than quat.inverse and produces the same result.

      Parameters

      Returns Vec4Like

      out

      -

    Static copy

    • copy(out, a): Vec4Like

    • Copy the values from one quat to another

      +

    Staticcopy

    Static create

    • create(): Quat

    • Creates a new identity quat

      +

    Staticcreate

    • create(): Quat

    • Creates a new identity quat

      Returns Quat

      a new quaternion

      -

    Static dot

    • dot(a, b): number

    • Calculates the dot product of two quat's

      +

    Staticdot

    • dot(a, b): number

    • Calculates the dot product of two quat's

      Parameters

      Returns number

      dot product of a and b

      -

    Static equals

    • equals(a, b): boolean

    • Returns whether or not the quaternions have approximately the same elements in the same position.

      +

    Staticequals

    • equals(a, b): boolean

    • Returns whether or not the quaternions have approximately the same elements in the same position.

      Parameters

      Returns boolean

      True if the vectors are equal, false otherwise.

      -

    Static exactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the quaternions have exactly the same elements in the same position (when compared with ===)

      +

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the quaternions have exactly the same elements in the same position (when compared with ===)

      Parameters

      Returns boolean

      True if the vectors are equal, false otherwise.

      -

    Static exp

    • exp(out, a): Vec4Like

    • Calculate the exponential of a unit quaternion.

      +

    Staticexp

    Static fromEuler

    • fromEuler(out, x, y, z): Vec4Like

    • Creates a quaternion from the given euler angle x, y, z.

      +

    StaticfromEuler

    • fromEuler(out, x, y, z, order?): Vec4Like

    • Creates a quaternion from the given euler angle x, y, z.

      Parameters

      • out: Vec4Like

        the receiving quaternion

      • x: number

        Angle to rotate around X axis in degrees.

      • y: number

        Angle to rotate around Y axis in degrees.

      • z: number

        Angle to rotate around Z axis in degrees.

        +
      • Optionalorder: string

        Intrinsic order for conversion, default is zyx.

      Returns Vec4Like

      out

      -

    Static fromMat3

    • fromMat3(out, m): Vec4Like

    • Creates a quaternion from the given 3x3 rotation matrix.

      +

    StaticfromMat3

    • fromMat3(out, m): Vec4Like

    • Creates a quaternion from the given 3x3 rotation matrix.

      NOTE: The resultant quaternion is not normalized, so you should be sure to renormalize the quaternion yourself where necessary.

      Parameters

      Returns Vec4Like

      out

      -

    Static fromValues

    • fromValues(x, y, z, w): Quat

    • Creates a new quat initialized with the given values

      +

    StaticfromValues

    • fromValues(x, y, z, w): Quat

    • Creates a new quat initialized with the given values

      Parameters

      • x: number

        X component

      • y: number

        Y component

      • z: number

        Z component

      • w: number

        W component

      Returns Quat

      a new quaternion

      -

    Static getAngle

    • getAngle(a, b): number

    • Gets the angular distance between two unit quaternions

      +

    StaticgetAngle

    • getAngle(a, b): number

    • Gets the angular distance between two unit quaternions

      Parameters

      Returns number

      Angle, in radians, between the two quaternions

      -

    Static getAxisAngle

    • getAxisAngle(out_axis, q): number

    • Gets the rotation axis and angle for a given - quaternion. If a quaternion is created with - setAxisAngle, this method will return the same - values as providied in the original parameter list - OR functionally equivalent values. +

    StaticgetAxisAngle

    • getAxisAngle(out_axis, q): number

    • Gets the rotation axis and angle for a given +quaternion. If a quaternion is created with +setAxisAngle, this method will return the same +values as providied in the original parameter list +OR functionally equivalent values. Example: The quaternion formed by axis [0, 0, 1] and - angle -90 is the same as the quaternion formed by - [0, 0, 1] and 270. This method favors the latter.

      +angle -90 is the same as the quaternion formed by +[0, 0, 1] and 270. This method favors the latter.

      Parameters

      Returns number

      Angle, in radians, of the rotation

      -

    Static identity

    • identity(out): Vec4Like

    • Set a quat to the identity quaternion

      +

    Staticidentity

    • identity(out): Vec4Like

    • Set a quat to the identity quaternion

      Parameters

      Returns Vec4Like

      out

      -

    Static invert

    • invert(out, a): Vec4Like

    • Calculates the inverse of a quat

      +

    Staticinvert

    Static len

    Static length

    Static lerp

    • lerp(out, a, b, t): Vec4Like

    • Performs a linear interpolation between two quat's

      +

    Staticlen

    Staticlength

    Staticlerp

    • lerp(out, a, b, t): Vec4Like

    • Performs a linear interpolation between two quat's

      Parameters

      Returns Vec4Like

      out

      -

    Static ln

    • ln(out, a): Vec4Like

    • Calculate the natural logarithm of a unit quaternion.

      +

    Staticln

    • ln(out, a): Vec4Like

    • Calculate the natural logarithm of a unit quaternion.

      Parameters

      Returns Vec4Like

      out

      -

    Static mag

    Static magnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Quat

      +

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Quat

      Parameters

      Returns number

      length of a

      -

    Static mul

    Static multiply

    • multiply(out, a, b): Vec4Like

    • Multiplies two quat's

      +

    Staticmul

    Staticmultiply

    Static normalize

    Staticnormalize

    Static pow

    • pow(out, a, b): Vec4Like

    • Calculate the scalar power of a unit quaternion.

      +

    Staticpow

    • pow(out, a, b): Vec4Like

    • Calculate the scalar power of a unit quaternion.

      Parameters

      • out: Vec4Like

        the receiving quaternion

      • a: Readonly<Vec4Like>

        quat to calculate the exponential of

      • b: number

        amount to scale the quaternion by

      Returns Vec4Like

      out

      -

    Static rotateX

    • rotateX(out, a, rad): Vec4Like

    • Rotates a quaternion by the given angle about the X axis

      +

    StaticrotateX

    • rotateX(out, a, rad): Vec4Like

    • Rotates a quaternion by the given angle about the X axis

      Parameters

      • out: Vec4Like

        quat receiving operation result

      • a: Readonly<Vec4Like>

        quat to rotate

      • rad: number

        angle (in radians) to rotate

      Returns Vec4Like

      out

      -

    Static rotateY

    • rotateY(out, a, rad): Vec4Like

    • Rotates a quaternion by the given angle about the Y axis

      +

    StaticrotateY

    • rotateY(out, a, rad): Vec4Like

    • Rotates a quaternion by the given angle about the Y axis

      Parameters

      • out: Vec4Like

        quat receiving operation result

      • a: Readonly<Vec4Like>

        quat to rotate

      • rad: number

        angle (in radians) to rotate

      Returns Vec4Like

      out

      -

    Static rotateZ

    • rotateZ(out, a, rad): Vec4Like

    • Rotates a quaternion by the given angle about the Z axis

      +

    StaticrotateZ

    • rotateZ(out, a, rad): Vec4Like

    • Rotates a quaternion by the given angle about the Z axis

      Parameters

      • out: Vec4Like

        quat receiving operation result

      • a: Readonly<Vec4Like>

        quat to rotate

      • rad: number

        angle (in radians) to rotate

      Returns Vec4Like

      out

      -

    Static rotationTo

    • rotationTo(out, a, b): Vec4Like

    • Sets a quaternion to represent the shortest rotation from one +

    StaticrotationTo

    • rotationTo(out, a, b): Vec4Like

    • Sets a quaternion to represent the shortest rotation from one vector to another.

      Both vectors are assumed to be unit length.

      Parameters

      Returns Vec4Like

      out

      -

    Static scale

    • scale(out, a, scale): Vec4Like

    • Scales a quat by a scalar number

      +

    Staticscale

    Static set

    • set(out, x, y, z, w): Vec4Like

    • Set the components of a Quat to the given values

      +

    Staticset

    • set(out, x, y, z, w): Vec4Like

    • Set the components of a Quat to the given values

      Parameters

      • out: Vec4Like

        the receiving quaternion

      • x: number

        X component

      • y: number

        Y component

      • z: number

        Z component

      • w: number

        W component

      Returns Vec4Like

      out

      -

    Static setAxes

    • setAxes(out, view, right, up): Vec4Like

    • Sets the specified quaternion with values corresponding to the given +

    StaticsetAxes

    • setAxes(out, view, right, up): Vec4Like

    • Sets the specified quaternion with values corresponding to the given axes. Each axis is a vec3 and is expected to be unit length and perpendicular to all other specified axes.

      Parameters

      Returns Vec4Like

      out

      -

    Static setAxisAngle

    • setAxisAngle(out, axis, rad): Vec4Like

    • Sets a quat from the given angle and rotation axis, +

    StaticsetAxisAngle

    • setAxisAngle(out, axis, rad): Vec4Like

    • Sets a quat from the given angle and rotation axis, then returns it.

      Parameters

      • out: Vec4Like

        the receiving quaternion

      • axis: Readonly<Vec3Like>

        the axis around which to rotate

      • rad: number

        the angle in radians

      Returns Vec4Like

      out

      -

    Static slerp

    • slerp(out, a, b, t): Vec4Like

    • Performs a spherical linear interpolation between two quat

      +

    Staticslerp

    • slerp(out, a, b, t): Vec4Like

    • Performs a spherical linear interpolation between two quat

      Parameters

      Returns Vec4Like

      out

      -

    Static sqlerp

    • sqlerp(out, a, b, c, d, t): Vec4Like

    • Performs a spherical linear interpolation with two control points

      +

    Staticsqlerp

    • sqlerp(out, a, b, c, d, t): Vec4Like

    • Performs a spherical linear interpolation with two control points

      Parameters

      Returns Vec4Like

      out

      -

    Static sqrLen

    Static squaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Quat

      +

    StaticsqrLen

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Quat

      Parameters

      Returns number

      squared length of a

      -

    Static str

    • str(a): string

    • Returns a string representation of a quatenion

      +

    Staticstr

    • str(a): string

    • Returns a string representation of a quatenion

      Parameters

      Returns string

      string representation of the vector

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorBYTES_PER_ELEMENT[toStringTag]bufferbyteLengthbyteOffsetlengthBYTES_PER_ELEMENTBYTE_LENGTHmagmagnitudestr[iterator]atcopycopyWithindotentrieseveryfillfilterfindfindIndexforEachidentityincludesindexOfinvertjoinkeyslastIndexOfmapmulmultiplyreducereduceRightreverserotateXrotateYrotateZscalesetslicesomesortsubarraytoLocaleStringtoStringvalueOfvaluesfromofwxyzaddcalculateWcloneconjugatecopycreatedotequalsexactEqualsexpfromEulerfromMat3fromValuesgetAnglegetAxisAngleidentityinvertlenlengthlerplnmagmagnitudemulmultiplynormalizepowrotateXrotateYrotateZrotationToscalesetsetAxessetAxisAngleslerpsqlerpsqrLensquaredLengthstr
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Other
    Quaternion components
    Static
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_gl_matrix.Quat2.html b/docs/classes/_runtime_math_gl_matrix.Quat2.html index c53878fe..e0fb201d 100644 --- a/docs/classes/_runtime_math_gl_matrix.Quat2.html +++ b/docs/classes/_runtime_math_gl_matrix.Quat2.html @@ -1,14 +1,25 @@ -Quat2 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Quat2

    Dual Quaternion

    -

    Hierarchy

    Other

    constructor -BYTES_PER_ELEMENT +Quat2 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Quat2

    Dual Quaternion

    +
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Other

    constructor [toStringTag] buffer byteLength byteOffset +BYTES_PER_ELEMENT length BYTES_PER_ELEMENT -BYTE_LENGTH str +BYTE_LENGTH [iterator] at copy @@ -81,17 +92,17 @@ squaredLength str translate -

    Other

    constructor

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Float32Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Static Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Static Readonly BYTE_LENGTH

    BYTE_LENGTH: number

    The number of bytes in a Quat.

    -

    str

    • get str(): string

    • A string representation of this +

    Other

    constructor

    Readonly[toStringTag]

    [toStringTag]: "Float32Array"

    Readonlybuffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    ReadonlybyteLength

    byteLength: number

    The length in bytes of the array.

    +

    ReadonlybyteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Readonlylength

    length: number

    The length of the array.

    +

    Static ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    str

    • get str(): string

    • A string representation of this Equivalent to Quat2.str(this);

      -

      Returns string

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      +

      Returns string

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Quat2.

      +

    [iterator]

    at

    • at(index): number

    • Returns the item located at the specified index.

      Parameters

      • index: number

        The zero-based index of the desired code unit. A negative index will count back from the last item.

      Returns number

    copy

    • copy(a): Quat2

    • Copy the values from another Quat2 into this.

      Parameters

      • a: Readonly<Quat2Like>

        the source dual quaternion

        @@ -102,74 +113,74 @@ length of the array.

      • start: number

        If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

        -
      • Optional end: number

        If not specified, length of the this object is used as its default value.

        +
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

      Returns this

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    fill

    • fill(value, start?, end?): this

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter(predicate, thisArg?): Float32Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => any)

          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

          -
            • (value, index, array): any

            • Parameters

              Returns any

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): any

            • Parameters

              Returns any

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    find

    • find(predicate, thisArg?): number

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): void

            • Parameters

              Returns void

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): void

            • Parameters

              Returns void

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +
      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        +
      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      Returns number

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +

        Parameters

        • Optionalseparator: string

          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

        Returns string

    keys

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    map

    • map(callbackfn, thisArg?): Float32Array

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => number)

          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): number

            • Parameters

              Returns number

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): number

            • Parameters

              Returns number

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduce(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduce<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array. The return value of +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -177,12 +188,12 @@

        Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduceRight(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduceRight<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array, in descending order. +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -190,87 +201,88 @@

        Returns U

    reverse

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +
      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    slice

    • slice(start?, end?): Float32Array

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

        Parameters

        • Optionalstart: number

          The beginning of the specified portion of the array.

          +
        • Optionalend: number

          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        Returns Float32Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    sort

    • sort(compareFn?): this

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +

        Parameters

        • OptionalcompareFn: ((a: number, b: number) => number)

          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

          -
          [11,2,22,1].sort((a, b) => a - b)
-
          +
          [11,2,22,1].sort((a, b) => a - b)
+
          +
            • (a, b): number

            • Parameters

              • a: number
              • b: number

              Returns number

        Returns this

    subarray

    • subarray(begin?, end?): Float32Array

    • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        +

        Parameters

        • Optionalbegin: number

          The index of the beginning of the array.

          +
        • Optionalend: number

          The index of the end of the array.

        Returns Float32Array

    toLocaleString

    • toLocaleString(): string

    • Converts a number to a string by using the current locale.

      Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      Returns string

    valueOf

    • valueOf(): Float32Array

    • Returns the primitive value of the specified object.

      Returns Float32Array

    values

    Static from

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      +

      Returns IterableIterator<number>

    Staticfrom

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<number>

        An array-like or iterable object to convert to an array.

      Returns Float32Array

    • from<T>(arrayLike, mapfn, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like or iterable object to convert to an array.

        -
      • mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        +
      • mapfn: ((v: T, k: number) => number)

        A mapping function to call on every element of the array.

        +
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns Float32Array

    • from(arrayLike, mapfn?, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: Iterable<number>

        An array-like or iterable object to convert to an array.

        -
      • Optional mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: number
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -

      Returns Float32Array

    Static of

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      -

      Parameters

      • Rest ...items: number[]

        A set of elements to include in the new array object.

        -

      Returns Float32Array

    Static

    Static add

    • add(out, a, b): Quat2Like

    • Adds two Quat2s

      +
    • Optionalmapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

      +
        • (v, k): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array

    Staticof

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      +

      Parameters

      • Rest...items: number[]

        A set of elements to include in the new array object.

        +

      Returns Float32Array

    Static

    Staticadd

    Static clone

    • clone(a): Quat2

    • Creates a Quat2 quat initialized with values from an existing quaternion

      +

    Staticclone

    • clone(a): Quat2

    • Creates a Quat2 quat initialized with values from an existing quaternion

      Parameters

      Returns Quat2

      a new dual quaternion

      -

    Static conjugate

    Staticconjugate

    • conjugate(out, a): Quat2Like

    • Calculates the conjugate of a Quat2 If the dual quaternion is normalized, this function is faster than Quat2.invert and produces the same result.

      Parameters

      Returns Quat2Like

      out

      -

    Static copy

    Staticcopy

    Static create

    Staticcreate

    • create(): Quat2

    • Creates a new identity Quat2

      Returns Quat2

      a new dual quaternion [real -> rotation, dual -> translation]

      -

    Static dot

    • dot(a, b): number

    • Calculates the dot product of two Quat2s (The dot product of the real parts)

      +

    Staticdot

    • dot(a, b): number

    • Calculates the dot product of two Quat2s (The dot product of the real parts)

      Parameters

      Returns number

      dot product of a and b

      -

    Static equals

    • equals(a, b): boolean

    • Returns whether or not the Quat2s have approximately the same elements in the same position.

      +

    Staticequals

    • equals(a, b): boolean

    • Returns whether or not the Quat2s have approximately the same elements in the same position.

      Parameters

      Returns boolean

      True if the dual quaternions are equal, false otherwise.

      -

    Static exactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the Quat2s have exactly the same elements in the same position (when compared with ===)

      +

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the Quat2s have exactly the same elements in the same position (when compared with ===)

      Parameters

      Returns boolean

      True if the dual quaternions are equal, false otherwise.

      -

    Static fromMat4

    StaticfromMat4

    Static fromRotation

    StaticfromRotation

    Static fromRotationTranslation

    • fromRotationTranslation(out, q, t): Quat2Like

    • Sets a Quat2 from a quaternion and a translation

      +

    StaticfromRotationTranslation

    Static fromRotationTranslationValues

    • fromRotationTranslationValues(x1, y1, z1, w1, x2, y2, z2): Quat2

    • Creates a new Quat2 from the given values (quat and translation)

      +

    StaticfromRotationTranslationValues

    • fromRotationTranslationValues(x1, y1, z1, w1, x2, y2, z2): Quat2

    • Creates a new Quat2 from the given values (quat and translation)

      Parameters

      • x1: number

        X component (rotation)

      • y1: number

        Y component (rotation)

      • z1: number

        Z component (rotation)

        @@ -279,11 +291,11 @@
      • y2: number

        Y component (translation)

      • z2: number

        Z component (translation)

      Returns Quat2

      a new dual quaternion

      -

    Static fromTranslation

    StaticfromTranslation

    Static fromValues

    • fromValues(x1, y1, z1, w1, x2, y2, z2, w2): Quat2

    • Creates a new Quat2 initialized with the given values

      +

    StaticfromValues

    • fromValues(x1, y1, z1, w1, x2, y2, z2, w2): Quat2

    • Creates a new Quat2 initialized with the given values

      Parameters

      • x1: number

        1st X component

      • y1: number

        1st Y component

      • z1: number

        1st Z component

        @@ -293,87 +305,87 @@
      • z2: number

        2nd Z component

      • w2: number

        2nd W component

      Returns Quat2

      a new dual quaternion

      -

    Static getDual

    • getDual(out, a): Vec4Like

    • Gets the dual part of a dual quat

      +

    StaticgetDual

    Static getReal

    • getReal(out, a): Vec4Like

    • Gets the real part of a dual quat

      +

    StaticgetReal

    Static getTranslation

    • getTranslation(out, a): Vec3Like

    • Gets the translation of a normalized Quat2

      +

    StaticgetTranslation

    Static identity

    • identity(out): Vec4Like

    • Set a Quat2 to the identity dual quaternion

      +

    Staticidentity

    Static invert

    • invert(out, a): Quat2Like

    • Calculates the inverse of a Quat2. If they are normalized, conjugate is cheaper

      +

    Staticinvert

    Static len

    Static length

    Static lerp

    • lerp(out, a, b, t): Quat2Like

    • Performs a linear interpolation between two Quat2s +

    Staticlen

    Staticlength

    Staticlerp

    • lerp(out, a, b, t): Quat2Like

    • Performs a linear interpolation between two Quat2s NOTE: The resulting dual quaternions won't always be normalized (The error is most noticeable when t = 0.5)

      Parameters

      Returns Quat2Like

      out

      -

    Static mag

    Static magnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Quat2

      +

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Quat2

      Parameters

      Returns number

      length of a

      -

    Static mul

    Static multiply

    Staticmul

    Staticmultiply

    Static normalize

    Staticnormalize

    Static rotateAroundAxis

    • rotateAroundAxis(out, a, axis, rad): Quat2Like

    • Rotates a Quat2 around a given axis. Does the normalization automatically

      +

    StaticrotateAroundAxis

    • rotateAroundAxis(out, a, axis, rad): Quat2Like

    • Rotates a Quat2 around a given axis. Does the normalization automatically

      Parameters

      Returns Quat2Like

      out

      -

    Static rotateByQuatAppend

    • rotateByQuatAppend(out, a, q): Quat2Like

    • Rotates a Quat2 by a given quaternion (a * q)

      +

    StaticrotateByQuatAppend

    Static rotateByQuatPrepend

    • rotateByQuatPrepend(out, q, a): Quat2Like

    • Rotates a Quat2 by a given quaternion (q * a)

      +

    StaticrotateByQuatPrepend

    Static rotateX

    StaticrotateX

    Static rotateY

    StaticrotateY

    Static rotateZ

    StaticrotateZ

    Static scale

    Staticscale

    Static set

    • set(out, x1, y1, z1, w1, x2, y2, z2, w2): Quat2Like

    • Set the components of a Quat2 to the given values

      +

    Staticset

    • set(out, x1, y1, z1, w1, x2, y2, z2, w2): Quat2Like

    • Set the components of a Quat2 to the given values

      Parameters

      • out: Quat2Like

        the receiving vector

      • x1: number

        1st X component

      • y1: number

        1st Y component

        @@ -384,24 +396,24 @@
      • z2: number

        2nd Z component

      • w2: number

        2nd W component

      Returns Quat2Like

      out

      -

    Static setDual

    • setDual(out, a): Quat2Like

    • Set the dual component of a Quat2 to the given quaternion

      +

    StaticsetDual

    Static setReal

    • setReal(out, a): Quat2Like

    • Set the real component of a Quat2 to the given quaternion

      +

    StaticsetReal

    Static sqrLen

    Static squaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Quat2

      +

    StaticsqrLen

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Quat2

      Parameters

      Returns number

      squared length of a

      -

    Static str

    • str(a): string

    • Returns a string representation of a Quat2

      +

    Staticstr

    • str(a): string

    • Returns a string representation of a Quat2

      Parameters

      Returns string

      string representation of the vector

      -

    Static translate

    • translate(out, a, v): Quat2Like

    • Translates a Quat2 by the given vector

      +

    Statictranslate

    Settings

    Member Visibility

    Theme

    On This Page

    constructorBYTES_PER_ELEMENT[toStringTag]bufferbyteLengthbyteOffsetlengthBYTES_PER_ELEMENTBYTE_LENGTHstr[iterator]atcopycopyWithinentrieseveryfillfilterfindfindIndexforEachincludesindexOfjoinkeyslastIndexOfmapreducereduceRightreversesetslicesomesortsubarraytoLocaleStringtoStringvalueOfvaluesfromofaddcloneconjugatecopycreatedotequalsexactEqualsfromMat4fromRotationfromRotationTranslationfromRotationTranslationValuesfromTranslationfromValuesgetDualgetRealgetTranslationidentityinvertlenlengthlerpmagmagnitudemulmultiplynormalizerotateAroundAxisrotateByQuatAppendrotateByQuatPrependrotateXrotateYrotateZscalesetsetDualsetRealsqrLensquaredLengthstrtranslate
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Other
    Static
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_gl_matrix.Vec2.html b/docs/classes/_runtime_math_gl_matrix.Vec2.html index 9163ded8..7f10716d 100644 --- a/docs/classes/_runtime_math_gl_matrix.Vec2.html +++ b/docs/classes/_runtime_math_gl_matrix.Vec2.html @@ -1,21 +1,33 @@ -Vec2 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Vec2

    2 Dimensional Vector

    -

    Hierarchy

    Color components

    g +Vec2 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Vec2

    2 Dimensional Vector

    +
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Color components

    g r

    Other

    constructor -BYTES_PER_ELEMENT [toStringTag] buffer byteLength byteOffset +BYTES_PER_ELEMENT length BYTES_PER_ELEMENT -BYTE_LENGTH mag magnitude sqrMag squaredMagnitude str +BYTE_LENGTH [iterator] +abs add at copy @@ -68,7 +80,8 @@ transformMat2d transformMat3 transformMat4 -

    Static

    add +

    Static

    abs +add angle ceil clone @@ -110,27 +123,30 @@ zero

    Vector components

    x y -

    Color components

    g

    • get g(): number

    • The g component of the vector. Equivalent to this[1];

      +

    Color components

    g

    • get g(): number

    • The g component of the vector. Equivalent to this[1];

      Returns number

    • set g(value): void

    • Parameters

      • value: number

      Returns void

    r

    • get r(): number

    • The r component of the vector. Equivalent to this[0];

      -

      Returns number

    • set r(value): void

    • Parameters

      • value: number

      Returns void

    Other

    constructor

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Float32Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Static Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Static Readonly BYTE_LENGTH

    BYTE_LENGTH: number

    The number of bytes in a Vec2.

    -

    mag

    • get mag(): number

    • Alias for Vec2.magnitude

      +

      Returns number

    • set r(value): void

    • Parameters

      • value: number

      Returns void

    Other

    constructor

    Readonly[toStringTag]

    [toStringTag]: "Float32Array"

    Readonlybuffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    ReadonlybyteLength

    byteLength: number

    The length in bytes of the array.

    +

    ReadonlybyteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Readonlylength

    length: number

    The length of the array.

    +

    Static ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    mag

    magnitude

    • get magnitude(): number

    • The magnitude (length) of this. Equivalent to Vec2.magnitude(this);

      Magnitude is used because the length attribute is already defined by -Float32Array to mean the number of elements in the array.

      +TypedArrays to mean the number of elements in the array.

      Returns number

    sqrMag

    squaredMagnitude

    • get squaredMagnitude(): number

    • The squared magnitude (length) of this. Equivalent to Vec2.squaredMagnitude(this);

      Returns number

    str

    • get str(): string

    • A string representation of this Equivalent to Vec2.str(this);

      -

      Returns string

    [iterator]

    add

    • add(b): Vec2

    • Adds a Vec2 to this. +

      Returns string

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Vec2.

      +

    [iterator]

    abs

    • abs(): Vec2

    • Sets each component of this to it's absolute value. +Equivalent to Vec2.abs(this, this);

      +

      Returns Vec2

      this

      +

    add

    • add(b): Vec2

    • Adds a Vec2 to this. Equivalent to Vec2.add(this, this, b);

      Parameters

      Returns Vec2

      this

      @@ -145,7 +161,7 @@ length of the array.

  • start: number

    If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    -
  • Optional end: number

    If not specified, length of the this object is used as its default value.

    +
  • Optionalend: number

    If not specified, length of the this object is used as its default value.

    • Returns this

    dist

    distance

    • distance(b): number

    • Calculates the euclidian distance between another Vec2 and this. Equivalent to Vec2.distance(this, b);

      @@ -162,64 +178,64 @@

    Returns number

    Dot product of this and b

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    fill

    • fill(value, start?, end?): this

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter(predicate, thisArg?): Float32Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => any)

          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

          -
            • (value, index, array): any

            • Parameters

              Returns any

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): any

            • Parameters

              Returns any

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    find

    • find(predicate, thisArg?): number

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): void

            • Parameters

              Returns void

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): void

            • Parameters

              Returns void

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +
      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        +
      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      Returns number

    invert

    • invert(): Vec2

    • Inverts the components of this. Equivalent to Vec2.inverse(this, this);

      Returns Vec2

      this

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +

        Parameters

        • Optionalseparator: string

          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

        Returns string

    keys

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    map

    • map(callbackfn, thisArg?): Float32Array

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => number)

          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): number

            • Parameters

              Returns number

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): number

            • Parameters

              Returns number

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    mul

    multiply

    • multiply(b): Vec2

    • Multiplies this by a Vec2. @@ -235,12 +251,12 @@

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduce(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduce<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array. The return value of +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -248,12 +264,12 @@

        Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduceRight(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduceRight<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array, in descending order. +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -270,22 +286,23 @@

        Returns Vec2

        this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +
      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    slice

    • slice(start?, end?): Float32Array

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

        Parameters

        • Optionalstart: number

          The beginning of the specified portion of the array.

          +
        • Optionalend: number

          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        Returns Float32Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    sort

    • sort(compareFn?): this

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +

        Parameters

        • OptionalcompareFn: ((a: number, b: number) => number)

          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

          -
          [11,2,22,1].sort((a, b) => a - b)
-
          +
          [11,2,22,1].sort((a, b) => a - b)
+
          +
            • (a, b): number

            • Parameters

              • a: number
              • b: number

              Returns number

        Returns this

    sqrDist

    squaredDistance

    • squaredDistance(b): number

    • Calculates the squared euclidian distance between another Vec2 and this. Equivalent to Vec2.squaredDistance(this, b);

      @@ -294,8 +311,8 @@

    sub

    subarray

    • subarray(begin?, end?): Float32Array

    • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        +

        Parameters

        • Optionalbegin: number

          The index of the beginning of the array.

          +
        • Optionalend: number

          The index of the end of the array.

        Returns Float32Array

    subtract

    • subtract(b): Vec2

    • Subtracts a Vec2 from this. Equivalent to Vec2.subtract(this, this, b);

      Parameters

      • b: Readonly<Vec2Like>

        The vector to subtract from this

        @@ -304,192 +321,196 @@

        Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      Returns string

    valueOf

    • valueOf(): Float32Array

    • Returns the primitive value of the specified object.

      Returns Float32Array

    values

    Static from

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      +

      Returns IterableIterator<number>

    Staticfrom

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<number>

        An array-like or iterable object to convert to an array.

      Returns Float32Array

    • from<T>(arrayLike, mapfn, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like or iterable object to convert to an array.

        -
      • mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        +
      • mapfn: ((v: T, k: number) => number)

        A mapping function to call on every element of the array.

        +
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns Float32Array

    • from(arrayLike, mapfn?, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: Iterable<number>

        An array-like or iterable object to convert to an array.

        -
      • Optional mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: number
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -

      Returns Float32Array

    Static of

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      -

      Parameters

      • Rest ...items: number[]

        A set of elements to include in the new array object.

        -

      Returns Float32Array

    Static sqrLen

    Static transformMat2

    • transformMat2(out, a, m): Vec2Like

    • Transforms the Vec2 with a Mat2

      +
    • Optionalmapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

      +
        • (v, k): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array

    Staticof

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      +

      Parameters

      • Rest...items: number[]

        A set of elements to include in the new array object.

        +

      Returns Float32Array

    StaticsqrLen

    StatictransformMat2

    Static transformMat2d

    StatictransformMat2d

    Static transformMat3

    StatictransformMat3

    Static transformMat4

    StatictransformMat4

    Static

    Static add

    Static

    Staticabs

    Staticadd

    Static angle

    • angle(a, b): number

    • Get the angle between two 2D vectors

      +

    Staticangle

    • angle(a, b): number

    • Get the angle between two 2D vectors

      Parameters

      Returns number

      The angle in radians

      -

    Static ceil

    Staticceil

    Static clone

    • clone(a): Vec2

    • Creates a new Vec2 initialized with values from an existing vector

      +

    Staticclone

    • clone(a): Vec2

    • Creates a new Vec2 initialized with values from an existing vector

      Parameters

      Returns Vec2

      A new 2D vector

      -

    Static copy

    • copy(out, a): Vec2Like

    • Copy the values from one Vec2 to another

      +

    Staticcopy

    Static create

    • create(): Vec2

    • Creates a new, empty Vec2

      +

    Staticcreate

    • create(): Vec2

    • Creates a new, empty Vec2

      Returns Vec2

      A new 2D vector

      -

    Static cross

    • cross(out, a, b): Vec2Like

    • Computes the cross product of two Vec2s +

    Staticcross

    • cross(out, a, b): Vec2Like

    • Computes the cross product of two Vec2s Note that the cross product must by definition produce a 3D vector. For this reason there is also not instance equivalent for this function.

      Parameters

      Returns Vec2Like

      out

      -

    Static dist

    Static distance

    • distance(a, b): number

    • Calculates the euclidian distance between two Vec2s

      +

    Staticdist

    Staticdistance

    • distance(a, b): number

    • Calculates the euclidian distance between two Vec2s

      Parameters

      Returns number

      distance between a and b

      -

    Static div

    Static divide

    Staticdiv

    Staticdivide

    Static dot

    • dot(a, b): number

    • Calculates the dot product of two Vec2s

      +

    Staticdot

    • dot(a, b): number

    • Calculates the dot product of two Vec2s

      Parameters

      Returns number

      Dot product of a and b

      -

    Static equals

    • equals(a, b): boolean

    • Returns whether or not the vectors have approximately the same elements in the same position.

      +

    Staticequals

    • equals(a, b): boolean

    • Returns whether or not the vectors have approximately the same elements in the same position.

      Parameters

      Returns boolean

      true if the vectors are approximately equal, false otherwise.

      -

    Static exactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

      +

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

      Parameters

      Returns boolean

      true if the vectors components are ===, false otherwise.

      -

    Static floor

    • floor(out, a): Vec2Like

    • Math.floor the components of a Vec2

      +

    Staticfloor

    Static fromValues

    • fromValues(x, y): Vec2

    • Creates a new Vec2 initialized with the given values

      +

    StaticfromValues

    • fromValues(x, y): Vec2

    • Creates a new Vec2 initialized with the given values

      Parameters

      • x: number

        X component

      • y: number

        Y component

      Returns Vec2

      A new 2D vector

      -

    Static inverse

    • inverse(out, a): Vec2Like

    • Returns the inverse of the components of a Vec2

      +

    Staticinverse

    Static len

    Static length

    Staticlen

    Staticlength

    Static lerp

    • lerp(out, a, b, t): Vec2Like

    • Performs a linear interpolation between two Vec2s

      +

      Deprecated

      Use Vec2.magnitude to avoid conflicts with builtin length methods/attribs

      +

    Staticlerp

    Static mag

    Static magnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Vec2

      +

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Vec2

      Parameters

      Returns number

      Magnitude of a

      -

    Static max

    Staticmax

    Static min

    Staticmin

    Static mul

    Static multiply

    Staticmul

    Staticmultiply

    Static negate

    Staticnegate

    Static normalize

    Staticnormalize

    Static rotate

    • rotate(out, a, b, rad): Vec2Like

    • Rotate a 2D vector

      +

    Staticrotate

    Static round

    • round(out, a): Vec2Like

    • Math.round the components of a Vec2

      +

    Staticround

    Static scale

    • scale(out, a, b): Vec2Like

    • Scales a Vec2 by a scalar number

      +

    Staticscale

    Static scaleAndAdd

    • scaleAndAdd(out, a, b, scale): Vec2Like

    • Adds two Vec2's after scaling the second operand by a scalar value

      +

    StaticscaleAndAdd

    • scaleAndAdd(out, a, b, scale): Vec2Like

    • Adds two Vec2's after scaling the second operand by a scalar value

      Parameters

      Returns Vec2Like

      out

      -

    Static set

    • set(out, x, y): Vec2Like

    • Set the components of a Vec2 to the given values

      +

    Staticset

    • set(out, x, y): Vec2Like

    • Set the components of a Vec2 to the given values

      Parameters

      • out: Vec2Like

        The receiving vector

      • x: number

        X component

      • y: number

        Y component

      Returns Vec2Like

      out

      -

    Static sqrDist

    Static squaredDistance

    • squaredDistance(a, b): number

    • Calculates the squared euclidian distance between two Vec2s

      +

    StaticsqrDist

    StaticsquaredDistance

    • squaredDistance(a, b): number

    • Calculates the squared euclidian distance between two Vec2s

      Parameters

      Returns number

      Squared distance between a and b

      -

    Static squaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Vec2

      +

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Vec2

      Parameters

      Returns number

      Squared length of a

      -

    Static str

    • str(a): string

    • Returns a string representation of a vector

      +

    Staticstr

    • str(a): string

    • Returns a string representation of a vector

      Parameters

      Returns string

      String representation of the vector

      -

    Static sub

    Static subtract

    • subtract(out, a, b): Vec2Like

    • Subtracts vector b from vector a

      +

    Staticsub

    Staticsubtract

    Static zero

    Staticzero

    Vector components

    x

    • get x(): number

    • The x component of the vector. Equivalent to this[0];

      +

    Vector components

    x

    • get x(): number

    • The x component of the vector. Equivalent to this[0];

      Returns number

    • set x(value): void

    • Parameters

      • value: number

      Returns void

    y

    • get y(): number

    • The y component of the vector. Equivalent to this[1];

      -

      Returns number

    • set y(value): void

    • Parameters

      • value: number

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    grconstructorBYTES_PER_ELEMENT[toStringTag]bufferbyteLengthbyteOffsetlengthBYTES_PER_ELEMENTBYTE_LENGTHmagmagnitudesqrMagsquaredMagnitudestr[iterator]addatcopycopyWithindistdistancedivdividedotentrieseveryfillfilterfindfindIndexforEachincludesindexOfinvertjoinkeyslastIndexOfmapmulmultiplynegatenormalizereducereduceRightreversescalescaleAndAddsetslicesomesortsqrDistsquaredDistancesubsubarraysubtracttoLocaleStringtoStringvalueOfvaluesfromofsqrLentransformMat2transformMat2dtransformMat3transformMat4addangleceilclonecopycreatecrossdistdistancedivdividedotequalsexactEqualsfloorfromValuesinverselenlengthlerpmagmagnitudemaxminmulmultiplynegatenormalizerotateroundscalescaleAndAddsetsqrDistsquaredDistancesquaredLengthstrsubsubtractzeroxy
    \ No newline at end of file +

    Returns number

  • set y(value): void

  • Parameters

    • value: number

    Returns void

    • Settings

    Member Visibility

    On This Page

    Color components
    Other
    Static
    Vector components
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_gl_matrix.Vec3.html b/docs/classes/_runtime_math_gl_matrix.Vec3.html index c4ad6f42..00d95792 100644 --- a/docs/classes/_runtime_math_gl_matrix.Vec3.html +++ b/docs/classes/_runtime_math_gl_matrix.Vec3.html @@ -1,22 +1,34 @@ -Vec3 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Vec3

    3 Dimensional Vector

    -

    Hierarchy

    Color components

    b +Vec3 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Vec3

    3 Dimensional Vector

    +
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Color components

    b g r

    Other

    constructor -BYTES_PER_ELEMENT [toStringTag] buffer byteLength byteOffset +BYTES_PER_ELEMENT length BYTES_PER_ELEMENT -BYTE_LENGTH mag magnitude sqrMag squaredMagnitude str +BYTE_LENGTH [iterator] +abs add at copy @@ -71,7 +83,8 @@ rotateZ sqrDist sqrLen -

    Static

    add +

    Static

    abs +add bezier ceil clone @@ -115,28 +128,31 @@

    Vector components

    x y z -

    Color components

    b

    • get b(): number

    • The b component of the vector. Equivalent to this[2];

      +

    Color components

    b

    • get b(): number

    • The b component of the vector. Equivalent to this[2];

      Returns number

    • set b(value): void

    • Parameters

      • value: number

      Returns void

    g

    • get g(): number

    • The g component of the vector. Equivalent to this[1];

      Returns number

    • set g(value): void

    • Parameters

      • value: number

      Returns void

    r

    • get r(): number

    • The r component of the vector. Equivalent to this[0];

      -

      Returns number

    • set r(value): void

    • Parameters

      • value: number

      Returns void

    Other

    constructor

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Float32Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Static Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Static Readonly BYTE_LENGTH

    BYTE_LENGTH: number

    The number of bytes in a Vec3.

    -

    mag

    • get mag(): number

    • Alias for Vec3.magnitude

      +

      Returns number

    • set r(value): void

    • Parameters

      • value: number

      Returns void

    Other

    constructor

    Readonly[toStringTag]

    [toStringTag]: "Float32Array"

    Readonlybuffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    ReadonlybyteLength

    byteLength: number

    The length in bytes of the array.

    +

    ReadonlybyteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Readonlylength

    length: number

    The length of the array.

    +

    Static ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    mag

    magnitude

    • get magnitude(): number

    • The magnitude (length) of this. Equivalent to Vec3.magnitude(this);

      Magnitude is used because the length attribute is already defined by -Float32Array to mean the number of elements in the array.

      +TypedArrays to mean the number of elements in the array.

      Returns number

    sqrMag

    squaredMagnitude

    • get squaredMagnitude(): number

    • The squared magnitude (length) of this. Equivalent to Vec3.squaredMagnitude(this);

      Returns number

    str

    • get str(): string

    • A string representation of this Equivalent to Vec3.str(this);

      -

      Returns string

    [iterator]

    add

    • add(b): Vec3

    • Adds a Vec3 to this. +

      Returns string

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Vec3.

      +

    [iterator]

    abs

    • abs(): Vec3

    • Sets each component of this to it's absolute value. +Equivalent to Vec3.abs(this, this);

      +

      Returns Vec3

      this

      +

    add

    • add(b): Vec3

    • Adds a Vec3 to this. Equivalent to Vec3.add(this, this, b);

      Parameters

      Returns Vec3

      this

      @@ -151,7 +167,7 @@ length of the array.

  • start: number

    If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    -
  • Optional end: number

    If not specified, length of the this object is used as its default value.

    +
  • Optionalend: number

    If not specified, length of the this object is used as its default value.

    • Returns this

    dist

    distance

    • distance(b): number

    • Calculates the euclidian distance between another Vec3 and this. Equivalent to Vec3.distance(this, b);

      @@ -168,64 +184,64 @@

    Returns number

    Dot product of this and b

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    fill

    • fill(value, start?, end?): this

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter(predicate, thisArg?): Float32Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => any)

          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

          -
            • (value, index, array): any

            • Parameters

              Returns any

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): any

            • Parameters

              Returns any

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    find

    • find(predicate, thisArg?): number

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): void

            • Parameters

              Returns void

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): void

            • Parameters

              Returns void

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +
      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        +
      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      Returns number

    invert

    • invert(): Vec3

    • Inverts the components of this. Equivalent to Vec3.inverse(this, this);

      Returns Vec3

      this

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +

        Parameters

        • Optionalseparator: string

          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

        Returns string

    keys

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    map

    • map(callbackfn, thisArg?): Float32Array

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => number)

          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): number

            • Parameters

              Returns number

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): number

            • Parameters

              Returns number

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    mul

    multiply

    • multiply(b): Vec3

    • Multiplies this by a Vec3. @@ -241,12 +257,12 @@

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduce(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduce<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array. The return value of +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -254,12 +270,12 @@

        Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduceRight(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduceRight<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array, in descending order. +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -276,22 +292,23 @@

        Returns Vec3

        this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +
      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    slice

    • slice(start?, end?): Float32Array

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

        Parameters

        • Optionalstart: number

          The beginning of the specified portion of the array.

          +
        • Optionalend: number

          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        Returns Float32Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    sort

    • sort(compareFn?): this

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +

        Parameters

        • OptionalcompareFn: ((a: number, b: number) => number)

          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

          -
          [11,2,22,1].sort((a, b) => a - b)
-
          +
          [11,2,22,1].sort((a, b) => a - b)
+
          +
            • (a, b): number

            • Parameters

              • a: number
              • b: number

              Returns number

        Returns this

    sqrDist

    squaredDistance

    • squaredDistance(b): number

    • Calculates the squared euclidian distance between another Vec3 and this. Equivalent to Vec3.squaredDistance(this, b);

      @@ -300,8 +317,8 @@

    sub

    subarray

    • subarray(begin?, end?): Float32Array

    • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        +

        Parameters

        • Optionalbegin: number

          The index of the beginning of the array.

          +
        • Optionalend: number

          The index of the end of the array.

        Returns Float32Array

    subtract

    • subtract(b): Vec3

    • Subtracts a Vec3 from this. Equivalent to Vec3.subtract(this, this, b);

      Parameters

      • b: Readonly<Vec3Like>

        The vector to subtract from this

        @@ -310,49 +327,53 @@

        Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      Returns string

    valueOf

    • valueOf(): Float32Array

    • Returns the primitive value of the specified object.

      Returns Float32Array

    values

    Static angle

    • angle(a, b): number

    • Get the angle between two 3D vectors

      +

      Returns IterableIterator<number>

    Staticangle

    • angle(a, b): number

    • Get the angle between two 3D vectors

      Parameters

      Returns number

      The angle in radians

      -

    Static dist

    Static from

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      +

    Staticdist

    Staticfrom

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<number>

        An array-like or iterable object to convert to an array.

      Returns Float32Array

    • from<T>(arrayLike, mapfn, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like or iterable object to convert to an array.

        -
      • mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        +
      • mapfn: ((v: T, k: number) => number)

        A mapping function to call on every element of the array.

        +
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns Float32Array

    • from(arrayLike, mapfn?, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: Iterable<number>

        An array-like or iterable object to convert to an array.

        -
      • Optional mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: number
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -

      Returns Float32Array

    Static of

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      -

      Parameters

      • Rest ...items: number[]

        A set of elements to include in the new array object.

        -

      Returns Float32Array

    Static rotateX

    • rotateX(out, a, b, rad): Vec3Like

    • Rotate a 3D vector around the x-axis

      +
    • Optionalmapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

      +
        • (v, k): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array

    Staticof

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      +

      Parameters

      • Rest...items: number[]

        A set of elements to include in the new array object.

        +

      Returns Float32Array

    StaticrotateX

    Static rotateY

    • rotateY(out, a, b, rad): Vec3Like

    • Rotate a 3D vector around the y-axis

      +

    StaticrotateY

    Static rotateZ

    • rotateZ(out, a, b, rad): Vec3Like

    • Rotate a 3D vector around the z-axis

      +

    StaticrotateZ

    Static sqrDist

    Static sqrLen

    Static

    Static add

    StaticsqrDist

    StaticsqrLen

    Static

    Staticabs

    Staticadd

    Static bezier

    • bezier(out, a, b, c, d, t): Vec3Like

    • Performs a bezier interpolation with two control points

      +

    Staticbezier

    • bezier(out, a, b, c, d, t): Vec3Like

    • Performs a bezier interpolation with two control points

      Parameters

      Returns Vec3Like

      out

      -

    Static ceil

    • ceil(out, a): Vec3Like

    • Math.ceil the components of a vec3

      +

    Staticceil

    Static clone

    • clone(a): Vec3

    • Creates a new vec3 initialized with values from an existing vector

      +

    Staticclone

    • clone(a): Vec3

    • Creates a new vec3 initialized with values from an existing vector

      Parameters

      Returns Vec3

      a new 3D vector

      -

    Static copy

    • copy(out, a): Vec3Like

    • Copy the values from one vec3 to another

      +

    Staticcopy

    Static create

    • create(): Vec3

    • Creates a new, empty vec3

      +

    Staticcreate

    • create(): Vec3

    • Creates a new, empty vec3

      Returns Vec3

      a new 3D vector

      -

    Static cross

    • cross(out, a, b): Vec3Like

    • Computes the cross product of two vec3's

      +

    Staticcross

    Static distance

    • distance(a, b): number

    • Calculates the euclidian distance between two vec3's

      +

    Staticdistance

    • distance(a, b): number

    • Calculates the euclidian distance between two vec3's

      Parameters

      Returns number

      distance between a and b

      -

    Static div

    Static divide

    • divide(out, a, b): Vec3Like

    • Divides two vec3's

      +

    Staticdiv

    Staticdivide

    Static dot

    • dot(a, b): number

    • Calculates the dot product of two vec3's

      +

    Staticdot

    • dot(a, b): number

    • Calculates the dot product of two vec3's

      Parameters

      Returns number

      dot product of a and b

      -

    Static equals

    • equals(a, b): boolean

    • Returns whether or not the vectors have approximately the same elements in the same position.

      +

    Staticequals

    • equals(a, b): boolean

    • Returns whether or not the vectors have approximately the same elements in the same position.

      Parameters

      Returns boolean

      True if the vectors are equal, false otherwise.

      -

    Static exactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

      +

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

      Parameters

      Returns boolean

      True if the vectors are equal, false otherwise.

      -

    Static floor

    • floor(out, a): Vec3Like

    • Math.floor the components of a vec3

      +

    Staticfloor

    Static fromValues

    • fromValues(x, y, z): Vec3

    • Creates a new vec3 initialized with the given values

      +

    StaticfromValues

    • fromValues(x, y, z): Vec3

    • Creates a new vec3 initialized with the given values

      Parameters

      • x: number

        X component

      • y: number

        Y component

      • z: number

        Z component

      Returns Vec3

      a new 3D vector

      -

    Static hermite

    • hermite(out, a, b, c, d, t): Vec3Like

    • Performs a hermite interpolation with two control points

      +

    Statichermite

    • hermite(out, a, b, c, d, t): Vec3Like

    • Performs a hermite interpolation with two control points

      Parameters

      Returns Vec3Like

      out

      -

    Static inverse

    • inverse(out, a): Vec3Like

    • Returns the inverse of the components of a vec3

      +

    Staticinverse

    Static len

    Static length

    Staticlen

    Staticlength

    Static lerp

    • lerp(out, a, b, t): Vec3Like

    • Performs a linear interpolation between two vec3's

      +

      Deprecated

      Use Vec3.magnitude to avoid conflicts with builtin length methods/attribs

      +

    Staticlerp

    • lerp(out, a, b, t): Vec3Like

    • Performs a linear interpolation between two vec3's

      Parameters

      Returns Vec3Like

      out

      -

    Static mag

    Static magnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Vec3

      +

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Vec3

      Parameters

      Returns number

      Magnitude of a

      -

    Static max

    • max(out, a, b): Vec3Like

    • Returns the maximum of two vec3's

      +

    Staticmax

    Static min

    • min(out, a, b): Vec3Like

    • Returns the minimum of two vec3's

      +

    Staticmin

    Static mul

    Static multiply

    • multiply(out, a, b): Vec3Like

    • Multiplies two vec3's

      +

    Staticmul

    Staticmultiply

    Static negate

    • negate(out, a): Vec3Like

    • Negates the components of a vec3

      +

    Staticnegate

    Static normalize

    • normalize(out, a): Vec3Like

    • Normalize a vec3

      +

    Staticnormalize

    Static scale

    • scale(out, a, scale): Vec3Like

    • Scales a vec3 by a scalar number

      +

    Staticscale

    • scale(out, a, scale): Vec3Like

    • Scales a vec3 by a scalar number

      Parameters

      Returns Vec3Like

      out

      -

    Static scaleAndAdd

    • scaleAndAdd(out, a, b, scale): Vec3Like

    • Adds two vec3's after scaling the second operand by a scalar value

      +

    StaticscaleAndAdd

    • scaleAndAdd(out, a, b, scale): Vec3Like

    • Adds two vec3's after scaling the second operand by a scalar value

      Parameters

      Returns Vec3Like

      out

      -

    Static set

    • set(out, x, y, z): Vec3Like

    • Set the components of a vec3 to the given values

      +

    Staticset

    • set(out, x, y, z): Vec3Like

    • Set the components of a vec3 to the given values

      Parameters

      • out: Vec3Like

        the receiving vector

      • x: number

        X component

      • y: number

        Y component

      • z: number

        Z component

      Returns Vec3Like

      out

      -

    Static slerp

    • slerp(out, a, b, t): Vec3Like

    • Performs a spherical linear interpolation between two vec3's

      +

    Staticslerp

    • slerp(out, a, b, t): Vec3Like

    • Performs a spherical linear interpolation between two vec3's

      Parameters

      Returns Vec3Like

      out

      -

    Static squaredDistance

    • squaredDistance(a, b): number

    • Calculates the squared euclidian distance between two vec3's

      +

    StaticsquaredDistance

    • squaredDistance(a, b): number

    • Calculates the squared euclidian distance between two vec3's

      Parameters

      Returns number

      squared distance between a and b

      -

    Static squaredLength

    • squaredLength(a): number

    • Calculates the squared length of a vec3

      +

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a vec3

      Parameters

      Returns number

      squared length of a

      -

    Static str

    • str(a): string

    • Returns a string representation of a vector

      +

    Staticstr

    • str(a): string

    • Returns a string representation of a vector

      Parameters

      Returns string

      string representation of the vector

      -

    Static sub

    Static subtract

    • subtract(out, a, b): Vec3Like

    • Subtracts vector b from vector a

      +

    Staticsub

    Staticsubtract

    Static transformMat3

    • transformMat3(out, a, m): Vec3Like

    • Transforms the vec3 with a mat3.

      +

    StatictransformMat3

    • transformMat3(out, a, m): Vec3Like

    • Transforms the vec3 with a mat3.

      Parameters

      Returns Vec3Like

      out

      -

    Static transformMat4

    • transformMat4(out, a, m): Vec3Like

    • Transforms the vec3 with a mat4. +

    StatictransformMat4

    Static transformQuat

    • transformQuat(out, a, q): Vec3Like

    • Transforms the vec3 with a quat +

    StatictransformQuat

    • transformQuat(out, a, q): Vec3Like

    • Transforms the vec3 with a quat Can also be used for dual quaternions. (Multiply it with the real part)

      Parameters

      Returns Vec3Like

      out

      -

    Static zero

    • zero(out): Vec3Like

    • Set the components of a vec3 to zero

      +

    Staticzero

    • zero(out): Vec3Like

    • Set the components of a vec3 to zero

      Parameters

      Returns Vec3Like

      out

      -

    Vector components

    x

    • get x(): number

    • The x component of the vector. Equivalent to this[0];

      +

    Vector components

    x

    • get x(): number

    • The x component of the vector. Equivalent to this[0];

      Returns number

    • set x(value): void

    • Parameters

      • value: number

      Returns void

    y

    • get y(): number

    • The y component of the vector. Equivalent to this[1];

      Returns number

    • set y(value): void

    • Parameters

      • value: number

      Returns void

    z

    • get z(): number

    • The z component of the vector. Equivalent to this[2];

      -

      Returns number

    • set z(value): void

    • Parameters

      • value: number

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    bgrconstructorBYTES_PER_ELEMENT[toStringTag]bufferbyteLengthbyteOffsetlengthBYTES_PER_ELEMENTBYTE_LENGTHmagmagnitudesqrMagsquaredMagnitudestr[iterator]addatcopycopyWithindistdistancedivdividedotentrieseveryfillfilterfindfindIndexforEachincludesindexOfinvertjoinkeyslastIndexOfmapmulmultiplynegatenormalizereducereduceRightreversescalescaleAndAddsetslicesomesortsqrDistsquaredDistancesubsubarraysubtracttoLocaleStringtoStringvalueOfvaluesangledistfromofrotateXrotateYrotateZsqrDistsqrLenaddbezierceilclonecopycreatecrossdistancedivdividedotequalsexactEqualsfloorfromValueshermiteinverselenlengthlerpmagmagnitudemaxminmulmultiplynegatenormalizescalescaleAndAddsetslerpsquaredDistancesquaredLengthstrsubsubtracttransformMat3transformMat4transformQuatzeroxyz
    \ No newline at end of file +

    Returns number

  • set z(value): void

  • Parameters

    • value: number

    Returns void

    • Settings

    Member Visibility

    On This Page

    Color components
    Other
    Static
    Vector components
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_gl_matrix.Vec4.html b/docs/classes/_runtime_math_gl_matrix.Vec4.html index 828e1379..ca230cd1 100644 --- a/docs/classes/_runtime_math_gl_matrix.Vec4.html +++ b/docs/classes/_runtime_math_gl_matrix.Vec4.html @@ -1,21 +1,33 @@ -Vec4 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Vec4

    4 Dimensional Vector

    -

    Hierarchy

    Color components

    a +Vec4 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class Vec4

    4 Dimensional Vector

    +
    +
    + +
    + + Hierarchy
    +     +
    +
    +
    +

    Color components

    a b g r

    Other

    constructor -BYTES_PER_ELEMENT [toStringTag] buffer byteLength byteOffset +BYTES_PER_ELEMENT length BYTES_PER_ELEMENT -BYTE_LENGTH mag magnitude str +BYTE_LENGTH [iterator] +abs add at copy @@ -63,7 +75,8 @@ values from of -

    Static

    add +

    Static

    abs +add ceil clone copy @@ -108,26 +121,29 @@ x y z -

    Color components

    a

    • get a(): number

    • The a component of the vector. Equivalent to this[3];

      +

    Color components

    a

    • get a(): number

    • The a component of the vector. Equivalent to this[3];

      Returns number

    • set a(value): void

    • Parameters

      • value: number

      Returns void

    b

    • get b(): number

    • The b component of the vector. Equivalent to this[2];

      Returns number

    • set b(value): void

    • Parameters

      • value: number

      Returns void

    g

    • get g(): number

    • The g component of the vector. Equivalent to this[1];

      Returns number

    • set g(value): void

    • Parameters

      • value: number

      Returns void

    r

    • get r(): number

    • The r component of the vector. Equivalent to this[0];

      -

      Returns number

    • set r(value): void

    • Parameters

      • value: number

      Returns void

    Other

    constructor

    Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Readonly [toStringTag]

    [toStringTag]: "Float32Array"

    Readonly buffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    -

    Readonly byteLength

    byteLength: number

    The length in bytes of the array.

    -

    Readonly byteOffset

    byteOffset: number

    The offset in bytes of the array.

    -

    Readonly length

    length: number

    The length of the array.

    -

    Static Readonly BYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    -

    Static Readonly BYTE_LENGTH

    BYTE_LENGTH: number

    The number of bytes in a Vec4.

    -

    mag

    • get mag(): number

    • Alias for Vec4.magnitude

      +

      Returns number

    • set r(value): void

    • Parameters

      • value: number

      Returns void

    Other

    constructor

    Readonly[toStringTag]

    [toStringTag]: "Float32Array"

    Readonlybuffer

    buffer: ArrayBufferLike

    The ArrayBuffer instance referenced by the array.

    +

    ReadonlybyteLength

    byteLength: number

    The length in bytes of the array.

    +

    ReadonlybyteOffset

    byteOffset: number

    The offset in bytes of the array.

    +

    ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    Readonlylength

    length: number

    The length of the array.

    +

    Static ReadonlyBYTES_PER_ELEMENT

    BYTES_PER_ELEMENT: number

    The size in bytes of each element in the array.

    +

    mag

    magnitude

    • get magnitude(): number

    • The magnitude (length) of this. Equivalent to Vec4.magnitude(this);

      Magnitude is used because the length attribute is already defined by -Float32Array to mean the number of elements in the array.

      +TypedArrays to mean the number of elements in the array.

      Returns number

    str

    • get str(): string

    • A string representation of this Equivalent to Vec4.str(this);

      -

      Returns string

    [iterator]

    add

    • add(b): Vec4

    • Adds a Vec4 to this. +

      Returns string

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Vec4.

      +

    [iterator]

    abs

    • abs(): Vec4

    • Sets each component of this to it's absolute value. +Equivalent to Vec4.abs(this, this);

      +

      Returns Vec4

      this

      +

    add

    • add(b): Vec4

    • Adds a Vec4 to this. Equivalent to Vec4.add(this, this, b);

      Parameters

      Returns Vec4

      this

      @@ -142,7 +158,7 @@ length of the array.

  • start: number

    If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

    -
  • Optional end: number

    If not specified, length of the this object is used as its default value.

    +
  • Optionalend: number

    If not specified, length of the this object is used as its default value.

    • Returns this

    dist

    distance

    • distance(b): number

    • Calculates the euclidian distance between another Vec4 and this. Equivalent to Vec4.distance(this, b);

      @@ -159,64 +175,64 @@

    Returns number

    Dot product of this and b

    entries

    • entries(): IterableIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      Returns IterableIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The every method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    fill

    • fill(value, start?, end?): this

    • Changes all array elements from start to end index to a static value and returns the modified array

      Parameters

      • value: number

        value to fill array section with

        -
      • Optional start: number

        index to start filling the array at. If start is negative, it is treated as +

      • Optionalstart: number

        index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

        -
      • Optional end: number

        index to stop filling the array at. If end is negative, it is treated as +

      • Optionalend: number

        index to stop filling the array at. If end is negative, it is treated as length+end.

      Returns this

    filter

    • filter(predicate, thisArg?): Float32Array

    • Returns the elements of an array that meet the condition specified in a callback function.

      -

      Parameters

      • predicate: ((value, index, array) => any)

        A function that accepts up to three arguments. The filter method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => any)

          A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

          -
            • (value, index, array): any

            • Parameters

              Returns any

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): any

            • Parameters

              Returns any

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    find

    • find(predicate, thisArg?): number

    • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    findIndex

    • findIndex(predicate, thisArg?): number

    • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

      -

      Parameters

      • predicate: ((value, index, obj) => boolean)

        find calls predicate once for each element of the array, in ascending +

        Parameters

        • predicate: ((value: number, index: number, obj: Float32Array) => boolean)

          find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

          -
            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • Optional thisArg: any

          If provided, it will be used as the this value for each invocation of +

            • (value, index, obj): boolean

            • Parameters

              Returns boolean

        • OptionalthisArg: any

          If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

        Returns number

    forEach

    • forEach(callbackfn, thisArg?): void

    • Performs the specified action for each element in an array.

      -

      Parameters

      • callbackfn: ((value, index, array) => void)

        A function that accepts up to three arguments. forEach calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => void)

          A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): void

            • Parameters

              Returns void

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): void

            • Parameters

              Returns void

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns void

    includes

    • includes(searchElement, fromIndex?): boolean

    • Determines whether an array includes a certain element, returning true or false as appropriate.

      Parameters

      • searchElement: number

        The element to search for.

        -
      • Optional fromIndex: number

        The position in this array at which to begin searching for searchElement.

        +
      • OptionalfromIndex: number

        The position in this array at which to begin searching for searchElement.

      Returns boolean

    indexOf

    • indexOf(searchElement, fromIndex?): number

    • Returns the index of the first occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

        +
      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +search starts at index 0.

      Returns number

    invert

    • invert(): Vec4

    • Inverts the components of this. Equivalent to Vec4.inverse(this, this);

      Returns Vec4

      this

    join

    • join(separator?): string

    • Adds all the elements of an array separated by the specified separator string.

      -

      Parameters

      • Optional separator: string

        A string used to separate one element of an array from the next in the +

        Parameters

        • Optionalseparator: string

          A string used to separate one element of an array from the next in the resulting String. If omitted, the array elements are separated with a comma.

        Returns string

    keys

    lastIndexOf

    • lastIndexOf(searchElement, fromIndex?): number

    • Returns the index of the last occurrence of a value in an array.

      Parameters

      • searchElement: number

        The value to locate in the array.

        -
      • Optional fromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the +

      • OptionalfromIndex: number

        The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

      Returns number

    map

    • map(callbackfn, thisArg?): Float32Array

    • Calls a defined callback function on each element of an array, and returns an array that contains the results.

      -

      Parameters

      • callbackfn: ((value, index, array) => number)

        A function that accepts up to three arguments. The map method calls the +

        Parameters

        • callbackfn: ((value: number, index: number, array: Float32Array) => number)

          A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

          -
            • (value, index, array): number

            • Parameters

              Returns number

        • Optional thisArg: any

          An object to which the this keyword can refer in the callbackfn function. +

            • (value, index, array): number

            • Parameters

              Returns number

        • OptionalthisArg: any

          An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

        Returns Float32Array

    mul

    multiply

    • multiply(b): Vec4

    • Multiplies this by a Vec4. @@ -232,12 +248,12 @@

    reduce

    • reduce(callbackfn): number

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduce method calls the +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduce(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduce<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array. The return value of +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduce(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduce<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduce method calls the +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -245,12 +261,12 @@

        Returns U

    reduceRight

    • reduceRight(callbackfn): number

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)

        A function that accepts up to four arguments. The reduceRight method calls +

        Parameters

        • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

          -
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        Returns number

      • reduceRight(callbackfn, initialValue): number

      • Parameters

        • callbackfn: ((previousValue, currentValue, currentIndex, array) => number)
            • (previousValue, currentValue, currentIndex, array): number

            • Parameters

              • previousValue: number
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns number

        • initialValue: number

        Returns number

      • reduceRight<U>(callbackfn, initialValue): U

      • Calls the specified callback function for all the elements in an array, in descending order. +

          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      Returns number

    • reduceRight(callbackfn, initialValue): number

    • Parameters

      • callbackfn: ((previousValue: number, currentValue: number, currentIndex: number, array: Float32Array) => number)
          • (previousValue, currentValue, currentIndex, array): number

          • Parameters

            • previousValue: number
            • currentValue: number
            • currentIndex: number
            • array: Float32Array

            Returns number

      • initialValue: number

      Returns number

    • reduceRight<U>(callbackfn, initialValue): U

    • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

      -

      Type Parameters

      • U

      Parameters

      • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

        A function that accepts up to four arguments. The reduceRight method calls +

        Type Parameters

        • U

        Parameters

        • callbackfn: ((previousValue: U, currentValue: number, currentIndex: number, array: Float32Array) => U)

          A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

            • (previousValue, currentValue, currentIndex, array): U

            • Parameters

              • previousValue: U
              • currentValue: number
              • currentIndex: number
              • array: Float32Array

              Returns U

        • initialValue: U

          If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument @@ -267,22 +283,23 @@

        Returns Vec4

        this

    set

    • set(array, offset?): void

    • Sets a value or an array of values.

      Parameters

      • array: ArrayLike<number>

        A typed or untyped array of values to set.

        -
      • Optional offset: number

        The index in the current array at which the values are to be written.

        +
      • Optionaloffset: number

        The index in the current array at which the values are to be written.

      Returns void

    slice

    • slice(start?, end?): Float32Array

    • Returns a section of an array.

      -

      Parameters

      • Optional start: number

        The beginning of the specified portion of the array.

        -
      • Optional end: number

        The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        +

        Parameters

        • Optionalstart: number

          The beginning of the specified portion of the array.

          +
        • Optionalend: number

          The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

        Returns Float32Array

    some

    • some(predicate, thisArg?): boolean

    • Determines whether the specified callback function returns true for any element of an array.

      -

      Parameters

      • predicate: ((value, index, array) => unknown)

        A function that accepts up to three arguments. The some method calls +

        Parameters

        • predicate: ((value: number, index: number, array: Float32Array) => unknown)

          A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

          -
            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • Optional thisArg: any

          An object to which the this keyword can refer in the predicate function. +

            • (value, index, array): unknown

            • Parameters

              Returns unknown

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

        Returns boolean

    sort

    • sort(compareFn?): this

    • Sorts an array.

      -

      Parameters

      • Optional compareFn: ((a, b) => number)

        Function used to determine the order of the elements. It is expected to return +

        Parameters

        • OptionalcompareFn: ((a: number, b: number) => number)

          Function used to determine the order of the elements. It is expected to return a negative value if first argument is less than second argument, zero if they're equal and a positive value otherwise. If omitted, the elements are sorted in ascending order.

          -
          [11,2,22,1].sort((a, b) => a - b)
-
          +
          [11,2,22,1].sort((a, b) => a - b)
+
          +
            • (a, b): number

            • Parameters

              • a: number
              • b: number

              Returns number

        Returns this

    sqrDist

    squaredDistance

    • squaredDistance(b): number

    • Calculates the squared euclidian distance between another Vec4 and this. Equivalent to Vec4.squaredDistance(this, b);

      @@ -291,8 +308,8 @@

    sub

    subarray

    • subarray(begin?, end?): Float32Array

    • Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements at begin, inclusive, up to end, exclusive.

      -

      Parameters

      • Optional begin: number

        The index of the beginning of the array.

        -
      • Optional end: number

        The index of the end of the array.

        +

        Parameters

        • Optionalbegin: number

          The index of the beginning of the array.

          +
        • Optionalend: number

          The index of the end of the array.

        Returns Float32Array

    subtract

    • subtract(b): Vec4

    • Subtracts a Vec4 from this. Equivalent to Vec4.subtract(this, this, b);

      Parameters

      • b: Readonly<Vec4Like>

        The vector to subtract from this

        @@ -301,172 +318,176 @@

        Returns string

    toString

    • toString(): string

    • Returns a string representation of an array.

      Returns string

    valueOf

    • valueOf(): Float32Array

    • Returns the primitive value of the specified object.

      Returns Float32Array

    values

    Static from

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      +

      Returns IterableIterator<number>

    Staticfrom

    • from(arrayLike): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: ArrayLike<number>

        An array-like or iterable object to convert to an array.

      Returns Float32Array

    • from<T>(arrayLike, mapfn, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Type Parameters

      • T

      Parameters

      • arrayLike: ArrayLike<T>

        An array-like or iterable object to convert to an array.

        -
      • mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        +
      • mapfn: ((v: T, k: number) => number)

        A mapping function to call on every element of the array.

        +
          • (v, k): number

          • Parameters

            • v: T
            • k: number

            Returns number

      • OptionalthisArg: any

        Value of 'this' used to invoke the mapfn.

      Returns Float32Array

    • from(arrayLike, mapfn?, thisArg?): Float32Array

    • Creates an array from an array-like or iterable object.

      Parameters

      • arrayLike: Iterable<number>

        An array-like or iterable object to convert to an array.

        -
      • Optional mapfn: ((v, k) => number)

        A mapping function to call on every element of the array.

        -
          • (v, k): number

          • Parameters

            • v: number
            • k: number

            Returns number

      • Optional thisArg: any

        Value of 'this' used to invoke the mapfn.

        -

      Returns Float32Array

    Static of

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      -

      Parameters

      • Rest ...items: number[]

        A set of elements to include in the new array object.

        -

      Returns Float32Array

    Static

    Static add

    • add(out, a, b): Vec4Like

    • Adds two Vec4s

      +
    • Optionalmapfn: ((v: number, k: number) => number)

      A mapping function to call on every element of the array.

      +
        • (v, k): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • OptionalthisArg: any

      Value of 'this' used to invoke the mapfn.

      +

    Returns Float32Array

    Staticof

    • of(...items): Float32Array

    • Returns a new array from a set of elements.

      +

      Parameters

      • Rest...items: number[]

        A set of elements to include in the new array object.

        +

      Returns Float32Array

    Static

    Staticabs

    Staticadd

    Static ceil

    Staticceil

    Static clone

    • clone(a): Vec4

    • Creates a new Vec4 initialized with values from an existing vector

      +

    Staticclone

    • clone(a): Vec4

    • Creates a new Vec4 initialized with values from an existing vector

      Parameters

      Returns Vec4

      a new 4D vector

      -

    Static copy

    • copy(out, a): Vec4Like

    • Copy the values from one Vec4 to another

      +

    Staticcopy

    Static create

    • create(): Vec4

    • Creates a new, empty Vec4

      +

    Staticcreate

    • create(): Vec4

    • Creates a new, empty Vec4

      Returns Vec4

      a new 4D vector

      -

    Static cross

    • cross(out, u, v, w): Vec4Like

    • Returns the cross-product of three vectors in a 4-dimensional space

      +

    Staticcross

    Static dist

    Static distance

    • distance(a, b): number

    • Calculates the euclidian distance between two Vec4's

      +

    Staticdist

    Staticdistance

    • distance(a, b): number

    • Calculates the euclidian distance between two Vec4's

      Parameters

      Returns number

      distance between a and b

      -

    Static div

    Static divide

    Staticdiv

    Staticdivide

    Static dot

    • dot(a, b): number

    • Calculates the dot product of two Vec4's

      +

    Staticdot

    • dot(a, b): number

    • Calculates the dot product of two Vec4's

      Parameters

      Returns number

      dot product of a and b

      -

    Static equals

    • equals(a, b): boolean

    • Returns whether or not the vectors have approximately the same elements in the same position.

      +

    Staticequals

    • equals(a, b): boolean

    • Returns whether or not the vectors have approximately the same elements in the same position.

      Parameters

      Returns boolean

      True if the vectors are equal, false otherwise.

      -

    Static exactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

      +

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether or not the vectors have exactly the same elements in the same position (when compared with ===)

      Parameters

      Returns boolean

      True if the vectors are equal, false otherwise.

      -

    Static floor

    • floor(out, a): Vec4Like

    • Math.floor the components of a Vec4

      +

    Staticfloor

    Static fromValues

    • fromValues(x, y, z, w): Vec4

    • Creates a new Vec4 initialized with the given values

      +

    StaticfromValues

    • fromValues(x, y, z, w): Vec4

    • Creates a new Vec4 initialized with the given values

      Parameters

      • x: number

        X component

      • y: number

        Y component

      • z: number

        Z component

      • w: number

        W component

      Returns Vec4

      a new 4D vector

      -

    Static inverse

    • inverse(out, a): Vec4Like

    • Returns the inverse of the components of a Vec4

      +

    Staticinverse

    Static len

    Static length

    Static lerp

    • lerp(out, a, b, t): Vec4Like

    • Performs a linear interpolation between two Vec4's

      +

    Staticlen

    Staticlength

    Staticlerp

    Static mag

    Static magnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Vec4

      +

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Vec4

      Parameters

      Returns number

      length of a

      -

    Static max

    Staticmax

    Static min

    Staticmin

    Static mul

    Static multiply

    Staticmul

    Staticmultiply

    Static negate

    Staticnegate

    Static normalize

    Staticnormalize

    Static round

    • round(out, a): Vec4Like

    • Math.round the components of a Vec4

      +

    Staticround

    Static scale

    • scale(out, a, scale): Vec4Like

    • Scales a Vec4 by a scalar number

      +

    Staticscale

    Static scaleAndAdd

    • scaleAndAdd(out, a, b, scale): Vec4Like

    • Adds two Vec4's after scaling the second operand by a scalar value

      +

    StaticscaleAndAdd

    • scaleAndAdd(out, a, b, scale): Vec4Like

    • Adds two Vec4's after scaling the second operand by a scalar value

      Parameters

      Returns Vec4Like

      out

      -

    Static set

    • set(out, x, y, z, w): Vec4Like

    • Set the components of a Vec4 to the given values

      +

    Staticset

    • set(out, x, y, z, w): Vec4Like

    • Set the components of a Vec4 to the given values

      Parameters

      • out: Vec4Like

        the receiving vector

      • x: number

        X component

      • y: number

        Y component

      • z: number

        Z component

      • w: number

        W component

      Returns Vec4Like

      out

      -

    Static sqrDist

    Static sqrLen

    Static squaredDistance

    • squaredDistance(a, b): number

    • Calculates the squared euclidian distance between two Vec4's

      +

    StaticsqrDist

    StaticsqrLen

    StaticsquaredDistance

    • squaredDistance(a, b): number

    • Calculates the squared euclidian distance between two Vec4's

      Parameters

      Returns number

      squared distance between a and b

      -

    Static squaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Vec4

      +

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Vec4

      Parameters

      Returns number

      squared length of a

      -

    Static str

    • str(a): string

    • Returns a string representation of a Vec4

      +

    Staticstr

    • str(a): string

    • Returns a string representation of a Vec4

      Parameters

      Returns string

      string representation of the vector

      -

    Static sub

    Static subtract

    • subtract(out, a, b): Vec4Like

    • Subtracts vector b from vector a

      +

    Staticsub

    Staticsubtract

    Static transformMat4

    StatictransformMat4

    Static transformQuat

    StatictransformQuat

    Static zero

    Staticzero

    Vector components

    w

    • get w(): number

    • The w component of the vector. Equivalent to this[3];

      +

    Vector components

    w

    • get w(): number

    • The w component of the vector. Equivalent to this[3];

      Returns number

    • set w(value): void

    • Parameters

      • value: number

      Returns void

    x

    • get x(): number

    • The x component of the vector. Equivalent to this[0];

      Returns number

    • set x(value): void

    • Parameters

      • value: number

      Returns void

    y

    • get y(): number

    • The y component of the vector. Equivalent to this[1];

      Returns number

    • set y(value): void

    • Parameters

      • value: number

      Returns void

    z

    • get z(): number

    • The z component of the vector. Equivalent to this[2];

      -

      Returns number

    • set z(value): void

    • Parameters

      • value: number

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    abgrconstructorBYTES_PER_ELEMENT[toStringTag]bufferbyteLengthbyteOffsetlengthBYTES_PER_ELEMENTBYTE_LENGTHmagmagnitudestr[iterator]addatcopycopyWithindistdistancedivdividedotentrieseveryfillfilterfindfindIndexforEachincludesindexOfinvertjoinkeyslastIndexOfmapmulmultiplynegatenormalizereducereduceRightreversescalescaleAndAddsetslicesomesortsqrDistsquaredDistancesubsubarraysubtracttoLocaleStringtoStringvalueOfvaluesfromofaddceilclonecopycreatecrossdistdistancedivdividedotequalsexactEqualsfloorfromValuesinverselenlengthlerpmagmagnitudemaxminmulmultiplynegatenormalizeroundscalescaleAndAddsetsqrDistsqrLensquaredDistancesquaredLengthstrsubsubtracttransformMat4transformQuatzerowxyz
    \ No newline at end of file +

    Returns number

  • set z(value): void

  • Parameters

    • value: number

    Returns void

    • Settings

    Member Visibility

    On This Page

    Color components
    Other
    Static
    Vector components
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_physics.TJSVelocityTrack.html b/docs/classes/_runtime_math_physics.TJSVelocityTrack.html index e870cbf8..409d0949 100644 --- a/docs/classes/_runtime_math_physics.TJSVelocityTrack.html +++ b/docs/classes/_runtime_math_physics.TJSVelocityTrack.html @@ -1,35 +1,36 @@ -TJSVelocityTrack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class TJSVelocityTrack

    Provides a way to calculate velocity via effectively creating a "complementary filter".

    +TJSVelocityTrack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class TJSVelocityTrack

    Provides a way to calculate velocity via effectively creating a "complementary filter".

    velQuick and velSmooth separately accumulate over time. velInstant and velUsed do not accumulate and are discarded each update. velQuick is responsive, but noisy. velSmooth is laggy but eventually more accurate. By tracking them separately the used result can be responsive in the short term and accurate in the long term.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Accessors

    resetDeltaTime scaleTime

    Methods

    get reset update -

    Constructors

    constructor

    • new TJSVelocityTrack(opts?): TJSVelocityTrack

    • Creates a velocity tracker instance.

      -

      Parameters

      • Optional opts: {
            resetDeltaTime?: number;
            scaleTime?: number;
        }

        Optional parameters.

        -
        • Optional resetDeltaTime?: number

          Delta time in milliseconds that resets velocity tracking.

          -
        • Optional scaleTime?: number

          Scales velocity calculation to new time frame. 1000 is velocity per - second.

          -

      Returns TJSVelocityTrack

    Accessors

    resetDeltaTime

    • get resetDeltaTime(): number

    • Returns number

      Gets resetDeltaTime.

      +

    Constructors

    constructor

    • new TJSVelocityTrack(opts?): TJSVelocityTrack

    • Creates a velocity tracker instance.

      +

      Parameters

      • Optionalopts: {
            resetDeltaTime?: number;
            scaleTime?: number;
        }

        Optional parameters.

        +
        • OptionalresetDeltaTime?: number

          Delta time in milliseconds that resets velocity tracking.

          +
        • OptionalscaleTime?: number

          Scales velocity calculation to new time frame. 1000 is velocity per +second.

          +

      Returns TJSVelocityTrack

    Accessors

    resetDeltaTime

    • get resetDeltaTime(): number

    • Returns number

      Gets resetDeltaTime.

    • set resetDeltaTime(resetDeltaTime): void

    • Sets resetDeltaTime.

      Parameters

      • resetDeltaTime: number

        Delta time in milliseconds that resets velocity tracking.

      Returns void

    scaleTime

    • get scaleTime(): number

    • Returns number

      Gets scaleTime.

    • set scaleTime(scaleTime): void

    • Sets scaleTime.

      Parameters

      • scaleTime: number

        Scales velocity calculation to new time frame. 1000 is velocity per second.

        -

      Returns void

    Methods

    get

    • get(): {
          x: number;
          y: number;
          z: number;
      }

    • Gets the current velocity tracking data.

      +

    Returns void

    Methods

    get

    • get(): {
          x: number;
          y: number;
          z: number;
      }

    • Gets the current velocity tracking data.

      Returns {
          x: number;
          y: number;
          z: number;
      }

      Velocity tracking data.

      • x: number
      • y: number
      • z: number

    reset

    • reset(x?, y?, z?, sampleTime?): void

    • Resets velocity tracking data.

      -

      Parameters

      • Optional x: number

        'X' value to set to last sample point.

        -
      • Optional y: number

        'Y' value to set to last sample point.

        -
      • Optional z: number

        'Z' value to set to last sample point.

        -
      • Optional sampleTime: number

        A sample time in milliseconds resolution.

        +

        Parameters

        • Optionalx: number

          'X' value to set to last sample point.

          +
        • Optionaly: number

          'Y' value to set to last sample point.

          +
        • Optionalz: number

          'Z' value to set to last sample point.

          +
        • OptionalsampleTime: number

          A sample time in milliseconds resolution.

        Returns void

    update

    • update(x?, y?, z?, sampleTime?): {
          x: number;
          y: number;
          z: number;
      }

    • Runs ongoing velocity calculation of x / y / z given a sample time.

      -

      Parameters

      • Optional x: number

        New sample X

        -
      • Optional y: number

        New sample Y

        -
      • Optional z: number

        New sample Z

        -
      • Optional sampleTime: number

        An optional specific time w/ millisecond resolution.

        +

        Parameters

        • Optionalx: number

          New sample X

          +
        • Optionaly: number

          New sample Y

          +
        • Optionalz: number

          New sample Z

          +
        • OptionalsampleTime: number

          An optional specific time w/ millisecond resolution.

        Returns {
            x: number;
            y: number;
            z: number;
        }

        current velocity.

        -
        • x: number
        • y: number
        • z: number

    Settings

    Member Visibility

    Theme

    On This Page

    constructorresetDeltaTimescaleTimegetresetupdate
    \ No newline at end of file +
    • x: number
    • y: number
    • z: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_math_util.MathRandom.html b/docs/classes/_runtime_math_util.MathRandom.html index 44b3df09..47a436fb 100644 --- a/docs/classes/_runtime_math_util.MathRandom.html +++ b/docs/classes/_runtime_math_util.MathRandom.html @@ -1,20 +1,21 @@ -MathRandom | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class MathRandom

    Provides methods for retrieving pseudorandom values and other utilities using Math.random.

    -

    Constructors

    constructor +MathRandom | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
    +

    Class MathRandom

    Provides methods for retrieving pseudorandom values and other utilities using Math.random.

    +

    Constructors

    constructor

    Methods

    getBoolean getFloat getInt shuffleArray -

    Constructors

    constructor

    Methods

    Static getBoolean

    • getBoolean(): boolean

    • Returns a random boolean.

      +

    Constructors

    constructor

    Methods

    StaticgetBoolean

    • getBoolean(): boolean

    • Returns a random boolean.

      Returns boolean

      Random boolean.

      -

    Static getFloat

    • getFloat(min, max): number

    • Returns a random floating point number between min (inclusive) and max (exclusive).

      +

    StaticgetFloat

    • getFloat(min, max): number

    • Returns a random floating point number between min (inclusive) and max (exclusive).

      Parameters

      • min: number

        Minimum value

      • max: number

        Maximum value.

      Returns number

      Random float.

      -

    Static getInt

    • getInt(min, max): number

    • Returns a random inclusive integer.

      +

    StaticgetInt

    • getInt(min, max): number

    • Returns a random inclusive integer.

      Parameters

      • min: number

        Minimum value.

      • max: number

        Maximum value.

      Returns number

      Random inclusive integer.

      -

    Static shuffleArray

    • shuffleArray<T>(arr): T[]

    • Shuffles an array using the Fisher-Yates shuffle algorithm. Modifies the input array in place and returns it.

      +

    StaticshuffleArray

    • shuffleArray<T>(arr): T[]

    • Shuffles an array using the Fisher-Yates shuffle algorithm. Modifies the input array in place and returns it.

      Type Parameters

      • T

      Parameters

      • arr: T[]

        The array to shuffle.

      Returns T[]

      The shuffled array.

      -

    Settings

    Member Visibility

    Theme

    On This Page

    constructorgetBooleangetFloatgetIntshuffleArray
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_plugin_manager.PluginInvokeEvent.html b/docs/classes/_runtime_plugin_manager.PluginInvokeEvent.html index e068c88d..e8dd68af 100644 --- a/docs/classes/_runtime_plugin_manager.PluginInvokeEvent.html +++ b/docs/classes/_runtime_plugin_manager.PluginInvokeEvent.html @@ -1,19 +1,20 @@ -PluginInvokeEvent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class PluginInvokeEvent

    PluginEvent - Provides the data / event passed to all invoked methods in +PluginInvokeEvent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class PluginInvokeEvent

    PluginEvent - Provides the data / event passed to all invoked methods in PluginInvokeSupport#invokeSyncEvent. The event.data field is returned to the caller. Before returning though additional the following additional metadata is attached:

    (number) $$plugin_invoke_count - The count of plugins invoked.

    (string[]) $$plugin_invoke_names - The names of plugins invoked.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Properties

    data eventbus pluginName pluginOptions -

    Constructors

    constructor

    • new PluginInvokeEvent(copyProps?, passthruProps?): PluginInvokeEvent

    • Initializes PluginEvent.

      -

      Parameters

      • Optional copyProps: object

        Event data to copy.

        -
      • Optional passthruProps: object

        Event data to pass through.

        -

      Returns PluginInvokeEvent

    Properties

    data

    data: object

    Provides the unified event data assigning any pass through data to the copied data supplied. Invoked functions +

    Constructors

    constructor

    • new PluginInvokeEvent(copyProps?, passthruProps?): PluginInvokeEvent

    • Initializes PluginEvent.

      +

      Parameters

      • OptionalcopyProps: object

        Event data to copy.

        +
      • OptionalpassthruProps: object

        Event data to pass through.

        +

      Returns PluginInvokeEvent

    Properties

    data

    data: object

    Provides the unified event data assigning any pass through data to the copied data supplied. Invoked functions may add to or modify this data.

    eventbus

    eventbus: EventbusProxy

    Unique data available in each plugin invoked.

    pluginName

    pluginName: string

    Unique data available in each plugin invoked.

    pluginOptions

    pluginOptions: object

    Unique data available in each plugin invoked.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    constructordataeventbuspluginNamepluginOptions
    \ No newline at end of file +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    \ No newline at end of file diff --git a/docs/classes/_runtime_plugin_manager.PluginInvokeSupport.html b/docs/classes/_runtime_plugin_manager.PluginInvokeSupport.html index 62773532..33af61fe 100644 --- a/docs/classes/_runtime_plugin_manager.PluginInvokeSupport.html +++ b/docs/classes/_runtime_plugin_manager.PluginInvokeSupport.html @@ -1,4 +1,5 @@ -PluginInvokeSupport | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class PluginInvokeSupport

    PluginInvokeSupport adds direct method invocation support to PluginManager via the eventbus and alternately through +PluginInvokeSupport | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class PluginInvokeSupport

    PluginInvokeSupport adds direct method invocation support to PluginManager via the eventbus and alternately through a wrapped instance of PluginManager depending on the use case.

    There are two types of invocation methods the first spreads an array of arguments to the invoked method. The second constructs a PluginInvokeEvent to pass to the method with a single parameter.

    @@ -12,9 +13,10 @@

    plugins:invoke - PluginInvokeSupport#invoke

    plugins:sync:invoke - PluginInvokeSupport#invokeSync

    plugins:sync:invoke:event - PluginInvokeSupport#invokeSyncEvent

    -

    Example

    // One can also indirectly invoke any method of the plugin.
    // Any plugin with a method named `aCoolMethod` is invoked.
    eventbus.triggerSync('plugins:invoke:sync:event', { method: 'aCoolMethod' });

    // A specific invocation just for the 'an-npm-plugin-enabled-module'
    eventbus.triggerSync('plugins:invoke:sync:event', {
       method: 'aCoolMethod',
       plugins: 'an-npm-plugin-enabled-module'
    });

    // There are two other properties `copyProps` and `passthruProps` which can be set with object data to _copy_ or
    // _pass through_ to the invoked method.
-
    -

    Implements

    Constructors

    constructor +

    Example

    // One can also indirectly invoke any method of the plugin.
    // Any plugin with a method named `aCoolMethod` is invoked.
    eventbus.triggerSync('plugins:invoke:sync:event', { method: 'aCoolMethod' });

    // A specific invocation just for the 'an-npm-plugin-enabled-module'
    eventbus.triggerSync('plugins:invoke:sync:event', {
       method: 'aCoolMethod',
       plugins: 'an-npm-plugin-enabled-module'
    });

    // There are two other properties `copyProps` and `passthruProps` which can be set with object data to _copy_ or
    // _pass through_ to the invoked method.
+
    + +

    Implements

    Constructors

    constructor

    Accessors

    isDestroyed options pluginManager @@ -28,65 +30,65 @@ invokeSyncEvent setEventbus setOptions -

    Constructors

    constructor

    Constructors

    constructor

    Accessors

    isDestroyed

    • get isDestroyed(): boolean

    • Returns whether the associated plugin manager has been destroyed.

      +

    Returns PluginInvokeSupport

    Accessors

    isDestroyed

    • get isDestroyed(): boolean

    • Returns whether the associated plugin manager has been destroyed.

      Returns boolean

      Returns whether the plugin manager has been destroyed.

    options

    pluginManager

    Methods

    destroy

    • destroy(opts): Promise<void>

    • Destroys all managed plugins after unloading them.

      -

      Parameters

      • opts: {
            eventPrepend: string;
            eventbus: Eventbus;
        }

        An options object.

        -
        • eventPrepend: string

          The current event prepend.

          -
        • eventbus: Eventbus

          The eventbus to disassociate.

          +

    Methods

    destroy

    • destroy(opts): Promise<void>

    • Destroys all managed plugins after unloading them.

      +

      Parameters

      • opts: {
            eventbus: Eventbus;
            eventPrepend: string;
        }

        An options object.

        +
        • eventbus: Eventbus

          The eventbus to disassociate.

          +
        • eventPrepend: string

          The current event prepend.

      Returns Promise<void>

    getMethodNames

    • getMethodNames(opts?): string[]

    • Returns method names for a specific plugin, list of plugins, or all plugins. The enabled state can be specified along with sorting methods by plugin name.

      -

      Parameters

      • Optional opts: {
            enabled?: boolean;
            plugins?: string | Iterable<string>;
        }

        Options object. If undefined all plugin data is returned.

        -
        • Optional enabled?: boolean

          If enabled is a boolean it will return plugin methods names - given the respective enabled state.

          -
        • Optional plugins?: string | Iterable<string>

          Plugin name or iterable list of names.

          +

          Parameters

          • Optionalopts: {
                enabled?: boolean;
                plugins?: string | Iterable<string>;
            }

            Options object. If undefined all plugin data is returned.

            +
            • Optionalenabled?: boolean

              If enabled is a boolean it will return plugin methods names +given the respective enabled state.

              +
            • Optionalplugins?: string | Iterable<string>

              Plugin name or iterable list of names.

          Returns string[]

          A list of method names

    hasMethod

    • hasMethod(opts): boolean

    • Checks if the provided method name exists across all plugins or specific plugins if defined.

      Parameters

      • opts: {
            method: string;
            plugins?: string | Iterable<string>;
        }

        Options object.

        • method: string

          Method name to test.

          -
        • Optional plugins?: string | Iterable<string>

          Plugin name or iterable list of names to check for method. If - undefined all plugins must contain the method.

          +
        • Optionalplugins?: string | Iterable<string>

          Plugin name or iterable list of names to check for method. If +undefined all plugins must contain the method.

      Returns boolean

      • True method is found.

    invoke

    • invoke(opts): void

    • This dispatch method simply invokes any plugin targets for the given method name.

      Parameters

      • opts: {
            args?: any[];
            method: string;
            plugins?: string | Iterable<string>;
        }

        Options object.

        -
        • Optional args?: any[]

          Method arguments. This array will be spread as multiple arguments.

          +
          • Optionalargs?: any[]

            Method arguments. This array will be spread as multiple arguments.

          • method: string

            Method name to invoke.

            -
          • Optional plugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

            +
          • Optionalplugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

      Returns void

    invokeAsync

    • invokeAsync(opts): Promise<any>

    • This dispatch method is asynchronous and adds any returned results to an array which is resolved via Promise.all Any target invoked may return a Promise or any result.

      Parameters

      • opts: {
            args?: any[];
            method: string;
            plugins?: string | Iterable<string>;
        }

        Options object.

        -
        • Optional args?: any[]

          Method arguments. This array will be spread as multiple arguments.

          +
          • Optionalargs?: any[]

            Method arguments. This array will be spread as multiple arguments.

          • method: string

            Method name to invoke.

            -
          • Optional plugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

            +
          • Optionalplugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

      Returns Promise<any>

      A single result or array of results.

    invokeAsyncEvent

    • invokeAsyncEvent(opts): Promise<object>

    • This dispatch method synchronously passes to and returns from any invoked targets a PluginEvent.

      Parameters

      • opts: {
            copyProps?: object;
            method: string;
            passthruProps?: object;
            plugins?: string | Iterable<string>;
        }

        Options object.

        -
        • Optional copyProps?: object

          Properties that are copied.

          +
          • OptionalcopyProps?: object

            Properties that are copied.

          • method: string

            Method name to invoke.

            -
          • Optional passthruProps?: object

            Properties that are passed through.

            -
          • Optional plugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

            +
          • OptionalpassthruProps?: object

            Properties that are passed through.

            +
          • Optionalplugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

      Returns Promise<object>

      The PluginEvent data.

    invokeSync

    • invokeSync(opts): any

    • This dispatch method synchronously passes back a single value or an array with all results returned by any invoked targets.

      Parameters

      • opts: {
            args?: any[];
            method: string;
            plugins?: string | Iterable<string>;
        }

        Options object.

        -
        • Optional args?: any[]

          Method arguments. This array will be spread as multiple arguments.

          +
          • Optionalargs?: any[]

            Method arguments. This array will be spread as multiple arguments.

          • method: string

            Method name to invoke.

            -
          • Optional plugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

            +
          • Optionalplugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

      Returns any

      A single result or array of results.

    invokeSyncEvent

    • invokeSyncEvent(opts): object

    • This dispatch method synchronously passes to and returns from any invoked targets a PluginEvent.

      Parameters

      • opts: {
            copyProps?: object;
            method: string;
            passthruProps?: object;
            plugins?: string | Iterable<string>;
        }

        Options object.

        -
        • Optional copyProps?: object

          Properties that are copied.

          +
          • OptionalcopyProps?: object

            Properties that are copied.

          • method: string

            Method name to invoke.

            -
          • Optional passthruProps?: object

            Properties that are passed through.

            -
          • Optional plugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

            +
          • OptionalpassthruProps?: object

            Properties that are passed through.

            +
          • Optionalplugins?: string | Iterable<string>

            Specific plugin name or iterable list of plugin names to invoke.

      Returns object

      The PluginEvent data.

    setEventbus

    • setEventbus(opts): void

    • Sets the eventbus associated with this plugin manager. If any previous eventbus was associated all plugin manager events will be removed then added to the new eventbus. If there are any existing plugins being managed their @@ -98,4 +100,4 @@

    • oldPrepend: string

      The old event prepend.

    Returns void

    setOptions

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisDestroyedoptionspluginManagerdestroygetMethodNameshasMethodinvokeinvokeAsyncinvokeAsyncEventinvokeSyncinvokeSyncEventsetEventbussetOptions
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_plugin_manager.PluginManager.html b/docs/classes/_runtime_plugin_manager.PluginManager.html index 16d1ce20..a4e0474b 100644 --- a/docs/classes/_runtime_plugin_manager.PluginManager.html +++ b/docs/classes/_runtime_plugin_manager.PluginManager.html @@ -1,4 +1,5 @@ -PluginManager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class PluginManager

    Provides a lightweight plugin manager for Node / NPM & the browser with eventbus integration for plugins in a safe +PluginManager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class PluginManager

    Provides a lightweight plugin manager for Node / NPM & the browser with eventbus integration for plugins in a safe and protected manner across NPM modules, local files, and preloaded object instances. This pattern facilitates message passing between modules versus direct dependencies / method invocation.

    A default eventbus will be created, but you may also pass in an eventbus from @typhonjs-plugin/eventbus and the @@ -32,8 +33,9 @@ createEventbusProxy method will return a proxy to the default or currently set eventbus.

    It should be noted that this module re-exports @typhonjs-plugin/eventbus which is available as named exports via the eventbus subpath export:

    -
    // Main Eventbus implementations:
    import { Eventbus, EventbusProxy, EventbusSecure } from '#runtime/plugin/manager/eventbus';

    // Consistent bus instances useful for testing and broad accessibility:
    import { mainEventbus, pluginEventbus, testEventbus } from '#runtime/plugin/manager/eventbus/buses';
-
    +
    // Main Eventbus implementations:
    import { Eventbus, EventbusProxy, EventbusSecure } from '#runtime/plugin/manager/eventbus';

    // Consistent bus instances useful for testing and broad accessibility:
    import { mainEventbus, pluginEventbus, testEventbus } from '#runtime/plugin/manager/eventbus/buses';
+
    +

    This reexport is for convenience as it provides one single distribution for Node & browser usage.

    If external eventbus functionality is enabled by passing in an eventbus in the constructor of PluginManager it is important especially if using an existing process / global level eventbus instance from either this module or @@ -41,15 +43,16 @@ plugin manager event bindings; this is primarily a testing concern when running repeated tests over a reused eventbus.

    For more information on Eventbus functionality please see:

    -

    See

    https://www.npmjs.com/package/@typhonjs-plugin/eventbus

    +

    See

    https://www.npmjs.com/package/@typhonjs-plugin/eventbus

    The PluginManager instance can be extended through runtime composition by passing in classes that implement PluginSupportImpl. One such implementation is available PluginInvokeSupport which enables directly invoking methods of all or specific plugins. Please see the documentation for PluginInvokeSupport for more details.

    Several abbreviated examples follow. Please see the wiki for more details: TODO: add wiki link

    -

    Example

    import { PluginManager } from '@typhonjs-plugin/manager';

    const pluginManager = new PluginManager();

    await pluginManager.add({ name: 'an-npm-plugin-enabled-module' });
    await pluginManager.add({ name: 'my-local-module', target: './myModule.js' });

    const eventbus = pluginManager.createEventbusProxy();

    // Let's say an-npm-plugin-enabled-module responds to 'cool:event' which returns 'true'.
    // Let's say my-local-module responds to 'hot:event' which returns 'false'.
    // Both of the plugin / modules will have 'onPluginLoaded' invoked with a proxy to the eventbus and any plugin
    // options defined.

    // One can then use the eventbus functionality to invoke associated module / plugin methods even retrieving results.
    assert(eventbus.triggerSync('cool:event') === true);
    assert(eventbus.triggerSync('hot:event') === false);
-
    -

    Constructors

    constructor +

    Example

    import { PluginManager } from '@typhonjs-plugin/manager';

    const pluginManager = new PluginManager();

    await pluginManager.add({ name: 'an-npm-plugin-enabled-module' });
    await pluginManager.add({ name: 'my-local-module', target: './myModule.js' });

    const eventbus = pluginManager.createEventbusProxy();

    // Let's say an-npm-plugin-enabled-module responds to 'cool:event' which returns 'true'.
    // Let's say my-local-module responds to 'hot:event' which returns 'false'.
    // Both of the plugin / modules will have 'onPluginLoaded' invoked with a proxy to the eventbus and any plugin
    // options defined.

    // One can then use the eventbus functionality to invoke associated module / plugin methods even retrieving results.
    assert(eventbus.triggerSync('cool:event') === true);
    assert(eventbus.triggerSync('hot:event') === false);
+
    + +

    Constructors

    constructor

    Accessors

    isDestroyed

    Methods

    add addAll @@ -74,42 +77,42 @@

    Example

    import<
 setEnabled
 setEventbus
 setOptions
-

    Constructors

    constructor

    Constructors

    constructor

    Accessors

    isDestroyed

    • get isDestroyed(): boolean

    • Returns whether this plugin manager has been destroyed.

      +

    Returns PluginManager

    Accessors

    isDestroyed

    • get isDestroyed(): boolean

    • Returns whether this plugin manager has been destroyed.

      Returns boolean

      Returns whether this plugin manager has been destroyed.

      -

    Methods

    add

    • add(pluginConfig, moduleData?): Promise<PluginData>

    • Adds a plugin by the given configuration parameters. A plugin name is always required. If no other options +

    Methods

    add

    • add(pluginConfig, moduleData?): Promise<PluginData>

    • Adds a plugin by the given configuration parameters. A plugin name is always required. If no other options are provided then the name doubles as the NPM module / local file to load. The loading first checks for an existing instance to use as the plugin. Then the target is chosen as the NPM module / local file to load. By passing in options this will be stored and accessible to the plugin during all callbacks.

      Parameters

      • pluginConfig: PluginConfig

        Defines the plugin to load.

        -
      • Optional moduleData: object

        Optional object hash to associate with plugin.

        +
      • OptionalmoduleData: object

        Optional object hash to associate with plugin.

      Returns Promise<PluginData>

      The PluginData that represents the plugin added.

    addAll

    • addAll(pluginConfigs, moduleData?): Promise<PluginData[]>

    • Initializes multiple plugins in a single call.

      Parameters

      • pluginConfigs: Iterable<PluginConfig>

        An iterable list of plugin config object hash entries.

        -
      • Optional moduleData: object

        Optional object hash to associate with all plugins.

        +
      • OptionalmoduleData: object

        Optional object hash to associate with all plugins.

      Returns Promise<PluginData[]>

      An array of PluginData objects of all added plugins.

    createEventbusProxy

    • createEventbusProxy(): EventbusProxy

    • If an eventbus is assigned to this plugin manager then a new EventbusProxy wrapping this eventbus is returned. It is added to this.#eventbusProxies so †hat the instances are destroyed when the plugin manager is destroyed.

      Returns EventbusProxy

      A proxy for the currently set Eventbus.

    createEventbusSecure

    • createEventbusSecure(name?): EventbusSecure

    • If an eventbus is assigned to this plugin manager then a new EventbusSecure wrapping this eventbus is returned. It is added to this.#eventbusSecure so †hat the instances are destroyed when the plugin manager is destroyed.

      -

      Parameters

      • Optional name: string

        Optional name for the EventbusSecure instance.

        +

        Parameters

        • Optionalname: string

          Optional name for the EventbusSecure instance.

        Returns EventbusSecure

        A secure wrapper for the currently set Eventbus.

    destroy

    getEnabled

    • getEnabled(opts?): boolean | DataOutPluginEnabled[]

    • Returns the enabled state of a plugin, a list of plugins, or all plugins.

      -

      Parameters

      • Optional opts: {
            plugins?: string | Iterable<string>;
        }

        Options object. If undefined all plugin enabled state is returned.

        -
        • Optional plugins?: string | Iterable<string>

          Plugin name or iterable list of names to get state.

          +

          Parameters

          • Optionalopts: {
                plugins?: string | Iterable<string>;
            }

            Options object. If undefined all plugin enabled state is returned.

            +
            • Optionalplugins?: string | Iterable<string>

              Plugin name or iterable list of names to get state.

          Returns boolean | DataOutPluginEnabled[]

          Enabled state for single plugin or array of results for multiple - plugins.

          +plugins.

    getEventbus

    • getEventbus(): Eventbus

    • Returns any associated eventbus.

      Returns Eventbus

      The associated eventbus.

    getOptions

    • getOptions(): PluginManagerOptions

    • Returns a copy of the plugin manager options.

      @@ -119,16 +122,16 @@

      Example

      import<
      • event: string | RegExp

        Event name or RegExp to match event names.

    Returns string[] | DataOutPluginEvents[]

    Event binding names registered from the plugin.

    getPluginData

    • getPluginData(opts?): PluginData | PluginData[]

    • Gets the plugin data for a plugin, list of plugins, or all plugins.

      -

      Parameters

      • Optional opts: {
            plugins?: string | Iterable<string>;
        }

        Options object. If undefined all plugin data is returned.

        -
        • Optional plugins?: string | Iterable<string>

          Plugin name or iterable list of names to get plugin data.

          +

          Parameters

          • Optionalopts: {
                plugins?: string | Iterable<string>;
            }

            Options object. If undefined all plugin data is returned.

            +
            • Optionalplugins?: string | Iterable<string>

              Plugin name or iterable list of names to get plugin data.

          Returns PluginData | PluginData[]

          The plugin data for a plugin or list of plugins.

    getPluginEntry

    • getPluginEntry(plugin): PluginEntry

    • Gets a PluginEntry instance for the given plugin name. This method is primarily for PluginSupportImpl classes.

      Parameters

      • plugin: string

        The plugin name to get.

      Returns PluginEntry

      The PluginEntry for the given plugin name.

    getPluginEvents

    • getPluginEvents(opts?): DataOutPluginEvents[]

    • Returns the event binding names registered on any associated plugin EventbusProxy.

      -

      Parameters

      • Optional opts: {
            plugins?: string | Iterable<string>;
        }

        Options object. If undefined all plugin data is returned.

        -
        • Optional plugins?: string | Iterable<string>

          Plugin name or iterable list of names to get plugin data.

          +

          Parameters

          • Optionalopts: {
                plugins?: string | Iterable<string>;
            }

            Options object. If undefined all plugin data is returned.

            +
            • Optionalplugins?: string | Iterable<string>

              Plugin name or iterable list of names to get plugin data.

          Returns DataOutPluginEvents[]

          Event binding names registered from the plugin.

    getPluginMapKeys

    • getPluginMapKeys(): Iterable<string>

    • Returns an iterable of plugin map keys (plugin names). This method is primarily for PluginSupportImpl classes.

      @@ -137,22 +140,22 @@

      Example

      import<
 classes.

      Returns Iterable<PluginEntry>

      An iterable of plugin map keys.

    getPluginNames

    • getPluginNames(opts?): string[]

    • Returns all plugin names or if enabled is set then return plugins matching the enabled state.

      -

      Parameters

      • Optional opts: {
            enabled?: boolean;
        }

        Options object. If undefined all plugin names are returned regardless of enabled state.

        -
        • Optional enabled?: boolean

          If enabled is a boolean it will return plugins given their enabled state.

          +

          Parameters

          • Optionalopts: {
                enabled?: boolean;
            }

            Options object. If undefined all plugin names are returned regardless of enabled state.

            +
            • Optionalenabled?: boolean

              If enabled is a boolean it will return plugins given their enabled state.

          Returns string[]

          A list of plugin names optionally by enabled state.

    hasPlugins

    • hasPlugins(opts?): boolean

    • Returns true if there is a plugin loaded with the given plugin name(s). If no options are provided then the result will be if any plugins are loaded.

      -

      Parameters

      • Optional opts: {
            plugins?: string | Iterable<string>;
        }

        Options object. If undefined returns whether there are any plugins.

        -
        • Optional plugins?: string | Iterable<string>

          Plugin name or iterable list of names to check existence.

          +

          Parameters

          • Optionalopts: {
                plugins?: string | Iterable<string>;
            }

            Options object. If undefined returns whether there are any plugins.

            +
            • Optionalplugins?: string | Iterable<string>

              Plugin name or iterable list of names to check existence.

          Returns boolean

          True if given plugin(s) exist.

    isValidConfig

    • isValidConfig(pluginConfig): boolean

    • Performs validation of a PluginConfig.

      Parameters

      Returns boolean

      True if the given PluginConfig is valid.

    reload

    • reload(opts): Promise<boolean>

    • Unloads / reloads the plugin invoking onPluginUnload / then onPluginReload

      Parameters

      • opts: {
            instance?: object;
            plugin: string;
            silent?: boolean;
        }

        Options object.

        -
        • Optional instance?: object

          Optional instance to replace.

          +
          • Optionalinstance?: object

            Optional instance to replace.

          • plugin: string

            Plugin name to reload.

            -
          • Optional silent?: boolean

            Does not trigger any reload notification on the eventbus.

            +
          • Optionalsilent?: boolean

            Does not trigger any reload notification on the eventbus.

      Returns Promise<boolean>

      Result of reload attempt.

    remove

    • remove(opts): Promise<DataOutPluginRemoved[]>

    • Removes a plugin by name or all names in an iterable list unloading them and clearing any event bindings automatically.

      @@ -164,14 +167,14 @@

      Example

      import<

    setEnabled

    • setEnabled(opts): void

    • Sets the enabled state of a plugin, a list of plugins, or all plugins.

      Parameters

      • opts: {
            enabled: boolean;
            plugins?: string | Iterable<string>;
        }

        Options object.

        • enabled: boolean

          The enabled state.

          -
        • Optional plugins?: string | Iterable<string>

          Plugin name or iterable list of names to set state.

          +
        • Optionalplugins?: string | Iterable<string>

          Plugin name or iterable list of names to set state.

      Returns void

    setEventbus

    • setEventbus(opts): Promise<void>

    • Sets the eventbus associated with this plugin manager. If any previous eventbus was associated all plugin manager events will be removed then added to the new eventbus. If there are any existing plugins being managed their events will be removed from the old eventbus and then onPluginLoad will be called with the new eventbus.

      -

      Parameters

      • opts: {
            eventPrepend?: string;
            eventbus: Eventbus;
        }

        An options object.

        -
        • Optional eventPrepend?: string

          An optional string to prepend to all of the event - binding targets.

          -
        • eventbus: Eventbus

          The new eventbus to associate.

          +

          Parameters

          • opts: {
                eventbus: Eventbus;
                eventPrepend?: string;
            }

            An options object.

            +
            • eventbus: Eventbus

              The new eventbus to associate.

              +
            • OptionaleventPrepend?: string

              An optional string to prepend to all of the event +binding targets.

          Returns Promise<void>

    setOptions

    • setOptions(options): void

    • Set optional parameters.

      Parameters

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    constructorisDestroyedaddaddAllcreateEventbusProxycreateEventbusSecuredestroygetEnabledgetEventbusgetOptionsgetPluginByEventgetPluginDatagetPluginEntrygetPluginEventsgetPluginMapKeysgetPluginMapValuesgetPluginNameshasPluginsisValidConfigreloadremoveremoveAllsetEnabledsetEventbussetOptions
    \ No newline at end of file +

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_plugin_manager_eventbus.Eventbus.html b/docs/classes/_runtime_plugin_manager_eventbus.Eventbus.html index 1ef25463..ee88f8d0 100644 --- a/docs/classes/_runtime_plugin_manager_eventbus.Eventbus.html +++ b/docs/classes/_runtime_plugin_manager_eventbus.Eventbus.html @@ -1,6 +1,7 @@ -Eventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    Class Eventbus

    Provides the ability to bind and trigger custom named events. Bound callback functions may be triggered +Eventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

    +

    Class Eventbus

    Provides the ability to bind and trigger custom named events. Bound callback functions may be triggered asynchronously or synchronously returning results.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Accessors

    callbackCount eventCount name @@ -22,30 +23,30 @@ triggerAsync triggerDefer triggerSync -

    Properties

    _listenId -_listeners +

    Properties

    _listeners +_listenId _listeningTo -

    Constructors

    constructor

    • new Eventbus(name?): Eventbus

    • Provides a constructor which optionally takes the eventbus name.

      -

      Parameters

      • Optional name: string

        Optional eventbus name.

        -

      Returns Eventbus

    Accessors

    callbackCount

    • get callbackCount(): number

    • Returns the current callback count.

      +

    Constructors

    constructor

    • new Eventbus(name?): Eventbus

    • Provides a constructor which optionally takes the eventbus name.

      +

      Parameters

      • Optionalname: string

        Optional eventbus name.

        +

      Returns Eventbus

    Accessors

    callbackCount

    • get callbackCount(): number

    • Returns the current callback count.

      Returns number

      The current callback count.

    eventCount

    • get eventCount(): number

    • Returns the current event count.

      Returns number

      Returns the current event count.

    name

    • get name(): string

    • Returns the current eventbus name.

      Returns string

      The current eventbus name.

      -

    Methods

    before

    • before(count, name, callback, context?, options?): Eventbus

    • Just like on, but causes the bound callback to fire several times up to the count specified before being +

    Methods

    before

    • before(count, name, callback, context?, options?): Eventbus

    • Just like on, but causes the bound callback to fire several times up to the count specified before being removed. When multiple events are passed in using the space separated syntax, the event will fire count times for every event you passed in, not once for a combination of all events.

      Parameters

      • count: number

        Number of times the function will fire before being removed.

      • name: string | EventMap

        Event name(s) or event map.

      • callback: object | Function

        Event callback function or context for event map.

        -
      • Optional context: object

        Event context

        -
      • Optional options: EventOptions | EventOptionsOut

        Event registration options.

        +
      • Optionalcontext: object

        Event context

        +
      • Optionaloptions: EventOptions | EventOptionsOut

        Event registration options.

      Returns Eventbus

      This Eventbus instance.

    entries

    • entries(regex?): Generator<[string, Function, object, EventOptionsOut], void, unknown>

    • Returns an iterable for all stored events yielding an array with event name, callback function, and event context.

      -

      Parameters

      • Optional regex: RegExp

        Optional regular expression to filter event names.

        +

        Parameters

        • Optionalregex: RegExp

          Optional regular expression to filter event names.

        Returns Generator<[string, Function, object, EventOptionsOut], void, unknown>

        Generator

        -

        Yields

    getOptions

    • getOptions(name): EventOptionsOut

    • Returns the options of an event name.

      +

      Yields

    getOptions

    • getOptions(name): EventOptionsOut

    • Returns the options of an event name.

      Parameters

      • name: string

        Event name(s) to verify.

      Returns EventOptionsOut

      The event options.

    getType

    • getType(name): string

    • Returns the trigger type of event name. @@ -54,22 +55,23 @@

    Returns string

    The trigger type.

    isGuarded

    • isGuarded(name, data?): boolean

    • Returns whether an event name is guarded.

      Parameters

      • name: string | EventMap

        Event name(s) or event map to verify.

        -
      • Optional data: object

        Stores the output of which names are guarded.

        +
      • Optionaldata: object

        Stores the output of which names are guarded.

      Returns boolean

      Whether the given event name is guarded.

    keys

    • keys(regex?): Generator<string, void, unknown>

    • Returns an iterable for the event names / keys of registered event listeners.

      -

      Parameters

      • Optional regex: RegExp

        Optional regular expression to filter event names.

        -

      Returns Generator<string, void, unknown>

      Yields

    keysWithOptions

    • keysWithOptions(regex?): Generator<[string, EventOptionsOut], void, unknown>

    • Returns an iterable for the event names / keys of registered event listeners along with event options.

      -

      Parameters

      • Optional regex: RegExp

        Optional regular expression to filter event names.

        +

        Parameters

        • Optionalregex: RegExp

          Optional regular expression to filter event names.

          +

        Returns Generator<string, void, unknown>

        Yields

    keysWithOptions

    • keysWithOptions(regex?): Generator<[string, EventOptionsOut], void, unknown>

    • Returns an iterable for the event names / keys of registered event listeners along with event options.

      +

      Parameters

      • Optionalregex: RegExp

        Optional regular expression to filter event names.

      Returns Generator<[string, EventOptionsOut], void, unknown>

      Generator

      -

      Yields

    listenTo

    • listenTo(obj, name, callback): Eventbus

    • Tell an object to listen to a particular event on another object. The advantage of using this form, instead of +

      Yields

    listenTo

    • listenTo(obj, name, callback): Eventbus

    • Tell an object to listen to a particular event on another object. The advantage of using this form, instead of other.on(event, callback, object), is that listenTo allows the object to keep track of the events, and they can be removed all at once later on. The callback will always be called with object as context.

      Parameters

      • obj: object

        Event context

      • name: string | EventMap

        Event name(s) or event map.

      • callback: object | Function

        Event callback function or context for event map.

      Returns Eventbus

      This Eventbus instance.

      -

      Example

      view.listenTo(model, 'change', view.render);
-
      +

      Example

      view.listenTo(model, 'change', view.render);
+
      +

    listenToBefore

    • listenToBefore(count, obj, name, callback): Eventbus

    • Just like listenTo, but causes the bound callback to fire count times before being removed.

      Parameters

      • count: number

        Number of times the function will fire before being removed.

      • obj: object

        Target event context.

        @@ -85,12 +87,13 @@ the callback with different contexts will be removed. If no callback is specified, all callbacks for the event will be removed. If no event is specified, callbacks for all events will be removed.

        Note that calling model.off(), for example, will indeed remove all events on the model.

        -

        Parameters

        • Optional name: string | EventMap

          Event name(s) or event map.

          -
        • Optional callback: Function

          Event callback function

          -
        • Optional context: object

          Event context

          +

          Parameters

          • Optionalname: string | EventMap

            Event name(s) or event map.

            +
          • Optionalcallback: Function

            Event callback function

            +
          • Optionalcontext: object

            Event context

          Returns Eventbus

          This Eventbus instance.

          -

          Example

          // Removes just the `onChange` callback.
          object.off('change', onChange);

          // Removes all 'change' callbacks.
          object.off('change');

          // Removes the `onChange` callback for all events.
          object.off(null, onChange);

          // Removes all callbacks for `context` for all events.
          object.off(null, null, context);

          // Removes all callbacks on `object`.
          object.off();
-
          +

          Example

          // Removes just the `onChange` callback.
          object.off('change', onChange);

          // Removes all 'change' callbacks.
          object.off('change');

          // Removes the `onChange` callback for all events.
          object.off(null, onChange);

          // Removes all callbacks for `context` for all events.
          object.off(null, null, context);

          // Removes all callbacks on `object`.
          object.off();
+
          +

    on

    • on(name, callback, context?, options?): Eventbus

    • Bind a callback function to an object. The callback will be invoked whenever the event is fired. If you have a large number of different events on a page, the convention is to use colons to namespace them: 'poll:start', or 'change:selection'.

      @@ -98,50 +101,54 @@ model.on('change', this.render, this) or model.on({change: this.render}, this).

      Parameters

      • name: string | EventMap

        Event name(s) or event map.

      • callback: object | Function

        Event callback function or context for event map.

        -
      • Optional context: object

        Event context

        -
      • Optional options: EventOptions | EventOptionsOut

        Event registration options.

        +
      • Optionalcontext: object

        Event context

        +
      • Optionaloptions: EventOptions | EventOptionsOut

        Event registration options.

      Returns Eventbus

      This Eventbus instance.

      -

      Example

      // The event string may also be a space-delimited list of several events...
      book.on('change:title change:author', ...);
-
      -

      Example

      Callbacks bound to the special 'all' event will be triggered when any event occurs, and are passed the name of
      the event as the first argument. For example, to proxy all events from one object to another:
      proxy.on('all', (eventName) => {
         object.trigger(eventName);
      });
-
      -

      Example

      All event methods also support an event map syntax, as an alternative to positional arguments:
      book.on({
         'change:author': authorPane.update,
         'change:title change:subtitle': titleView.update,
         'destroy': bookView.remove
      });
-
      +

      Example

      // The event string may also be a space-delimited list of several events...
      book.on('change:title change:author', ...);
+
      + +

      Example

      Callbacks bound to the special 'all' event will be triggered when any event occurs, and are passed the name of
      the event as the first argument. For example, to proxy all events from one object to another:
      proxy.on('all', (eventName) => {
         object.trigger(eventName);
      });
+
      + +

      Example

      All event methods also support an event map syntax, as an alternative to positional arguments:
      book.on({
         'change:author': authorPane.update,
         'change:title change:subtitle': titleView.update,
         'destroy': bookView.remove
      });
+
      +

    once

    • once(name, callback, context?, options?): Eventbus

    • Just like on, but causes the bound callback to fire only once before being removed. Handy for saying "the next time that X happens, do this". When multiple events are passed in using the space separated syntax, the event will fire once for every event you passed in, not once for a combination of all events

      Parameters

      • name: string | EventMap

        Event name(s) or event map.

      • callback: object | Function

        Event callback function or context for event map.

        -
      • Optional context: object

        Event context.

        -
      • Optional options: EventOptions | EventOptionsOut

        Event registration options.

        +
      • Optionalcontext: object

        Event context.

        +
      • Optionaloptions: EventOptions | EventOptionsOut

        Event registration options.

      Returns Eventbus

      This Eventbus instance.

    stopListening

    • stopListening(obj, name?, callback?): Eventbus

    • Tell an object to stop listening to events. Either call stopListening with no arguments to have the object remove all of its registered callbacks ... or be more precise by telling it to remove just the events it's listening to on a specific object, or a specific event, or just a specific callback.

      Parameters

      • obj: object

        Event context

        -
      • Optional name: string

        Event name(s)

        -
      • Optional callback: Function

        Event callback function

        +
      • Optionalname: string

        Event name(s)

        +
      • Optionalcallback: Function

        Event callback function

      Returns Eventbus

      This Eventbus instance.

      -

      Example

      view.stopListening();

      view.stopListening(model);
-
      +

      Example

      view.stopListening();

      view.stopListening(model);
+
      +

    trigger

    • trigger(name, ...args): Eventbus

    • Trigger callbacks for the given event, or space-delimited list of events. Subsequent arguments to trigger will be passed along to the event callbacks.

      Parameters

      • name: string

        Event name(s)

        -
      • Rest ...args: any[]

        Additional arguments passed to the event function(s).

        +
      • Rest...args: any[]

        Additional arguments passed to the event function(s).

      Returns Eventbus

      This Eventbus instance.

    triggerAsync

    • triggerAsync(name, ...args): Promise<any>

    • Provides trigger functionality, but collects any returned Promises from invoked targets and returns a single Promise generated by Promise.resolve for a single value or Promise.all for multiple results. This is a very useful mechanism to invoke asynchronous operations over an eventbus.

      Parameters

      • name: string

        Event name(s)

        -
      • Rest ...args: any[]

        Additional arguments passed to the event function(s).

        +
      • Rest...args: any[]

        Additional arguments passed to the event function(s).

      Returns Promise<any>

      A Promise with any results.

    triggerDefer

    • triggerDefer(name, ...args): Eventbus

    • Defers invoking trigger. This is useful for triggering events in the next clock tick.

      Parameters

      • name: string

        Event name(s)

        -
      • Rest ...args: any[]

        Additional arguments passed to the event function(s).

        +
      • Rest...args: any[]

        Additional arguments passed to the event function(s).

      Returns Eventbus

      This Eventbus instance.

    triggerSync

    • triggerSync(name, ...args): any

    • Provides trigger functionality, but collects any returned result or results from invoked targets as a single value or in an array and passes it back to the callee in a synchronous manner.

      Parameters

      • name: string

        Event name(s).

        -
      • Rest ...args: any[]

        Additional arguments passed to the event function(s).

        +
      • Rest...args: any[]

        Additional arguments passed to the event function(s).

      Returns any

      The results of the event invocation.

      -

    Properties

    _listenId

    _listenId: string

    _listeners

    _listeners: {}

    Type declaration

      _listeningTo

      _listeningTo: {}

      Type declaration

        Settings

        Member Visibility

        Theme

        On This Page

        constructorcallbackCounteventCountnamebeforeentriesgetOptionsgetTypeisGuardedkeyskeysWithOptionslistenTolistenToBeforelistenToOnceoffononcestopListeningtriggertriggerAsynctriggerDefertriggerSync_listenId_listeners_listeningTo
        \ No newline at end of file +

        Properties

        _listeners

        _listeners: {}

        _listenId

        _listenId: string

        _listeningTo

        _listeningTo: {}

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        Properties
        \ No newline at end of file diff --git a/docs/classes/_runtime_plugin_manager_eventbus.EventbusProxy.html b/docs/classes/_runtime_plugin_manager_eventbus.EventbusProxy.html index a7c446a3..27f1f7ff 100644 --- a/docs/classes/_runtime_plugin_manager_eventbus.EventbusProxy.html +++ b/docs/classes/_runtime_plugin_manager_eventbus.EventbusProxy.html @@ -1,4 +1,5 @@ -EventbusProxy | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class EventbusProxy

        EventbusProxy provides a protected proxy of another Eventbus instance.

        +EventbusProxy | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class EventbusProxy

        EventbusProxy provides a protected proxy of another Eventbus instance.

        The main use case of EventbusProxy is to allow indirect access to an eventbus. This is handy when it comes to managing the event lifecycle for a plugin system. When a plugin is added it could receive a callback, perhaps named onPluginLoaded, which contains an EventbusProxy instance rather than the direct eventbus. This EventbusProxy @@ -12,7 +13,7 @@ eventbus. Any further usage of a destroyed EventbusProxy instance results in a ReferenceError thrown.

        Finally, the EventbusProxy only allows events registered through it to be turned off providing a buffer between any consumers such that they can not turn off other registrations made on the eventbus or other proxy instances.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        callbackCount eventCount isDestroyed @@ -38,9 +39,9 @@ triggerAsync triggerDefer triggerSync -

        Constructors

        constructor

        • new EventbusProxy(eventbus): EventbusProxy

        • Creates the event proxy with an existing instance of Eventbus.

          +

        Constructors

        constructor

        • new EventbusProxy(eventbus): EventbusProxy

        • Creates the event proxy with an existing instance of Eventbus.

          Parameters

          • eventbus: Eventbus

            The target eventbus instance.

            -

          Returns EventbusProxy

        Accessors

        callbackCount

        • get callbackCount(): number

        • Returns the current proxied eventbus callback count.

          +

        Returns EventbusProxy

        Accessors

        callbackCount

        • get callbackCount(): number

        • Returns the current proxied eventbus callback count.

          Returns number

          Returns the current proxied callback count.

        eventCount

        • get eventCount(): number

        • Returns the current proxied eventbus event count.

          Returns number

          Returns the current proxied event count.

          @@ -52,14 +53,14 @@

        Returns number

        Returns the current proxied callback count.

        proxyEventCount

        • get proxyEventCount(): number

        • Returns the current proxied event count.

          Returns number

          Returns the current proxied event count.

          -

        Methods

        before

        • before(count, name, callback, context?, options?): EventbusProxy

        • Just like on, but causes the bound callback to fire several times up to the count specified before being +

        Methods

        before

        • before(count, name, callback, context?, options?): EventbusProxy

        • Just like on, but causes the bound callback to fire several times up to the count specified before being removed. When multiple events are passed in using the space separated syntax, the event will fire count times for every event you passed in, not once for a combination of all events.

          Parameters

          • count: number

            Number of times the function will fire before being removed.

          • name: string | EventMap

            Event name(s) or event map.

          • callback: object | Function

            Event callback function or context for event map.

            -
          • Optional context: object

            Event context

            -
          • Optional options: EventOptions | EventOptionsOut

            Event registration options.

            +
          • Optionalcontext: object

            Event context

            +
          • Optionaloptions: EventOptions | EventOptionsOut

            Event registration options.

          Returns EventbusProxy

          This EventbusProxy instance.

        createProxy

        • createProxy(): EventbusProxy

        • Creates an EventbusProxy wrapping the backing Eventbus instance. An EventbusProxy proxies events allowing all listeners added to be easily removed from the wrapped Eventbus.

          @@ -68,9 +69,9 @@ after destroy has been called result in a ReferenceError thrown.

          Returns void

        entries

        • entries(regex?): Generator<[string, Function, object, EventOptionsOut], void, unknown>

        • Returns an iterable for all events from the proxied eventbus yielding an array with event name, callback function, and event context.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter event names.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter event names.

            Returns Generator<[string, Function, object, EventOptionsOut], void, unknown>

            Generator

            -

            Yields

        getOptions

        • getOptions(name): EventOptionsOut

        • Returns the options of an event name.

          +

          Yields

        getOptions

        • getOptions(name): EventOptionsOut

        • Returns the options of an event name.

          Parameters

          • name: string

            Event name(s) to verify.

          Returns EventOptionsOut

          The event options.

        getType

        • getType(name): string

        • Returns the trigger type of event name. @@ -79,18 +80,18 @@

        Returns string

        The trigger type.

        isGuarded

        • isGuarded(name, data?): boolean

        • Returns whether an event name is guarded.

          Parameters

          • name: string | EventMap

            Event name(s) or event map to verify.

            -
          • Optional data: object

            Stores the output of which names are guarded.

            +
          • Optionaldata: object

            Stores the output of which names are guarded.

          Returns boolean

          Whether the given event name is guarded.

        keys

        • keys(regex?): Generator<string, void, unknown>

        • Returns an iterable for the event names / keys of proxied eventbus event listeners.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter event names.

            -

          Returns Generator<string, void, unknown>

          Yields

        keysWithOptions

        • keysWithOptions(regex?): Generator<[string, EventOptionsOut], void, unknown>

        • Returns an iterable for the event names / keys of registered event listeners along with event options.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter event names.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter event names.

              +

            Returns Generator<string, void, unknown>

            Yields

        keysWithOptions

        • keysWithOptions(regex?): Generator<[string, EventOptionsOut], void, unknown>

        • Returns an iterable for the event names / keys of registered event listeners along with event options.

          +

          Parameters

          • Optionalregex: RegExp

            Optional regular expression to filter event names.

          Returns Generator<[string, EventOptionsOut], void, unknown>

          Generator

          -

          Yields

        off

        • off(name?, callback?, context?): EventbusProxy

        • Remove a previously-bound proxied event binding.

          +

          Yields

        off

        • off(name?, callback?, context?): EventbusProxy

        • Remove a previously-bound proxied event binding.

          Please see Eventbus#off.

          -

          Parameters

          • Optional name: string | EventMap

            Event name(s) or event map.

            -
          • Optional callback: Function

            Event callback function

            -
          • Optional context: object

            Event context

            +

            Parameters

            • Optionalname: string | EventMap

              Event name(s) or event map.

              +
            • Optionalcallback: Function

              Event callback function

              +
            • Optionalcontext: object

              Event context

            Returns EventbusProxy

            This EventbusProxy

        on

        • on(name, callback, context?, options?): EventbusProxy

        • Bind a callback function to an object. The callback will be invoked whenever the event is fired. If you have a large number of different events on a page, the convention is to use colons to namespace them: poll:start, or @@ -98,46 +99,46 @@

          Please see Eventbus#on.

          Parameters

          • name: string | EventMap

            Event name(s) or event map.

          • callback: object | Function

            Event callback function or context for event map.

            -
          • Optional context: object

            Event context.

            -
          • Optional options: EventOptions | EventOptionsOut

            Event registration options.

            +
          • Optionalcontext: object

            Event context.

            +
          • Optionaloptions: EventOptions | EventOptionsOut

            Event registration options.

          Returns EventbusProxy

          This EventbusProxy

        once

        • once(name, callback, context?, options?): EventbusProxy

        • Just like on, but causes the bound callback to fire only once before being removed. Handy for saying "the next time that X happens, do this". When multiple events are passed in using the space separated syntax, the event will fire once for every event you passed in, not once for a combination of all events

          Parameters

          • name: string | EventMap

            Event name(s) or event map.

          • callback: object | Function

            Event callback function or context for event map.

            -
          • Optional context: object

            Event context

            -
          • Optional options: EventOptions | EventOptionsOut

            Event registration options.

            +
          • Optionalcontext: object

            Event context

            +
          • Optionaloptions: EventOptions | EventOptionsOut

            Event registration options.

          Returns EventbusProxy

          This EventbusProxy instance.

        proxyEntries

        • proxyEntries(regex?): Generator<[string, Function, object, EventOptionsOut], void, unknown>

        • Returns an iterable for all stored locally proxied events yielding an array with event name, callback function, and event context.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter event names.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter event names.

            Returns Generator<[string, Function, object, EventOptionsOut], void, unknown>

            Generator

            -

            Yields

        proxyKeys

        • proxyKeys(regex?): Generator<string, void, unknown>

        • Returns an iterable for the event names / keys of the locally proxied event names.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter event names.

            -

          Returns Generator<string, void, unknown>

          Yields

        proxyKeysWithOptions

        • proxyKeysWithOptions(regex?): Generator<[string, EventOptionsOut], void, unknown>

        • Returns an iterable for the event names / keys of the locally proxied event names with event options.

          +

          Yields

        proxyKeys

        • proxyKeys(regex?): Generator<string, void, unknown>

        • Returns an iterable for the event names / keys of the locally proxied event names.

          +

          Parameters

          • Optionalregex: RegExp

            Optional regular expression to filter event names.

            +

          Returns Generator<string, void, unknown>

          Yields

        proxyKeysWithOptions

        • proxyKeysWithOptions(regex?): Generator<[string, EventOptionsOut], void, unknown>

        • Returns an iterable for the event names / keys of the locally proxied event names with event options.

          Note: The event options returned will respect all the event options from a registered event on the main eventbus if applicable.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter event names.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter event names.

            Returns Generator<[string, EventOptionsOut], void, unknown>

            Generator

            -

            Yields

        trigger

        • trigger(name, ...args): EventbusProxy

        • Trigger callbacks for the given event, or space-delimited list of events. Subsequent arguments to trigger will be +

          Yields

        trigger

        • trigger(name, ...args): EventbusProxy

        • Trigger callbacks for the given event, or space-delimited list of events. Subsequent arguments to trigger will be passed along to the event callbacks.

          Parameters

          • name: string

            Event name(s)

            -
          • Rest ...args: any[]

            Additional arguments passed to the event function(s).

            +
          • Rest...args: any[]

            Additional arguments passed to the event function(s).

          Returns EventbusProxy

          This EventbusProxy.

        triggerAsync

        • triggerAsync(name, ...args): Promise<any>

        • Provides trigger functionality, but collects any returned Promises from invoked targets and returns a single Promise generated by Promise.resolve for a single value or Promise.all for multiple results. This is a very useful mechanism to invoke asynchronous operations over an eventbus.

          Parameters

          • name: string

            Event name(s)

            -
          • Rest ...args: any[]

            Additional arguments passed to the event function(s).

            +
          • Rest...args: any[]

            Additional arguments passed to the event function(s).

          Returns Promise<any>

          A Promise returning any results.

        triggerDefer

        • triggerDefer(name, ...args): EventbusProxy

        • Defers invoking trigger. This is useful for triggering events in the next clock tick.

          Parameters

          • name: string

            Event name(s)

            -
          • Rest ...args: any[]

            Additional arguments passed to the event function(s).

            +
          • Rest...args: any[]

            Additional arguments passed to the event function(s).

          Returns EventbusProxy

          This EventbusProxy.

        triggerSync

        • triggerSync(name, ...args): any

        • Provides trigger functionality, but collects any returned result or results from invoked targets as a single value or in an array and passes it back to the callee in a synchronous manner.

          Parameters

          • name: string

            Event name(s)

            -
          • Rest ...args: any[]

            Additional arguments passed to the event function(s).

            +
          • Rest...args: any[]

            Additional arguments passed to the event function(s).

          Returns any

          An Array of returned results.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorcallbackCounteventCountisDestroyednameproxyCallbackCountproxyEventCountbeforecreateProxydestroyentriesgetOptionsgetTypeisGuardedkeyskeysWithOptionsoffononceproxyEntriesproxyKeysproxyKeysWithOptionstriggertriggerAsynctriggerDefertriggerSync
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_plugin_manager_eventbus.EventbusSecure.html b/docs/classes/_runtime_plugin_manager_eventbus.EventbusSecure.html index c368effb..421030a8 100644 --- a/docs/classes/_runtime_plugin_manager_eventbus.EventbusSecure.html +++ b/docs/classes/_runtime_plugin_manager_eventbus.EventbusSecure.html @@ -1,4 +1,5 @@ -EventbusSecure | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class EventbusSecure

        EventbusSecure provides a secure wrapper around another Eventbus instance.

        +EventbusSecure | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class EventbusSecure

        EventbusSecure provides a secure wrapper around another Eventbus instance.

        The main use case of EventbusSecure is to provide a secure eventbus window for public consumption. Only events can be triggered, but not registered / unregistered.

        You must use the initialize method passing in an existing Eventbus instance as the eventbus reference is private. @@ -6,7 +7,7 @@ the EventbusSecure instance. The initialize method returns an EventbusSecureObj object which contains two functions to control the secure eventbus externally; destroy and setEventbus. Expose to end consumers just the eventbusSecure instance.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        isDestroyed name

        Methods

        getOptions @@ -18,11 +19,11 @@ triggerDefer triggerSync initialize -

        Constructors

        constructor

        Accessors

        isDestroyed

        • get isDestroyed(): boolean

        • Returns whether this instance has already been destroyed.

          +

        Constructors

        constructor

        Accessors

        isDestroyed

        • get isDestroyed(): boolean

        • Returns whether this instance has already been destroyed.

          Returns boolean

          Is destroyed state.

        name

        • get name(): string

        • Returns the name associated with this instance.

          Returns string

          The target eventbus name.

          -

        Methods

        getOptions

        Methods

        getOptions

        • getOptions(name): EventOptionsOut

        • Returns the options of an event name.

          Parameters

          • name: string

            Event name(s) to verify.

          Returns EventOptionsOut

          The event options.

        getType

        • getType(name): string

        • Returns the trigger type of event name. @@ -30,36 +31,36 @@

          Parameters

          • name: string

            Event name(s) to verify.

          Returns string

          The trigger type.

        keys

        • keys(regex?): Generator<string, void, unknown>

        • Returns an iterable for the event names / keys of secured eventbus event listeners.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter event names.

            -

          Returns Generator<string, void, unknown>

          Yields

        keysWithOptions

        • keysWithOptions(regex?): Generator<[string, EventOptionsOut], void, unknown>

        • Returns an iterable for the event names / keys of registered event listeners along with event options.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter event names.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter event names.

              +

            Returns Generator<string, void, unknown>

            Yields

        keysWithOptions

        • keysWithOptions(regex?): Generator<[string, EventOptionsOut], void, unknown>

        • Returns an iterable for the event names / keys of registered event listeners along with event options.

          +

          Parameters

          • Optionalregex: RegExp

            Optional regular expression to filter event names.

          Returns Generator<[string, EventOptionsOut], void, unknown>

          Generator

          -

          Yields

        trigger

        • trigger(name, ...args): EventbusSecure

        • Trigger callbacks for the given event, or space-delimited list of events. Subsequent arguments to trigger will be +

          Yields

        trigger

        • trigger(name, ...args): EventbusSecure

        • Trigger callbacks for the given event, or space-delimited list of events. Subsequent arguments to trigger will be passed along to the event callbacks.

          Parameters

          • name: string

            Event name(s)

            -
          • Rest ...args: any[]

            Additional arguments passed to the event function(s).

            +
          • Rest...args: any[]

            Additional arguments passed to the event function(s).

          Returns EventbusSecure

          This instance.

        triggerAsync

        • triggerAsync(name, ...args): Promise<any>

        • Provides trigger functionality, but collects any returned Promises from invoked targets and returns a single Promise generated by Promise.resolve for a single value or Promise.all for multiple results. This is a very useful mechanism to invoke asynchronous operations over an eventbus.

          Parameters

          • name: string

            Event name(s)

            -
          • Rest ...args: any[]

            Additional arguments passed to the event function(s).

            +
          • Rest...args: any[]

            Additional arguments passed to the event function(s).

          Returns Promise<any>

          A Promise to returning any results.

        triggerDefer

        • triggerDefer(name, ...args): EventbusSecure

        • Defers invoking trigger. This is useful for triggering events in the next clock tick.

          Parameters

          • name: string

            Event name(s)

            -
          • Rest ...args: any[]

            Additional arguments passed to the event function(s).

            +
          • Rest...args: any[]

            Additional arguments passed to the event function(s).

          Returns EventbusSecure

          This EventbusProxy.

        triggerSync

        • triggerSync(name, ...args): any

        • Provides trigger functionality, but collects any returned result or results from invoked targets as a single value or in an array and passes it back to the callee in a synchronous manner.

          Parameters

          • name: string

            Event name(s)

            -
          • Rest ...args: any[]

            Additional arguments passed to the event function(s).

            +
          • Rest...args: any[]

            Additional arguments passed to the event function(s).

          Returns any

          An Array of returned results.

          -

        Static initialize

        • initialize(eventbus, name?): EventbusSecureObj

        • Creates the EventbusSecure instance with an existing instance of Eventbus. An object / EventbusSecureObj is +

        Staticinitialize

        • initialize(eventbus, name?): EventbusSecureObj

        • Creates the EventbusSecure instance with an existing instance of Eventbus. An object / EventbusSecureObj is returned with an EventbusSecure reference and two functions for controlling the underlying Eventbus reference.

          destroy() will destroy the underlying Eventbus reference. setEventbus(<eventbus>) will set the underlying reference.

          Parameters

          • eventbus: EventbusProxy | Eventbus

            The target eventbus instance.

            -
          • Optional name: string

            If a name is provided this will be used instead of eventbus name.

            +
          • Optionalname: string

            If a name is provided this will be used instead of eventbus name.

          Returns EventbusSecureObj

          The control object which contains an EventbusSecure reference and - control functions.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorisDestroyednamegetOptionsgetTypekeyskeysWithOptionstriggertriggerAsynctriggerDefertriggerSyncinitialize
        \ No newline at end of file +control functions.

        +

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_application.SvelteApplication.html b/docs/classes/_runtime_svelte_application.SvelteApplication.html index bb9c12d6..88a3b8c1 100644 --- a/docs/classes/_runtime_svelte_application.SvelteApplication.html +++ b/docs/classes/_runtime_svelte_application.SvelteApplication.html @@ -1,8 +1,19 @@ -SvelteApplication | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class SvelteApplication

        Provides a Svelte aware extension to the Foundry Application class to manage the app lifecycle +SvelteApplication | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class SvelteApplication

        Provides a Svelte aware extension to the Foundry Application class to manage the app lifecycle appropriately. You can declaratively load one or more components from defaultOptions using a TJSSvelteConfig object in the SvelteApplicationOptions options SvelteApplicationOptions.svelte property.

        -

        Hierarchy (view full)

        Implements

        Constructors

        constructor +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Implements

        Constructors

        constructor

        Accessors

        elementContent elementTarget position @@ -13,8 +24,8 @@ minimize onSvelteMount onSvelteRemount -

        Constructors

        constructor

        Accessors

        elementContent

        • get elementContent(): HTMLElement

        • Returns the content element if an application shell is mounted.

          +

        Constructors

        constructor

        Accessors

        elementContent

        • get elementContent(): HTMLElement

        • Returns the content element if an application shell is mounted.

          Returns HTMLElement

          Content element.

        elementTarget

        • get elementTarget(): HTMLElement

        • Returns the target element or main element if no target defined.

          Returns HTMLElement

          Target element.

          @@ -26,28 +37,28 @@

        Returns ApplicationState

        The application state manager.

        svelte

        • get svelte(): GetSvelteData

        • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

          Returns GetSvelteData

          GetSvelteData

          -

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          +

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default maximizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default maximizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        minimize

        • minimize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for minimized.

          Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default minimizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default minimizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        onSvelteMount

        • onSvelteMount(mountedAppShell?): void

        • Provides a callback after all Svelte components are initialized.

          -

          Parameters

          • Optional mountedAppShell: MountedAppShell

            The mounted app shell - elements.

            +

            Parameters

            Returns void

        onSvelteRemount

        • onSvelteRemount(mountedAppShell?): void

        • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

          -

          Parameters

          • Optional mountedAppShell: MountedAppShell

            The mounted app shell - elements.

            -

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorelementContentelementTargetpositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemount
        \ No newline at end of file +

        Parameters

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_application.TJSDialog.html b/docs/classes/_runtime_svelte_application.TJSDialog.html index baf408b3..978502dc 100644 --- a/docs/classes/_runtime_svelte_application.TJSDialog.html +++ b/docs/classes/_runtime_svelte_application.TJSDialog.html @@ -1,4 +1,5 @@ -TJSDialog | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSDialog

        Provides a reactive dialog implementation configured from a unique dialog options object. The dialog features a +TJSDialog | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class TJSDialog

        Provides a reactive dialog implementation configured from a unique dialog options object. The dialog features a bottom button bar for user selection.

        A glasspane / modal option with various styling and transition capabilities is available when setting modal: true.

        Most importantly the content attribute of dialog data can be a Svelte component configuration object to render @@ -20,7 +21,17 @@

        Please refer to TJSDialogOptions for the various options used to construct the dialog.

        There are a couple of static helper methods to quickly create standard dialogs such as a 'yes' / 'no' confirmation dialog with TJSDialog.confirm and an 'ok' single button dialog with TJSDialog.prompt.

        -

        Hierarchy (view full)

        Constructors

        constructor +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        data elementContent elementTarget @@ -37,9 +48,9 @@ confirm prompt wait -

        Constructors

        constructor

        Accessors

        data

        Constructors

        constructor

        Accessors

        data

        elementContent

        • get elementContent(): HTMLElement

        • Returns the content element if an application shell is mounted.

          Returns HTMLElement

          Content element.

          @@ -54,61 +65,63 @@

        Returns ApplicationState

        The application state manager.

        svelte

        • get svelte(): GetSvelteData

        • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

          Returns GetSvelteData

          GetSvelteData

          -

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          +

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default maximizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default maximizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        minimize

        • minimize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for minimized.

          Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default minimizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default minimizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        onSvelteMount

        • onSvelteMount(mountedAppShell?): void

        • Provides a callback after all Svelte components are initialized.

          -

          Parameters

        onSvelteRemount

        • onSvelteRemount(mountedAppShell?): void

        • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

          -

          Parameters

        wait

        • wait<T>(options?): Promise<T>

        • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

          Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

          Note: null is returned if the dialog is closed without a user making a choice.

          -

          Type Parameters

          • T

          Parameters

          • Optional options: {
                reuse?: boolean;
            }

            Options.

            -
            • Optional reuse?: boolean

              When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

              +

              Type Parameters

              • T

              Parameters

              • Optionaloptions: {
                    reuse?: boolean;
                }

                Options.

                +
                • Optionalreuse?: boolean

                  When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

              Returns Promise<T>

              A promise for dialog resolution.

              -

        Static confirm

        • confirm<T_1>(data?, options?): Promise<T_1>

        • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

        Staticconfirm

        • confirm<T_1>(data?, options?): Promise<T_1>

        • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

          -

          Type Parameters

          • T_1

          Parameters

          • Optional data: TJSDialogOptions & {
                onNo?: string | ((data?) => any);
                onYes?: string | ((data?) => any);
            }

            Confirm dialog options.

            -
          • Optional options: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog - constructor.

            +

            Type Parameters

            • T_1

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  onNo?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
                  onYes?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Confirm dialog options.

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_1>

            A promise which resolves with result of yes / no callbacks or true / false.

            -

            Example

            const result = await TJSDialog.confirm({
             title: 'A Yes or No Question',
             content: '<p>Choose wisely.</p>',
             onYes: () => 'YES Result',
             onNo: () => 'NO Result'
            });

            // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

        Static prompt

        • prompt<T_2>(data?, options?): Promise<T_2>

        • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

          -

          Type Parameters

          • T_2

          Parameters

          • Optional data: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | ((data?) => any);
            }

            Prompt dialog options that includes any TJSDialog options along with the following optional fields:

            -
          • Optional options: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog - constructor.

            +

            Example

            const result = await TJSDialog.confirm({
             title: 'A Yes or No Question',
             content: '<p>Choose wisely.</p>',
             onYes: () => 'YES Result',
             onNo: () => 'NO Result'
            });

            // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

        Staticprompt

        • prompt<T_2>(data?, options?): Promise<T_2>

        • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

          +

          Type Parameters

          • T_2

          Parameters

          • Optionaldata: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | ((data?: {
                    application?: TJSDialog;
                }) => any);
            }

            Prompt dialog options that includes any TJSDialog options along with the following optional fields:

            +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog +constructor.

          Returns Promise<T_2>

          The returned value from the provided callback function or true if the button - is pressed.

          -

          Example

          const result = await TJSDialog.prompt({
           title: 'Are you OK?',
           content: '<p>Are you OK?.</p>',
           label: 'Feeling Fine!',
           onOk: () => 'OK'
          });

          // Logs 'OK' or null if the user closed the dialog without making a selection.
          console.log(result);
-
          -

        Static wait

        • wait<T_3>(data, options?): Promise<T_3>

        • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +is pressed.

          +

          Example

          const result = await TJSDialog.prompt({
           title: 'Are you OK?',
           content: '<p>Are you OK?.</p>',
           label: 'Feeling Fine!',
           onOk: () => 'OK'
          });

          // Logs 'OK' or null if the user closed the dialog without making a selection.
          console.log(result);
+
          + +

        Staticwait

        • wait<T_3>(data, options?): Promise<T_3>

        • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

          Note: By default null is returned if the dialog is closed without a user making a choice.

          Type Parameters

          • T_3

          Parameters

          Returns Promise<T_3>

          A Promise that resolves to the chosen result.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptwait
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_application_legacy.HandlebarsApplication.html b/docs/classes/_runtime_svelte_application_legacy.HandlebarsApplication.html index 14447f46..d39b56ee 100644 --- a/docs/classes/_runtime_svelte_application_legacy.HandlebarsApplication.html +++ b/docs/classes/_runtime_svelte_application_legacy.HandlebarsApplication.html @@ -1,7 +1,18 @@ -HandlebarsApplication | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class HandlebarsApplication

        Provides legacy support for Handlebars rendering while still gaining aspects of reactivity with a Svelte powered +HandlebarsApplication | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class HandlebarsApplication

        Provides legacy support for Handlebars rendering while still gaining aspects of reactivity with a Svelte powered application shell. You may use HandlebarsApplication in a similar manner as the core Foundry Application class. This should only be an interim or stepwise solution as you convert your package over to fully using TRL & Svelte.

        -

        Hierarchy (view full)

        Constructors

        constructor +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        elementContent elementTarget position @@ -12,7 +23,7 @@ minimize onSvelteMount onSvelteRemount -

        Constructors

        constructor

        Accessors

        elementContent

        • get elementContent(): HTMLElement

        • Returns the content element if an application shell is mounted.

          +

        Constructors

        constructor

        Accessors

        elementContent

        • get elementContent(): HTMLElement

        • Returns the content element if an application shell is mounted.

          Returns HTMLElement

          Content element.

        elementTarget

        • get elementTarget(): HTMLElement

        • Returns the target element or main element if no target defined.

          Returns HTMLElement

          Target element.

          @@ -24,28 +35,28 @@

        Returns ApplicationState

        The application state manager.

        svelte

        • get svelte(): GetSvelteData

        • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

          Returns GetSvelteData

          GetSvelteData

          -

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          +

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default maximizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default maximizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        minimize

        • minimize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for minimized.

          Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default minimizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default minimizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        onSvelteMount

        • onSvelteMount(mountedAppShell?): void

        • Provides a callback after all Svelte components are initialized.

          -

          Parameters

        onSvelteRemount

        • onSvelteRemount(mountedAppShell?): void

        • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

          -

          Parameters

          • Optional mountedAppShell: MountedAppShell

            The mounted app shell - elements.

            -

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorelementContentelementTargetpositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemount
        \ No newline at end of file +

        Parameters

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_application_legacy.HandlebarsFormApplication.html b/docs/classes/_runtime_svelte_application_legacy.HandlebarsFormApplication.html index 78cc2aeb..35b4fbf6 100644 --- a/docs/classes/_runtime_svelte_application_legacy.HandlebarsFormApplication.html +++ b/docs/classes/_runtime_svelte_application_legacy.HandlebarsFormApplication.html @@ -1,8 +1,19 @@ -HandlebarsFormApplication | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class HandlebarsFormApplication

        Provides legacy support for Handlebars rendering while still gaining aspects of reactivity with a Svelte powered +HandlebarsFormApplication | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class HandlebarsFormApplication

        Provides legacy support for Handlebars rendering while still gaining aspects of reactivity with a Svelte powered application shell. You may use HandlebarsFormApplication in a similar manner as the core Foundry FormApplication class. This should only be an interim or stepwise solution as you convert your package over to fully using TRL & Svelte.

        -

        Hierarchy (view full)

        Constructors

        constructor +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        elementContent elementTarget position @@ -14,7 +25,7 @@ onSvelteMount onSvelteRemount

        Properties

        form -

        Constructors

        constructor

        Accessors

        elementContent

        • get elementContent(): HTMLElement

        • Returns the content element if an application shell is mounted.

          +

        Constructors

        constructor

        Accessors

        elementContent

        • get elementContent(): HTMLElement

        • Returns the content element if an application shell is mounted.

          Returns HTMLElement

          Content element.

        elementTarget

        • get elementTarget(): HTMLElement

        • Returns the target element or main element if no target defined.

          Returns HTMLElement

          Target element.

          @@ -26,26 +37,26 @@

        Returns ApplicationState

        The application state manager.

        svelte

        • get svelte(): GetSvelteData

        • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

          Returns GetSvelteData

          GetSvelteData

          -

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          +

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default maximizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default maximizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        minimize

        • minimize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for minimized.

          Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default minimizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default minimizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        onSvelteMount

        • onSvelteMount(mountedAppShell?): void

        • Provides a callback after all Svelte components are initialized.

          -

          Parameters

          • Optional mountedAppShell: MountedAppShell

            The mounted app shell elements.

            +

            Parameters

            • OptionalmountedAppShell: MountedAppShell

              The mounted app shell elements.

            Returns void

        onSvelteRemount

        • onSvelteRemount(mountedAppShell?): void

        • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

          -

          Parameters

          • Optional mountedAppShell: MountedAppShell

            The mounted app shell elements.

            -

          Returns void

        Properties

        form

        form: any

        Settings

        Member Visibility

        Theme

        On This Page

        constructorelementContentelementTargetpositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountform
        \ No newline at end of file +

        Parameters

        • OptionalmountedAppShell: MountedAppShell

          The mounted app shell elements.

          +

        Returns void

        Properties

        form

        form: any

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        Properties
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_application_legacy.SvelteFormApplication.html b/docs/classes/_runtime_svelte_application_legacy.SvelteFormApplication.html index 0288189d..9f932e93 100644 --- a/docs/classes/_runtime_svelte_application_legacy.SvelteFormApplication.html +++ b/docs/classes/_runtime_svelte_application_legacy.SvelteFormApplication.html @@ -1,11 +1,22 @@ -SvelteFormApplication | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class SvelteFormApplication

        Provides a Svelte aware extension to the Foundry FormApplication class to manage the app lifecycle +SvelteFormApplication | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class SvelteFormApplication

        Provides a Svelte aware extension to the Foundry FormApplication class to manage the app lifecycle appropriately. You can declaratively load one or more components from defaultOptions. You can declaratively load one or more components from defaultOptions using a TJSSvelteConfig object in the SvelteApplicationOptions options SvelteApplicationOptions.svelte property.

        Note: It is not recommended that you use or depend on this class as it only exists to support HandlebarsFormApplication due to the OOP nature of the Foundry VTT platform. This should only be an interim or stepwise solution as you convert your package over to fully using TRL & Svelte.

        -

        Hierarchy (view full)

        Constructors

        constructor +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        elementContent elementTarget position @@ -16,8 +27,8 @@ minimize onSvelteMount onSvelteRemount -

        Constructors

        constructor

        Accessors

        elementContent

        • get elementContent(): HTMLElement

        • Returns the content element if an application shell is mounted.

          +

        Constructors

        constructor

        Accessors

        elementContent

        • get elementContent(): HTMLElement

        • Returns the content element if an application shell is mounted.

          Returns HTMLElement

          Content element.

        elementTarget

        • get elementTarget(): HTMLElement

        • Returns the target element or main element if no target defined.

          Returns HTMLElement

          Target element.

          @@ -29,26 +40,26 @@

        Returns ApplicationState

        The application state manager.

        svelte

        • get svelte(): GetSvelteData

        • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

          Returns GetSvelteData

          GetSvelteData

          -

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          +

        Methods

        maximize

        • maximize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for maximized.

          Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default maximizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default maximizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        minimize

        • minimize(opts?): Promise<void>

        • Provides a mechanism to update the UI options store for minimized.

          Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

          -

          Parameters

          • Optional opts: {
                animate?: boolean;
                duration?: number;
            }

            Optional parameters.

            -
            • Optional animate?: boolean

              When true perform default minimizing animation.

              -
            • Optional duration?: number

              Controls content area animation duration in seconds.

              +

              Parameters

              • Optionalopts: {
                    animate?: boolean;
                    duration?: number;
                }

                Optional parameters.

                +
                • Optionalanimate?: boolean

                  When true perform default minimizing animation.

                  +
                • Optionalduration?: number

                  Controls content area animation duration in seconds.

              Returns Promise<void>

        onSvelteMount

        • onSvelteMount(mountedAppShell?): void

        • Provides a callback after all Svelte components are initialized.

          -

          Parameters

          • Optional mountedAppShell: MountedAppShell

            The mounted app shell elements.

            +

            Parameters

            • OptionalmountedAppShell: MountedAppShell

              The mounted app shell elements.

            Returns void

        onSvelteRemount

        • onSvelteRemount(mountedAppShell?): void

        • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

          -

          Parameters

          • Optional mountedAppShell: MountedAppShell

            The mounted app shell elements.

            -

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructorelementContentelementTargetpositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemount
        \ No newline at end of file +

        Parameters

        • OptionalmountedAppShell: MountedAppShell

          The mounted app shell elements.

          +

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_component_core.ApplicationShell.html b/docs/classes/_runtime_svelte_component_core.ApplicationShell.html index df606fc6..30e0248f 100644 --- a/docs/classes/_runtime_svelte_component_core.ApplicationShell.html +++ b/docs/classes/_runtime_svelte_component_core.ApplicationShell.html @@ -1,6 +1,17 @@ -ApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class ApplicationShell

        Provides an application shell is a main top level slotted component that provides a reactive +ApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class ApplicationShell

        Provides an application shell is a main top level slotted component that provides a reactive outer wrapper and header bar for the main content component.

        -

        Hierarchy (view full)

        Constructors

        constructor +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        appOffsetHeight appOffsetWidth contentOffsetHeight @@ -20,7 +31,7 @@

        Methods

        $destroy $on $set -

        Constructors

        constructor

        Accessors

        appOffsetHeight

        Constructors

        constructor

        Accessors

        appOffsetHeight

        • get appOffsetHeight(): boolean

        • Getter for appOffsetHeight prop.

          Returns boolean

        • set appOffsetHeight(_): void

        • Setter for appOffsetHeight prop.

          Parameters

          • _: boolean

          Returns void

        appOffsetWidth

        • get appOffsetWidth(): boolean

        • Getter for appOffsetWidth prop.

          Returns boolean

        • set appOffsetWidth(_): void

        • Setter for appOffsetWidth prop.

          @@ -52,4 +63,4 @@

          Returns (() => undefined)

            • (): undefined

            • Returns undefined

        • set transition(_): void

        • Setter for transition prop.

          Parameters

          • _: (() => undefined)
              • (): undefined

              • Returns undefined

          Returns void

        transitionOptions

        Methods

        $destroy

        $on

        • $on<K>(type, callback): (() => void)

        • Type Parameters

          • K extends string

          Parameters

          • type: K
          • callback: ((e) => void)

          Returns (() => void)

            • (): void

            • Returns void

        $set

        Settings

        Member Visibility

        Theme

        On This Page

        constructorappOffsetHeightappOffsetWidthcontentOffsetHeightcontentOffsetWidthdraggabledraggableOptionselementContentelementRootinTransitioninTransitionOptionsoutTransitionoutTransitionOptionsstylesAppstylesContenttransitiontransitionOptions$destroy$on$set
        \ No newline at end of file +

        Parameters

        • _: any

        Returns void

        Methods

        $destroy

        $on

        • $on<K>(type, callback): (() => void)

        • Type Parameters

          • K extends string

          Parameters

          Returns (() => void)

            • (): void

            • Returns void

        $set

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_component_core.EmptyApplicationShell.html b/docs/classes/_runtime_svelte_component_core.EmptyApplicationShell.html index 2562dd98..681acfa1 100644 --- a/docs/classes/_runtime_svelte_component_core.EmptyApplicationShell.html +++ b/docs/classes/_runtime_svelte_component_core.EmptyApplicationShell.html @@ -1,5 +1,16 @@ -EmptyApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class EmptyApplicationShell

        Provides an empty application shell as a main top level slotted component.

        -

        Hierarchy (view full)

        Constructors

        constructor +EmptyApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class EmptyApplicationShell

        Provides an empty application shell as a main top level slotted component.

        +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        appOffsetHeight appOffsetWidth elementContent @@ -14,7 +25,7 @@

        Methods

        $destroy $on $set -

        Constructors

        constructor

        Accessors

        appOffsetHeight

        Constructors

        constructor

        Accessors

        appOffsetHeight

        • get appOffsetHeight(): boolean

        • Getter for appOffsetHeight prop.

          Returns boolean

        • set appOffsetHeight(_): void

        • Setter for appOffsetHeight prop.

          Parameters

          • _: boolean

          Returns void

        appOffsetWidth

        • get appOffsetWidth(): boolean

        • Getter for appOffsetWidth prop.

          Returns boolean

        • set appOffsetWidth(_): void

        • Setter for appOffsetWidth prop.

          @@ -36,4 +47,4 @@

          Returns (() => undefined)

            • (): undefined

            • Returns undefined

        • set transition(_): void

        • Setter for transition prop.

          Parameters

          • _: (() => undefined)
              • (): undefined

              • Returns undefined

          Returns void

        transitionOptions

        Methods

        $destroy

        $on

        • $on<K>(type, callback): (() => void)

        • Type Parameters

          • K extends string

          Parameters

          • type: K
          • callback: ((e) => void)

          Returns (() => void)

            • (): void

            • Returns void

        $set

        Settings

        Member Visibility

        Theme

        On This Page

        constructorappOffsetHeightappOffsetWidthelementContentelementRootinTransitioninTransitionOptionsoutTransitionoutTransitionOptionsstylesApptransitiontransitionOptions$destroy$on$set
        \ No newline at end of file +

        Parameters

        • _: any

        Returns void

        Methods

        $destroy

        $on

        • $on<K>(type, callback): (() => void)

        • Type Parameters

          • K extends string

          Parameters

          Returns (() => void)

            • (): void

            • Returns void

        $set

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_component_core.TJSApplicationShell.html b/docs/classes/_runtime_svelte_component_core.TJSApplicationShell.html index 9d13cdf0..72122248 100644 --- a/docs/classes/_runtime_svelte_component_core.TJSApplicationShell.html +++ b/docs/classes/_runtime_svelte_component_core.TJSApplicationShell.html @@ -1,9 +1,21 @@ -TJSApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSApplicationShell

        Provides an alternate application shell that is scoped by slightly different CSS classes than +TJSApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class TJSApplicationShell

        Provides an alternate application shell that is scoped by slightly different CSS classes than ApplicationShell. An application shell is a main top level slotted component that provides a reactive outer wrapper and header bar for the main content component.

        -

        CSS variables

        '--tjs-app-background': Controls the app background image; set in main `index.js`.
+
        CSS variables
        '--tjs-app-background': Controls the app background image; set in main `index.js`.
 
        
-

        Hierarchy (view full)

        Constructors

        constructor + +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        appOffsetHeight appOffsetWidth contentOffsetHeight @@ -23,7 +35,7 @@

        Methods

        $destroy $on $set -

        Constructors

        constructor

        Accessors

        appOffsetHeight

        Constructors

        constructor

        Accessors

        appOffsetHeight

        • get appOffsetHeight(): boolean

        • Getter for appOffsetHeight prop.

          Returns boolean

        • set appOffsetHeight(_): void

        • Setter for appOffsetHeight prop.

          Parameters

          • _: boolean

          Returns void

        appOffsetWidth

        • get appOffsetWidth(): boolean

        • Getter for appOffsetWidth prop.

          Returns boolean

        • set appOffsetWidth(_): void

        • Setter for appOffsetWidth prop.

          @@ -55,4 +67,4 @@

          Returns (() => undefined)

            • (): undefined

            • Returns undefined

        • set transition(_): void

        • Setter for transition prop.

          Parameters

          • _: (() => undefined)
              • (): undefined

              • Returns undefined

          Returns void

        transitionOptions

        Methods

        $destroy

        $on

        • $on<K>(type, callback): (() => void)

        • Type Parameters

          • K extends string

          Parameters

          • type: K
          • callback: ((e) => void)

          Returns (() => void)

            • (): void

            • Returns void

        $set

        Settings

        Member Visibility

        Theme

        On This Page

        constructorappOffsetHeightappOffsetWidthcontentOffsetHeightcontentOffsetWidthdraggabledraggableOptionselementContentelementRootinTransitioninTransitionOptionsoutTransitionoutTransitionOptionsstylesAppstylesContenttransitiontransitionOptions$destroy$on$set
        \ No newline at end of file +

        Parameters

        • _: any

        Returns void

        Methods

        $destroy

        $on

        • $on<K>(type, callback): (() => void)

        • Type Parameters

          • K extends string

          Parameters

          Returns (() => void)

            • (): void

            • Returns void

        $set

        Settings

        Member Visibility

        On This Page

        CSS variables
        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_component_core.TJSFocusWrap.html b/docs/classes/_runtime_svelte_component_core.TJSFocusWrap.html index 40a0a68b..52e042ae 100644 --- a/docs/classes/_runtime_svelte_component_core.TJSFocusWrap.html +++ b/docs/classes/_runtime_svelte_component_core.TJSFocusWrap.html @@ -1,6 +1,17 @@ -TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSFocusWrap

        TODO: Add description

        -

        Hierarchy (view full)

        Constructors

        constructor +TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class TJSFocusWrap

        TODO: Add description

        +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Methods

        $destroy $on $set -

        Constructors

        constructor

        Methods

        $destroy

        $on

        • $on<K>(type, callback): (() => void)

        • Type Parameters

          • K extends string

          Parameters

          • type: K
          • callback: ((e) => void)

          Returns (() => void)

            • (): void

            • Returns void

        $set

        Settings

        Member Visibility

        Theme

        On This Page

        constructor$destroy$on$set
        \ No newline at end of file +

        Constructors

        constructor

        Methods

        $destroy

        $on

        • $on<K>(type, callback): (() => void)

        • Type Parameters

          • K extends string

          Parameters

          Returns (() => void)

            • (): void

            • Returns void

        $set

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_component_core.TJSGlassPane.html b/docs/classes/_runtime_svelte_component_core.TJSGlassPane.html index b1ec5bd6..8bed9994 100644 --- a/docs/classes/_runtime_svelte_component_core.TJSGlassPane.html +++ b/docs/classes/_runtime_svelte_component_core.TJSGlassPane.html @@ -1,6 +1,17 @@ -TJSGlassPane | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSGlassPane

        TODO: Add description

        -

        Hierarchy (view full)

        Constructors

        constructor +TJSGlassPane | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class TJSGlassPane

        TODO: Add description

        +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Methods

        $destroy $on $set -

        Constructors

        constructor

        Methods

        $destroy

        $on

        • $on<K>(type, callback): (() => void)

        • Type Parameters

          • K extends string

          Parameters

          Returns (() => void)

            • (): void

            • Returns void

        $set

        Settings

        Member Visibility

        Theme

        On This Page

        constructor$destroy$on$set
        \ No newline at end of file +

        Constructors

        constructor

        Methods

        $destroy

        $on

        $set

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_gsap.GsapCompose.html b/docs/classes/_runtime_svelte_gsap.GsapCompose.html index a4f3b680..538b1c8b 100644 --- a/docs/classes/_runtime_svelte_gsap.GsapCompose.html +++ b/docs/classes/_runtime_svelte_gsap.GsapCompose.html @@ -1,7 +1,8 @@ -GsapCompose | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class GsapCompose

        Provides a data driven ways to connect a TJSPosition instance with a GSAP timeline and tweens.

        +GsapCompose | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class GsapCompose

        Provides a data driven ways to connect a TJSPosition instance with a GSAP timeline and tweens.

        GsapPosition.timeline supports the following types: 'add', 'addLabel', 'addPause', 'call', 'from', 'fromTo', 'set', 'to'.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Methods

        from fromTo hasMethod @@ -10,41 +11,41 @@ registerPlugin timeline to -

        Constructors

        constructor

        Methods

        Static from

        • from(target, vars, options?): object

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

            +

        Constructors

        constructor

        Methods

        Staticfrom

        • from(target, vars, options?): object

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

          • vars: object

            GSAP vars object for from.

            -
          • Optional options: GsapPositionOptions

            Options for filtering and initial data - population for TJSPosition tweens.

            +
          • Optionaloptions: GsapPositionOptions

            Options for filtering and initial data +population for TJSPosition tweens.

          Returns object

          GSAP tween

          -

        Static fromTo

        • fromTo(target, fromVars, toVars, options?): object

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

            +

        StaticfromTo

        • fromTo(target, fromVars, toVars, options?): object

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

          • fromVars: object

            GSAP fromVars object for fromTo

          • toVars: object

            GSAP toVars object for fromTo.

            -
          • Optional options: GsapPositionOptions

            Options for filtering and initial data - population.

            +
          • Optionaloptions: GsapPositionOptions

            Options for filtering and initial data +population.

          Returns object

          GSAP tween

          -

        Static hasMethod

        • hasMethod(name): boolean

        • Checks the gsap module instance for existence of a method and GsapCompose for the same method name. This +

        StatichasMethod

        • hasMethod(name): boolean

        • Checks the gsap module instance for existence of a method and GsapCompose for the same method name. This is helpful to determine which new features are available. Ex. quickTo is not available until GSAP 3.10+.

          Parameters

          • name: string

            Name of method to check.

          Returns boolean

          Gsap and GsapCompose support the given method.

          -

        Static quickTo

        • quickTo(target, key, vars, options?): Function

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

            +

        StaticquickTo

        • quickTo(target, key, vars, options?): Function

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

          • key: string

            Property of position to manipulate.

          • vars: object

            GSAP vars object for quickTo.

            -
          • Optional options: GsapPositionOptions

            Options for filtering and initial data - population.

            +
          • Optionaloptions: GsapPositionOptions

            Options for filtering and initial data +population.

          Returns Function

          GSAP quickTo function.

          -

        Static registerEase

        • registerEase(name, ease): void

        • Defers to gsap module to register an easing function.

          +

        StaticregisterEase

        • registerEase(name, ease): void

        • Defers to gsap module to register an easing function.

          Parameters

          • name: string

            Easing name.

          • ease: Function

            An easing function.

            -

          Returns void

        Static registerPlugin

        • registerPlugin(...args): void

        • Defers to gsap module to register a plugin.

          -

          Parameters

          • Rest ...args: Function[]

            A list of plugins.

            -

          Returns void

        Static timeline

        • timeline(target, arg1?, arg2?, arg3?): object

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

            -
          • Optional arg1: object | GsapData

            Either an object defining timeline options or - GsapData.

            -
          • Optional arg2: object | GsapData | GsapPositionOptions

            When arg1 is defined as an object / Function; arg2 defines GsapData or Gsap options.

            -
          • Optional arg3: GsapPositionOptions

            Options for filtering and initial data population.

            +

          Returns void

        StaticregisterPlugin

        • registerPlugin(...args): void

        • Defers to gsap module to register a plugin.

          +

          Parameters

          • Rest...args: Function[]

            A list of plugins.

            +

          Returns void

        Statictimeline

        • timeline(target, arg1?, arg2?, arg3?): object

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

            +
          • Optionalarg1: object | GsapData

            Either an object defining timeline options or +GsapData.

            +
          • Optionalarg2: object | GsapData | GsapPositionOptions

            When arg1 is defined as an object / Function; arg2 defines GsapData or Gsap options.

            +
          • Optionalarg3: GsapPositionOptions

            Options for filtering and initial data population.

          Returns object

          GSAP timeline

          -

        Static to

        • to(target, vars, options?): object

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

            +

        Staticto

        • to(target, vars, options?): object

        • Parameters

          • target: GsapTarget

            A standard GSAP target or TJSPosition.

          • vars: object

            GSAP vars object for to.

            -
          • Optional options: GsapPositionOptions

            Options for filtering and initial data - population.

            +
          • Optionaloptions: GsapPositionOptions

            Options for filtering and initial data +population.

          Returns object

          GSAP tween

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorfromfromTohasMethodquickToregisterEaseregisterPlugintimelineto
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_dom.KeyStore.html b/docs/classes/_runtime_svelte_store_dom.KeyStore.html index ea643403..a5eb03d5 100644 --- a/docs/classes/_runtime_svelte_store_dom.KeyStore.html +++ b/docs/classes/_runtime_svelte_store_dom.KeyStore.html @@ -1,6 +1,7 @@ -KeyStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class KeyStore

        Provides a readable store to track keys actively pressed. KeyStore is designed to be used with the +KeyStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class KeyStore

        Provides a readable store to track keys actively pressed. KeyStore is designed to be used with the keyforward action.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Methods

        _updateSubscribers addKey anyPressed @@ -14,13 +15,13 @@ setOptions subscribe value -

        Constructors

        constructor

        Methods

        Protected _updateSubscribers

        • _updateSubscribers(): void
        • Protected

          Updates subscribers.

          +

        Constructors

        constructor

        Methods

        Protected_updateSubscribers

        • _updateSubscribers(): void
        • Protected

          Updates subscribers.

          Returns void

        addKey

        • addKey(key): void

        • Add given key to the tracking key set.

          Parameters

          • key: string

            Key to add.

          Returns void

        anyPressed

        • anyPressed(keys?): boolean

        • Returns true if any of given keys are pressed. If keys is undefined then the result is true if any keys being tracked are pressed.

          -

          Parameters

          • Optional keys: string | Iterable<string>

            Zero or more key strings or list to verify if any pressed.

            +

            Parameters

            • Optionalkeys: string | Iterable<string>

              Zero or more key strings or list to verify if any pressed.

            Returns boolean

            True if any keys set are pressed.

        hasKey

        • hasKey(key): void

        • Is the given key in the tracking key set.

          Parameters

          • key: string

            Key to check.

            @@ -38,8 +39,8 @@

          Returns void

        setOptions

        • setOptions(options): void

        • Update options.

          Parameters

          Returns void

        subscribe

        value

        • value(key): number

        • Parameters

          • key: string

            key or key code to lookup.

          Returns number

          1 if currently pressed and 0 if not pressed.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_updateSubscribersaddKeyanyPressedhasKeyisPressedkeydownkeysPressedkeysTrackedkeyupremoveKeysetOptionssubscribevalue
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocument.html b/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocument.html index 1f1b0806..7b8158e4 100644 --- a/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocument.html +++ b/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocument.html @@ -1,7 +1,8 @@ -TJSDocument | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSDocument<T>

        Type Parameters

        • T = NamedDocumentConstructor

          Provides a wrapper implementing the Svelte store / subscriber protocol around any Document / ClientMixinDocument. +TJSDocument | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSDocument<T>

          Type Parameters

          • T = NamedDocumentConstructor

            Provides a wrapper implementing the Svelte store / subscriber protocol around any Document / ClientMixinDocument. This makes documents reactive in a Svelte component, but otherwise provides subscriber functionality external to Svelte.

            -

          Constructors

          constructor +

        Constructors

        constructor

        Accessors

        embedded updateOptions uuidv4 @@ -13,37 +14,37 @@ setOptions subscribe getUUIDFromDataTransfer -

        Constructors

        constructor

        Accessors

        embedded

        Constructors

        constructor

        Accessors

        embedded

        updateOptions

        uuidv4

        • get uuidv4(): string

        • Returns the UUID assigned to this store.

          Returns string

          UUID

          -

        Methods

        destroy

        • destroy(): void

        • Completely removes all internal subscribers, any optional delete callback, and unregisters from the +

        Methods

        destroy

        • destroy(): void

        • Completely removes all internal subscribers, any optional delete callback, and unregisters from the ClientDocumentMixin apps tracking object.

          Returns void

        get

        • get(): T

        • Returns T

          Current document

        set

        setFromDataTransfer

        • setFromDataTransfer(data, options?): Promise<boolean>

        • Potentially sets new document from data transfer object.

          Parameters

          • data: object

            Document transfer data.

            -
          • Optional options: {
                compendium?: boolean;
                types?: string[];
                world?: boolean;
            }

            Optional parameters for - TJSDocument.getUUIDFromDataTransfer.

            -
            • Optional compendium?: boolean
            • Optional types?: string[]
            • Optional world?: boolean

          Returns Promise<boolean>

          Returns true if new document set from data transfer blob.

          +
        • Optionaloptions: {
              compendium?: boolean;
              types?: string[];
              world?: boolean;
          }

          Optional parameters for +TJSDocument.getUUIDFromDataTransfer.

          +
          • Optionalcompendium?: boolean
          • Optionaltypes?: string[]
          • Optionalworld?: boolean

        Returns Promise<boolean>

        Returns true if new document set from data transfer blob.

        setFromUUID

        • setFromUUID(uuid, options?): Promise<boolean>

        • Sets the document by Foundry UUID performing a lookup and setting the document if found.

          Parameters

          Returns Promise<boolean>

          True if successfully set document from UUID.

        setOptions

        • setOptions(options): void

        • Sets options for this document wrapper / store.

          Parameters

          Returns void

        subscribe

        • subscribe(handler): Unsubscriber

        • Parameters

          • handler: ((value, updateOptions?) => void)

            Callback function that is +

          Returns void

        subscribe

        Static getUUIDFromDataTransfer

        • getUUIDFromDataTransfer(data, opts?): string

        • Attempts to create a Foundry UUID from standard drop data. This may not work for all systems.

          +

        Returns Unsubscriber

        Unsubscribe function.

        +

        StaticgetUUIDFromDataTransfer

        • getUUIDFromDataTransfer(data, opts?): string

        • Attempts to create a Foundry UUID from standard drop data. This may not work for all systems.

          Parameters

          • data: object

            Drop transfer data.

            -
          • Optional opts: {
                compendium?: boolean;
                types?: string[];
                world?: boolean;
            }

            Optional parameters.

            -
            • Optional compendium?: boolean

              Accept compendium documents.

              -
            • Optional types?: string[]

              Require the data.type to match entry in types.

              -
            • Optional world?: boolean

              Accept world documents.

              +
            • Optionalopts: {
                  compendium?: boolean;
                  types?: string[];
                  world?: boolean;
              }

              Optional parameters.

              +
              • Optionalcompendium?: boolean

                Accept compendium documents.

                +
              • Optionaltypes?: string[]

                Require the data.type to match entry in types.

                +
              • Optionalworld?: boolean

                Accept world documents.

          Returns string

          Foundry UUID for drop data.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorembeddedupdateOptionsuuidv4destroygetsetsetFromDataTransfersetFromUUIDsetOptionssubscribegetUUIDFromDataTransfer
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocumentCollection.html b/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocumentCollection.html index c473829c..5dccf83a 100644 --- a/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocumentCollection.html +++ b/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocumentCollection.html @@ -1,7 +1,8 @@ -TJSDocumentCollection | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSDocumentCollection<T>

        Provides a wrapper implementing the Svelte store / subscriber protocol around any DocumentCollection. This makes +TJSDocumentCollection | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class TJSDocumentCollection<T>

        Provides a wrapper implementing the Svelte store / subscriber protocol around any DocumentCollection. This makes document collections reactive in a Svelte component, but otherwise provides subscriber functionality external to Svelte.

        -

        Type Parameters

        Constructors

        constructor +

        Type Parameters

        Constructors

        constructor

        Accessors

        updateOptions uuid

        Methods

        destroy @@ -9,20 +10,20 @@ set setOptions subscribe -

        Constructors

        constructor

        Accessors

        updateOptions

        Constructors

        constructor

        Accessors

        updateOptions

        uuid

        • get uuid(): string

        • Returns the UUID assigned to this store.

          Returns string

          UUID

          -

        Methods

        destroy

        • destroy(): void

        • Completely removes all internal subscribers, any optional delete callback, and unregisters from the +

        Methods

        destroy

        • destroy(): void

        • Completely removes all internal subscribers, any optional delete callback, and unregisters from the DocumentCollection apps tracking array.

          Returns void

        get

        • get(): T

        • Returns T

          Current collection

        set

        • set(collection, options?): void

        • Parameters

          • collection: T

            New collection to set.

            -
          • Optional options: any

            New collection update options to set.

            +
          • Optionaloptions: any

            New collection update options to set.

          Returns void

        setOptions

        • setOptions(options): void

        • Sets options for this collection wrapper / store.

          Parameters

          Returns void

        subscribe

        • subscribe(handler): Unsubscriber

        • Parameters

          • handler: ((value, updateOptions?) => void)

            Callback function +

          Returns void

        subscribe

        Settings

        Member Visibility

        Theme

        On This Page

        constructorupdateOptionsuuiddestroygetsetsetOptionssubscribe
        \ No newline at end of file +

        Returns Unsubscriber

        Unsubscribe function.

        +

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_fvtt_settings.TJSGameSettings.html b/docs/classes/_runtime_svelte_store_fvtt_settings.TJSGameSettings.html index c101d7e4..ece82f80 100644 --- a/docs/classes/_runtime_svelte_store_fvtt_settings.TJSGameSettings.html +++ b/docs/classes/_runtime_svelte_store_fvtt_settings.TJSGameSettings.html @@ -1,10 +1,11 @@ -TJSGameSettings | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSGameSettings

        Registers game settings and creates a backing Svelte store for each setting. The Svelte store will update the +TJSGameSettings | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class TJSGameSettings

        Registers game settings and creates a backing Svelte store for each setting. The Svelte store will update the Foundry game settings and vice versa when changes occur to the Foundry game settings the updated data is set to the store.

        Note: It is possible to add multiple onChange callbacks on registration.

        TODO: A possible future extension is to offer type checking against the setting type by creating a customized writable store that has an overloaded set method to provide type checking.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        namespace uiControl

        Methods

        data @@ -16,17 +17,17 @@ register registerAll stores -

        Constructors

        constructor

        • new TJSGameSettings(namespace): TJSGameSettings

        • Creates the TJSGameSettings instance.

          +

        Constructors

        constructor

        • new TJSGameSettings(namespace): TJSGameSettings

        • Creates the TJSGameSettings instance.

          Parameters

          • namespace: string

            The namespace for all settings.

            -

          Returns TJSGameSettings

        Accessors

        namespace

        • get namespace(): string

        • Returns string

          Returns namespace set in constructor.

          +

        Returns TJSGameSettings

        Accessors

        namespace

        • get namespace(): string

        • Returns string

          Returns namespace set in constructor.

        uiControl

        Methods

        data

        Methods

        data

        entries

        • entries<T>(regex?): IterableIterator<[string, Writable<T>]>

        • Type Parameters

          • T

            Returns an iterable for the game setting keys and stores.

            -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter by game setting keys.

            +

            Yields

        entries

        • entries<T>(regex?): IterableIterator<[string, Writable<T>]>

        • Type Parameters

          • T

            Returns an iterable for the game setting keys and stores.

            +

          Parameters

          • Optionalregex: RegExp

            Optional regular expression to filter by game setting keys.

          Returns IterableIterator<[string, Writable<T>]>

          Iterable iterator of keys and stores.

          -

          Yields

        getReadableStore

        • getReadableStore(key): Readable<any>

        • Returns a readable Game Settings store for the associated key.

          +

          Yields

        getReadableStore

        • getReadableStore(key): Readable<any>

        • Returns a readable Game Settings store for the associated key.

          Parameters

          • key: string

            Game setting key.

          Returns Readable<any>

          The associated store for the given game setting key.

        getStore

        • getStore(key): Writable<any>

        • Returns a writable Game Settings store for the associated key.

          @@ -36,9 +37,9 @@

          Parameters

          • key: string

            Game setting key.

          Returns Writable<any>

          The associated store for the given game setting key.

        keys

        • keys(regex?): IterableIterator<string>

        • Returns an iterable for the game setting keys from existing stores.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter by game setting keys.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter by game setting keys.

            Returns IterableIterator<string>

            Iterable iterator of game setting keys.

            -

            Yields

        register

        • register(setting, coreConfig?): Function

        • Registers a setting with TJSGameSettings and Foundry core.

          +

          Yields

        register

        • register(setting, coreConfig?): Function

        • Registers a setting with TJSGameSettings and Foundry core.

          Note: The specific store subscription handler assigned to the passed in store or store created for the setting internally is returned from this function. In some cases when setting up custom stores particularly of object types with several child property stores (propertyStore) it is necessary to only update the setting store and @@ -46,19 +47,19 @@

          This allows the custom store in the set implementation to mainly only trigger the TJSGameSettings subscriber handler on updates and not all the connected propertyStore instances.

          Parameters

          • setting: GameSetting

            A GameSetting instance to set to Foundry game settings.

            -
          • Optional coreConfig: boolean

            When false this overrides the setting.options.config parameter when - registering the setting with Foundry. This allows the settings to be displayed - in the app itself, but removed from the standard Foundry configuration location.

            +
          • OptionalcoreConfig: boolean

            When false this overrides the setting.options.config parameter when +registering the setting with Foundry. This allows the settings to be displayed +in the app itself, but removed from the standard Foundry configuration location.

          Returns Function

          The specific store subscription handler assigned to the passed in store.

        registerAll

        • registerAll(settings, coreConfig): {
              [key: string]: Function;
          }

        • Registers multiple settings.

          Please refer to the note in TJSGameSettings.register about the returned object of store subscriber handler functions.

          Parameters

          • settings: Iterable<GameSetting>

            An iterable list of game setting configurations to register.

          • coreConfig: boolean

            When false this overrides the setting.options.config parameter when - registering the setting with Foundry. This allows the settings to be displayed - in the app itself, but removed from the standard Foundry configuration location.

            +registering the setting with Foundry. This allows the settings to be displayed +in the app itself, but removed from the standard Foundry configuration location.

          Returns {
              [key: string]: Function;
          }

          An object containing all TJSGameSetting store subscriber handlers for each - setting key added.

          -

        stores

        stores

        Settings

        Member Visibility

        Theme

        On This Page

        constructornamespaceuiControldataentriesgetReadableStoregetStoregetWritableStorekeysregisterregisterAllstores
        \ No newline at end of file +

        Yields

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_fvtt_settings.TJSLiveGameSettings.html b/docs/classes/_runtime_svelte_store_fvtt_settings.TJSLiveGameSettings.html index 4f7d26d0..cc1c2ac0 100644 --- a/docs/classes/_runtime_svelte_store_fvtt_settings.TJSLiveGameSettings.html +++ b/docs/classes/_runtime_svelte_store_fvtt_settings.TJSLiveGameSettings.html @@ -1,4 +1,5 @@ -TJSLiveGameSettings | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSLiveGameSettings

        Provides an accessible JS object that is updated reactively from all or subset of TJSGameSettings stores. +TJSLiveGameSettings | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class TJSLiveGameSettings

        Provides an accessible JS object that is updated reactively from all or subset of TJSGameSettings stores. Accessors are provided to directly get / set current setting data. Using a setter will update the setting and backing store.

        Note: You can create a JSDoc / @typedef to apply with @type and achieve typing support in IDEs for the @@ -8,7 +9,7 @@ settings tracked.

        Note: When using from JS a second subscriber function argument is the key that was updated. From Svelte: Use 'lastKey' accessor to retrieve the last updated key.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        lastKey

        Methods

        _update destroy @@ -17,25 +18,25 @@ subscribe toString values -

        Constructors

        constructor

        • new TJSLiveGameSettings(gameSettings, options?): TJSLiveGameSettings

        • Creates a live binding against the setting stores. All settings are configured by default, but can also be +

        Constructors

        constructor

        • new TJSLiveGameSettings(gameSettings, options?): TJSLiveGameSettings

        • Creates a live binding against the setting stores. All settings are configured by default, but can also be filtered by setting key with inclusive / exclusive Sets.

          Parameters

          • gameSettings: TJSGameSettings

            A game settings instance to subscribe to...

            -
          • Optional options: {
                exclude?: Set<string>;
                include?: Set<string>;
            }

            TJSLiveGameSettings options.

            -
            • Optional exclude?: Set<string>

              A Set of setting keys to exclude from subscribing.

              -
            • Optional include?: Set<string>

              A Set of setting keys to include from subscribing.

              -

          Returns TJSLiveGameSettings

        Accessors

        lastKey

        • get lastKey(): string

        • Returns string

          Last updated setting key.

          -

        Methods

        Protected _update

        • _update(key): void
        • Protected

          Override to respond to setting update.

          +
        • Optionaloptions: {
              exclude?: Set<string>;
              include?: Set<string>;
          }

          TJSLiveGameSettings options.

          +
          • Optionalexclude?: Set<string>

            A Set of setting keys to exclude from subscribing.

            +
          • Optionalinclude?: Set<string>

            A Set of setting keys to include from subscribing.

            +

        Returns TJSLiveGameSettings

        Accessors

        lastKey

        • get lastKey(): string

        • Returns string

          Last updated setting key.

          +

        Methods

        Protected_update

        • _update(key): void
        • Protected

          Override to respond to setting update.

          Parameters

          • key: string

            The setting / local key that updated.

          Returns void

        destroy

        • destroy(): void

        • Destroys this instance of TJSLiveGameSettings and unsubscribes from all game setting stores.

          Returns void

        entries

        • entries(): IterableIterator<[key: string, value: any]>

        • Returns an iterator / generator of all setting entries.

          Returns IterableIterator<[key: string, value: any]>

          An iterator returning setting entries.

          -

          Yields

        keys

        • keys(): IterableIterator<string>

        • Returns an iterator / generator of all setting keys.

          +

          Yields

        keys

        • keys(): IterableIterator<string>

        • Returns an iterator / generator of all setting keys.

          Returns IterableIterator<string>

          An iterator returning setting keys.

          -

          Yields

        subscribe

        • subscribe(handler): Unsubscriber

        • Parameters

          • handler: ((value, key?) => void)

            Callback function that is invoked on +

            Yields

        subscribe

        Returns Unsubscriber

        Unsubscribe function.

        toString

        • toString(): string

        • Returns a string / JSON stringify of the current setting data.

          Returns string

          Tracked setting data.

        values

        Settings

        Member Visibility

        Theme

        On This Page

        constructorlastKey_updatedestroyentrieskeyssubscribetoStringvalues
        \ No newline at end of file +

        Yields

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_position.TJSPosition.html b/docs/classes/_runtime_svelte_store_position.TJSPosition.html index 620f0c78..bbdc3d77 100644 --- a/docs/classes/_runtime_svelte_store_position.TJSPosition.html +++ b/docs/classes/_runtime_svelte_store_position.TJSPosition.html @@ -1,7 +1,8 @@ -TJSPosition | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSPosition

        Provides an advanced compound store for positioning elements dynamically including an optimized pipeline for updating +TJSPosition | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class TJSPosition

        Provides an advanced compound store for positioning elements dynamically including an optimized pipeline for updating an associated element. Essential tweening / animation is supported in addition to a validation API to constrain positional updates.

        -

        Implements

        Constructors

        constructor +

        Implements

        Constructors

        constructor

        Accessors

        animate dimension element @@ -35,8 +36,8 @@ Initial SystemBase TransformData -Validators transformOrigins +Validators

        Methods

        get set subscribe @@ -44,10 +45,10 @@ update copyData duplicate -

        Constructors

        constructor

        Accessors

        animate

        Constructors

        constructor

        Accessors

        animate

        dimension

        • get dimension(): Readonly<{
              height: number | "auto" | "inherit";
              width: number | "auto" | "inherit";
          }>

        • Returns the dimension data for the readable store.

          Returns Readonly<{
              height: number | "auto" | "inherit";
              width: number | "auto" | "inherit";
          }>

          Dimension data.

          @@ -69,7 +70,7 @@

        Returns PositionParent

        The current position parent instance.

      • set parent(parent): void

      • Sets the associated TJSPositionTypes.PositionParent instance. Resets the style cache and default data.

        Parameters

        • parent: PositionParent

          A PositionParent instance or - undefined to disassociate

          +undefined to disassociate

        Returns void

        • rotateX

        • get rotateX(): number

        • Returns number

          rotateX

        • set rotateX(rotateX): void

        • Parameters

          • rotateX: number

          Returns void

        rotateY

        • get rotateY(): number

        • Returns number

          rotateY

        • set rotateY(rotateY): void

        • Parameters

          • rotateY: number

          Returns void

        rotateZ

        • get rotateZ(): number

        • Returns number

          rotateZ

          @@ -91,22 +92,22 @@

        Returns ValidatorAPI

        validators.

        width

        • get width(): number | "auto" | "inherit"

        • Returns number | "auto" | "inherit"

          width

        • set width(width): void

        • Parameters

          • width: number | "auto" | "inherit"

          Returns void

        zIndex

        • get zIndex(): number

        • Returns number

          z-index

          -
        • set zIndex(zIndex): void

        • Parameters

          • zIndex: number

          Returns void

        Static Animate

        Static Data

        Static Initial

        Static SystemBase

        Static TransformData

        • get TransformData(): TransformDataConstructor

        • Returns TJSTransformData class / constructor.

          +
        • set zIndex(zIndex): void

        • Parameters

          • zIndex: number

          Returns void

        StaticAnimate

        StaticData

        StaticInitial

        StaticSystemBase

        StaticTransformData

        Static Validators

        StatictransformOrigins

        StaticValidators

        Static transformOrigins

        Methods

        get

        • get(data?, options?): Partial<TJSPositionData>

        • Assigns current position data to given object data object. By default, null position data is not assigned. +

        Methods

        get

        • get(data?, options?): Partial<TJSPositionData>

        • Assigns current position data to given object data object. By default, null position data is not assigned. Other options allow configuration of the data assigned including setting default numeric values for any properties that are null.

          -

          Parameters

          • Optional data: object

            Target to assign current position data.

            -
          • Optional options: OptionsGet

            Defines options for specific keys and - substituting null for numeric default values. By default, nullable keys are included.

            +

            Parameters

            • Optionaldata: object

              Target to assign current position data.

              +
            • Optionaloptions: OptionsGet

              Defines options for specific keys and +substituting null for numeric default values. By default, nullable keys are included.

            Returns Partial<TJSPositionData>

            Passed in object with current position data.

        set

        subscribe

        update

        • update(updater): void

        • Provides the Writable store update method. Receive and return a TJSPositionData instance to update the position state. You may manipulate numeric properties by providing relative adjustments described in TJSPositionDataRelative.

          -

          Parameters

          Returns void

        Static copyData

        StaticcopyData

        • copyData(source, target?): TJSPositionData

        • Convenience to copy from source to target of two TJSPositionData like objects. If a target is not supplied a new TJSPositionData instance is created.

          Parameters

          • source: Partial<TJSPositionData>

            The source instance to copy from.

            -
          • Optional target: TJSPositionData

            Target TJSPositionData like object; if one is not - provided a new instance is created.

            +
          • Optionaltarget: TJSPositionData

            Target TJSPositionData like object; if one is not +provided a new instance is created.

          Returns TJSPositionData

          The target instance with all TJSPositionData fields.

          -

        Static duplicate

        • duplicate(position, options?): TJSPosition

        • Returns a duplicate of a given position instance copying any options and validators. The position parent is not +

        Staticduplicate

        Settings

        Member Visibility

        Theme

        On This Page

        constructoranimatedimensionelementelementUpdatedenabledheightleftmaxHeightmaxWidthminHeightminWidthparentrotateXrotateYrotateZrotationscalestatestorestoptransformtransformOrigintranslateXtranslateYtranslateZvalidatorswidthzIndexAnimateDataInitialSystemBaseTransformDataValidatorstransformOriginsgetsetsubscribetoJSONupdatecopyDataduplicate
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer.DynArrayReducer.html b/docs/classes/_runtime_svelte_store_reducer.DynArrayReducer.html index 41ad3519..5579fd46 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynArrayReducer.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynArrayReducer.html @@ -1,6 +1,17 @@ -DynArrayReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class DynArrayReducer<T>

        Provides a managed array with non-destructive reducing / filtering / sorting capabilities with subscription / +DynArrayReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class DynArrayReducer<T>

        Provides a managed array with non-destructive reducing / filtering / sorting capabilities with subscription / Svelte store support.

        -

        Type Parameters

        • T

        Hierarchy (view full)

        Constructors

        constructor +

        Type Parameters

        • T
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        data derived destroyed @@ -14,10 +25,10 @@ initialize setData subscribe -

        Constructors

        constructor

        • new DynArrayReducer<T>(data?): DynArrayReducer<T>

        • Initializes DynArrayReducer. Any iterable is supported for initial data. Take note that if data is an array it +

        Constructors

        constructor

        • new DynArrayReducer<T>(data?): DynArrayReducer<T>

        • Initializes DynArrayReducer. Any iterable is supported for initial data. Take note that if data is an array it will be used as the host array and not copied. All non-array iterables otherwise create a new array / copy.

          -

          Type Parameters

          • T

          Parameters

          Returns DynArrayReducer<T>

        Accessors

        data

        • get data(): T[]

        • Returns the internal data of this instance. Be careful!

          +

          Type Parameters

          • T

          Parameters

          Returns DynArrayReducer<T>

        Accessors

        data

        • get data(): T[]

        • Returns the internal data of this instance. Be careful!

          Note: if an array is set as initial data then that array is used as the internal data. If any changes are performed to the data externally do invoke update via DynArrayReducer.index with true to recalculate the index and notify all subscribers.

          @@ -33,17 +44,17 @@
        • set reversed(reversed): void

        • Sets reversed state and notifies subscribers.

          Parameters

          • reversed: boolean

            New reversed state.

          Returns void

        sort

        Methods

        [iterator]

        • [iterator](): IterableIterator<T>

        • Provides an iterator for data stored in DynArrayReducer.

          +

        Methods

        [iterator]

        destroy

        • destroy(): void

        • Removes all derived reducers, subscriptions, and cleans up all resources.

          -

          Returns void

        Protected initialize

        • initialize(): void
        • Protected

          Provides a callback for custom reducers to initialize any data / custom configuration. This allows +

          Yields

        destroy

        • destroy(): void

        • Removes all derived reducers, subscriptions, and cleans up all resources.

          +

          Returns void

        Protectedinitialize

        • initialize(): void
        • Protected

          Provides a callback for custom reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.

          Returns void

        setData

        • setData(data, replace?): void

        • Removes internal data and pushes new data. This does not destroy any initial array set to internal data unless replace is set to true.

          Parameters

          • data: Iterable<T> | T[]

            New data to set to internal data.

            -
          • Optional replace: boolean

            New data to set to internal data.

            +
          • Optionalreplace: boolean

            New data to set to internal data.

          Returns void

        subscribe

        • subscribe(handler): (() => void)

        • Add a subscriber to this DynArrayReducer instance.

          -

          Parameters

          • handler: ((value) => void)

            Callback function that is invoked on update / changes. - Receives this reference.

            +

            Parameters

            • handler: ((value: DynArrayReducer<T>) => void)

              Callback function that is invoked on update / changes. +Receives this reference.

            Returns (() => void)

            Unsubscribe function.

            -
              • (): void

              • Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructordataderiveddestroyedfiltersindexlengthreversedsort[iterator]destroyinitializesetDatasubscribe
        \ No newline at end of file +
          • (): void

          • Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer.DynArrayReducerDerived.html b/docs/classes/_runtime_svelte_store_reducer.DynArrayReducerDerived.html index 254ed448..44686020 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynArrayReducerDerived.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynArrayReducerDerived.html @@ -1,7 +1,8 @@ -DynArrayReducerDerived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class DynArrayReducerDerived<T>

        Provides the base implementation derived reducer for arrays / DynArrayReducer.

        +DynArrayReducerDerived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class DynArrayReducerDerived<T>

        Provides the base implementation derived reducer for arrays / DynArrayReducer.

        Note: That you should never directly create an instance of a derived reducer, but instead use the DynArrayReducerDerived.initialize callback to set up any initial state in a custom derived reducer.

        -

        Type Parameters

        • T

        Implements

        Constructors

        constructor +

        Type Parameters

        • T

        Implements

        Constructors

        constructor

        Accessors

        data derived destroyed @@ -14,10 +15,10 @@ destroy initialize subscribe -

        Constructors

        constructor

        Constructors

        constructor

        Accessors

        data

        • get data(): T[]

        • Returns the internal data of this instance. Be careful!

          +

        Returns DynArrayReducerDerived<T>

        Accessors

        data

        • get data(): T[]

        • Returns the internal data of this instance. Be careful!

          Note: if an array is set as initial data then that array is used as the internal data. If any changes are performed to the data externally do invoke IDynIndexerAPI.update with true to recalculate the index and notify all subscribers.

          @@ -32,11 +33,11 @@
        • set reversed(reversed): void

        • Sets reversed state and notifies subscribers.

          Parameters

          • reversed: boolean

            New reversed state.

          Returns void

        sort

        Methods

        [iterator]

        destroy

        • destroy(): void

        • Removes all derived reducers, subscriptions, and cleans up all resources.

          -

          Returns void

        Protected initialize

        • initialize(): void
        • Protected

          Provides a callback for custom derived reducers to initialize any data / custom configuration. This allows +

        Methods

        [iterator]

        destroy

        • destroy(): void

        • Removes all derived reducers, subscriptions, and cleans up all resources.

          +

          Returns void

        Protectedinitialize

        • initialize(): void
        • Protected

          Provides a callback for custom derived reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.

          Returns void

        subscribe

        • subscribe(handler): (() => void)

        • Subscribe to this DerivedArrayReducer.

          -

          Parameters

          • handler: ((value) => void)

            Callback function that is invoked on update / changes. Receives this reference.

            +

            Parameters

            Returns (() => void)

            Unsubscribe function.

            -
              • (): void

              • Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructordataderiveddestroyedfiltersindexlengthreversedsort[iterator]destroyinitializesubscribe
        \ No newline at end of file +
          • (): void

          • Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer.DynMapReducer.html b/docs/classes/_runtime_svelte_store_reducer.DynMapReducer.html index 663a8562..db37427f 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynMapReducer.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynMapReducer.html @@ -1,7 +1,8 @@ -DynMapReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class DynMapReducer<K, T>

        Provides a managed Map with non-destructive reducing / filtering / sorting capabilities with subscription / +DynMapReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class DynMapReducer<K, T>

        Provides a managed Map with non-destructive reducing / filtering / sorting capabilities with subscription / Svelte store support.

        -

        Template: K,

        T

        -

        Type Parameters

        • K
        • T

        Constructors

        constructor +

        Template: K,

        T

        +

        Type Parameters

        • K
        • T

        Constructors

        constructor

        Accessors

        data derived destroyed @@ -15,10 +16,10 @@ initialize setData subscribe -

        Constructors

        constructor

        • new DynMapReducer<K, T>(data?): DynMapReducer<K, T>

        • Initializes DynMapReducer. Any iterable is supported for initial data. Take note that if data is an array it +

        Constructors

        constructor

        • new DynMapReducer<K, T>(data?): DynMapReducer<K, T>

        • Initializes DynMapReducer. Any iterable is supported for initial data. Take note that if data is an array it will be used as the host array and not copied. All non-array iterables otherwise create a new array / copy.

          -

          Type Parameters

          • K
          • T

          Parameters

          • Optional data: Map<K, T> | DynMapData<K, T>

            Data iterable to store if array or copy otherwise.

            -

          Returns DynMapReducer<K, T>

        Accessors

        data

        • get data(): Map<K, T>

        • Returns the internal data of this instance. Be careful!

          +

          Type Parameters

          • K
          • T

          Parameters

          • Optionaldata: Map<K, T> | DynMapData<K, T>

            Data iterable to store if array or copy otherwise.

            +

          Returns DynMapReducer<K, T>

        Accessors

        data

        • get data(): Map<K, T>

        • Returns the internal data of this instance. Be careful!

          Note: When a map is set as data then that map is used as the internal data. If any changes are performed to the data externally do invoke update via DynMapReducer.index with true to recalculate the index and notify all subscribers.

          @@ -34,16 +35,16 @@
        • set reversed(reversed): void

        • Sets reversed state and notifies subscribers.

          Parameters

          • reversed: boolean

            New reversed state.

          Returns void

        sort

        Methods

        [iterator]

        destroy

        • destroy(): void

        • Removes all derived reducers, subscriptions, and cleans up all resources.

          -

          Returns void

        Protected initialize

        • initialize(): void
        • Protected

          Provides a callback for custom reducers to initialize any data / custom configuration. This allows +

        Methods

        [iterator]

        destroy

        • destroy(): void

        • Removes all derived reducers, subscriptions, and cleans up all resources.

          +

          Returns void

        Protectedinitialize

        • initialize(): void
        • Protected

          Provides a callback for custom reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.

          Returns void

        setData

        • setData(data, replace?): void

        • Removes internal data and pushes new data. This does not destroy any initial array set to internal data unless replace is set to true.

          Parameters

          • data: Map<K, T>

            New data to set to internal data.

            -
          • Optional replace: boolean

            New data to set to internal data.

            +
          • Optionalreplace: boolean

            New data to set to internal data.

          Returns void

        subscribe

        • subscribe(handler): (() => void)

        • Add a subscriber to this DynMapReducer instance.

          -

          Parameters

          • handler: ((value) => void)

            Callback function that is invoked on update / changes. - Receives this reference.

            +

            Parameters

            • handler: ((value: DynMapReducer<K, T>) => void)

              Callback function that is invoked on update / changes. +Receives this reference.

            Returns (() => void)

            Unsubscribe function.

            -
              • (): void

              • Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructordataderiveddestroyedfiltersindexlengthreversedsort[iterator]destroyinitializesetDatasubscribe
        \ No newline at end of file +
          • (): void

          • Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer.DynMapReducerDerived.html b/docs/classes/_runtime_svelte_store_reducer.DynMapReducerDerived.html index 7fa78e24..d1d2ece0 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynMapReducerDerived.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynMapReducerDerived.html @@ -1,8 +1,9 @@ -DynMapReducerDerived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class DynMapReducerDerived<K, T>

        Provides the base implementation derived reducer for Maps / DynMapReducer.

        +DynMapReducerDerived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class DynMapReducerDerived<K, T>

        Provides the base implementation derived reducer for Maps / DynMapReducer.

        Note: That you should never directly create an instance of a derived reducer, but instead use the DynMapReducerDerived.initialize callback to set up any initial state in a custom derived reducer.

        -

        Template: K,

        T

        -

        Type Parameters

        • K
        • T

        Implements

        Constructors

        constructor +

        Template: K,

        T

        +

        Type Parameters

        • K
        • T

        Implements

        Constructors

        constructor

        Accessors

        data derived destroyed @@ -15,10 +16,10 @@ destroy initialize subscribe -

        Constructors

        constructor

        Constructors

        constructor

        Accessors

        data

        • get data(): Map<K, T>

        • Returns the internal data of this instance. Be careful!

          +

        Returns DynMapReducerDerived<K, T>

        Accessors

        data

        • get data(): Map<K, T>

        • Returns the internal data of this instance. Be careful!

          Note: The returned map is the same map set by the main reducer. If any changes are performed to the data externally do invoke IDynIndexerAPI.update with true to recalculate the index and notify all subscribers.

          @@ -33,11 +34,11 @@
        • set reversed(reversed): void

        • Sets reversed state and notifies subscribers.

          Parameters

          • reversed: boolean

            New reversed state.

          Returns void

        sort

        Methods

        [iterator]

        destroy

        • destroy(): void

        • Removes all derived reducers, subscriptions, and cleans up all resources.

          -

          Returns void

        Protected initialize

        • initialize(): void
        • Protected

          Provides a callback for custom derived reducers to initialize any data / custom configuration. This allows +

        Methods

        [iterator]

        destroy

        • destroy(): void

        • Removes all derived reducers, subscriptions, and cleans up all resources.

          +

          Returns void

        Protectedinitialize

        • initialize(): void
        • Protected

          Provides a callback for custom derived reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.

          Returns void

        subscribe

        • subscribe(handler): (() => void)

        • Subscribe to this DerivedMapReducer.

          -

          Parameters

          • handler: ((value) => void)

            Callback function that is invoked on update / changes. Receives this reference.

            +

            Parameters

            Returns (() => void)

            Unsubscribe function.

            -
              • (): void

              • Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructordataderiveddestroyedfiltersindexlengthreversedsort[iterator]destroyinitializesubscribe
        \ No newline at end of file +
          • (): void

          • Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer.DynReducerHelper.html b/docs/classes/_runtime_svelte_store_reducer.DynReducerHelper.html index d2280728..d0f8ddbd 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynReducerHelper.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynReducerHelper.html @@ -1,13 +1,14 @@ -DynReducerHelper | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class DynReducerHelper

        Provides helper functions to create dynamic store driven filters and sort functions for dynamic reducers. The +DynReducerHelper | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class DynReducerHelper

        Provides helper functions to create dynamic store driven filters and sort functions for dynamic reducers. The returned functions are also Svelte stores and can be added to a reducer as well as used as a store.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        filters -

        Constructors

        constructor

        Accessors

        Static filters

        • get filters(): {
              regexObjectQuery: ((accessors, options?) => ((data) => boolean) & Writable<string>);
          }

        • Returns the following filter functions:

          +

        Constructors

        constructor

        Accessors

        Staticfilters

        • get filters(): {
              regexObjectQuery: ((accessors: string | Iterable<string>, options?: {
                  accessWarn?: boolean;
                  caseSensitive?: boolean;
                  store?: Writable<string>;
              }) => ((data: {}) => boolean) & Writable<string>);
          }

        • Returns the following filter functions:

          • regexObjectQuery(accessors, options); suitable for object reducers matching one or more property keys / accessors against the store value as a regex. To access deeper entries into the object format the accessor string with . between entries to walk. Optional parameters include logging access warnings, case sensitivity, and passing in an existing store.
          -

          Returns {
              regexObjectQuery: ((accessors, options?) => ((data) => boolean) & Writable<string>);
          }

          All available filters.

          -
          • regexObjectQuery: ((accessors, options?) => ((data) => boolean) & Writable<string>)
              • (accessors, options?): ((data) => boolean) & Writable<string>

              • Parameters

                • accessors: string | Iterable<string>
                • Optional options: {
                      accessWarn?: boolean;
                      caseSensitive?: boolean;
                      store?: Writable<string>;
                  }
                  • Optional accessWarn?: boolean
                  • Optional caseSensitive?: boolean
                  • Optional store?: Writable<string>

                Returns ((data) => boolean) & Writable<string>

        Settings

        Member Visibility

        Theme

        On This Page

        constructorfilters
        \ No newline at end of file +

        Returns {
            regexObjectQuery: ((accessors: string | Iterable<string>, options?: {
                accessWarn?: boolean;
                caseSensitive?: boolean;
                store?: Writable<string>;
            }) => ((data: {}) => boolean) & Writable<string>);
        }

        All available filters.

        +
        • regexObjectQuery: ((accessors: string | Iterable<string>, options?: {
              accessWarn?: boolean;
              caseSensitive?: boolean;
              store?: Writable<string>;
          }) => ((data: {}) => boolean) & Writable<string>)
            • (accessors, options?): ((data: {}) => boolean) & Writable<string>

            • Parameters

              • accessors: string | Iterable<string>
              • Optionaloptions: {
                    accessWarn?: boolean;
                    caseSensitive?: boolean;
                    store?: Writable<string>;
                }
                • OptionalaccessWarn?: boolean
                • OptionalcaseSensitive?: boolean
                • Optionalstore?: Writable<string>

              Returns ((data: {}) => boolean) & Writable<string>

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer_array_object.ArrayObjectStore.html b/docs/classes/_runtime_svelte_store_reducer_array_object.ArrayObjectStore.html index e7d88329..7aa4cddd 100644 --- a/docs/classes/_runtime_svelte_store_reducer_array_object.ArrayObjectStore.html +++ b/docs/classes/_runtime_svelte_store_reducer_array_object.ArrayObjectStore.html @@ -1,4 +1,15 @@ -ArrayObjectStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class ArrayObjectStore<T>

        Type Parameters

        Hierarchy (view full)

        Constructors

        constructor +ArrayObjectStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class ArrayObjectStore<T>

        Type Parameters

        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        _data dataReducer length @@ -14,14 +25,14 @@ subscribe toJSON updateSubscribers -

        Constructors

        constructor

        Accessors

        Protected _data

        • get _data(): T[]
        • Protected

          Returns T[]

          The internal data array tracked allowing child classes direct access.

          +

        Constructors

        constructor

        Accessors

        Protected_data

        • get _data(): T[]
        • Protected

          Returns T[]

          The internal data array tracked allowing child classes direct access.

        dataReducer

        length

        • get length(): number

        • Returns number

          The length of all data.

          -

        Static EntryStore

        Methods

        [iterator]

        • [iterator](): Generator<T, void, unknown>

        • Provide an iterator for public access to entry stores.

          -

          Returns Generator<T, void, unknown>

          Yields

        clearEntries

        • clearEntries(): void

        • Removes all child store entries.

          +

        StaticEntryStore

        Methods

        [iterator]

        • [iterator](): Generator<T, void, unknown>

        • Provide an iterator for public access to entry stores.

          +

          Returns Generator<T, void, unknown>

          Yields

        clearEntries

        • clearEntries(): void

        • Removes all child store entries.

          Returns void

        createEntry

        • createEntry(entryData?): T

        • Creates a new store from given data.

          -

          Parameters

          • Optional entryData: object

          Returns T

          The store

          +

        Parameters

        • OptionalentryData: object

        Returns T

        The store

        deleteEntry

        • deleteEntry(id): boolean

        • Deletes a given entry store by ID from this world setting array store instance.

          Parameters

          • id: string

            ID of entry to delete.

          Returns boolean

          Delete operation successful.

          @@ -29,7 +40,7 @@

        Parameters

        • id: string

          UUIDv4 string.

        Returns any

        Instance of StoreClass.

        findEntry

        • findEntry(predicate): void | T

        • Find an entry in the backing child store array.

          -

          Parameters

          • predicate: ((arg0) => void | T)

            A predicate function

            +

            Parameters

            • predicate: ((arg0: T) => void | T)

              A predicate function

                • (arg0): void | T

                • Parameters

                  • arg0: T

                  Returns void | T

            Returns void | T

            Found entry in array or undefined.

        getEntry

        • getEntry(id): void | T

        • Finds an entry store instance by 'id' / UUIDv4.

          Parameters

          • id: string

            A UUIDv4 string.

            @@ -39,4 +50,4 @@

            Parameters

            • updateList: T[]

            Returns void

        subscribe

        toJSON

        • toJSON(): T[]

        • Returns T[]

        updateSubscribers

        • updateSubscribers(update?): void

        • Updates subscribers.

          -

          Parameters

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_datadataReducerlengthEntryStore[iterator]clearEntriescreateEntrydeleteEntryduplicateEntryfindEntrygetEntrysetsubscribetoJSONupdateSubscribers
        \ No newline at end of file +

        Parameters

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStore.html b/docs/classes/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStore.html index 37f2830f..fab57bc0 100644 --- a/docs/classes/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStore.html +++ b/docs/classes/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStore.html @@ -1,4 +1,15 @@ -CrudArrayObjectStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class CrudArrayObjectStore<T>

        Type Parameters

        Hierarchy (view full)

        Constructors

        constructor +CrudArrayObjectStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class CrudArrayObjectStore<T>

        Type Parameters

        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Accessors

        _data dataReducer length @@ -14,16 +25,16 @@ subscribe toJSON updateSubscribers -

        Constructors

        constructor

        Accessors

        Protected _data

        • get _data(): T[]
        • Protected

          Returns T[]

          The internal data array tracked allowing child classes direct access.

          +

        Constructors

        constructor

        Accessors

        Protected_data

        • get _data(): T[]
        • Protected

          Returns T[]

          The internal data array tracked allowing child classes direct access.

        dataReducer

        length

        • get length(): number

        • Returns number

          The length of all data.

          -

        Static EntryStore

        Methods

        [iterator]

        clearEntries

        • clearEntries(): void

        • Removes all child store entries.

          +

        StaticEntryStore

        Methods

        [iterator]

        clearEntries

        createEntry

        • createEntry(entryData?): T

        • Creates a new store from given data.

          -

          Parameters

          • Optional entryData: object

          Returns T

          The store

          +

        Parameters

        • OptionalentryData: object

        Returns T

        The store

        deleteEntry

        • deleteEntry(id): boolean

        • Deletes a given entry store by ID from this world setting array store instance.

          Parameters

          • id: string

            ID of entry to delete.

          Returns boolean

          Delete operation successful.

          @@ -31,7 +42,7 @@

        Parameters

        • id: string

          UUIDv4 string.

        Returns any

        Instance of StoreClass.

        findEntry

        • findEntry(predicate): void | T

        • Find an entry in the backing child store array.

          -

          Parameters

          • predicate: ((arg0) => void | T)

            A predicate function

            +

            Parameters

            • predicate: ((arg0: T) => void | T)

              A predicate function

                • (arg0): void | T

                • Parameters

                  • arg0: T

                  Returns void | T

            Returns void | T

            Found entry in array or undefined.

        getEntry

        • getEntry(id): void | T

        • Finds an entry store instance by 'id' / UUIDv4.

          Parameters

          • id: string

            A UUIDv4 string.

            @@ -41,4 +52,4 @@

            Parameters

            • updateList: T[]

            Returns void

        subscribe

        toJSON

        updateSubscribers

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_datadataReducerlengthEntryStore[iterator]clearEntriescreateEntrydeleteEntryduplicateEntryfindEntrygetEntrysetsubscribetoJSONupdateSubscribers
        \ No newline at end of file +

        Parameters

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_reducer_array_object.ObjectEntryStore.html b/docs/classes/_runtime_svelte_store_reducer_array_object.ObjectEntryStore.html index 69d82302..a13bbe80 100644 --- a/docs/classes/_runtime_svelte_store_reducer_array_object.ObjectEntryStore.html +++ b/docs/classes/_runtime_svelte_store_reducer_array_object.ObjectEntryStore.html @@ -1,18 +1,19 @@ -ObjectEntryStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class ObjectEntryStore

        Provides a base implementation for store entries in ArrayObjectStore.

        +ObjectEntryStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class ObjectEntryStore

        Provides a base implementation for store entries in ArrayObjectStore.

        In particular providing the required getting / accessor for the 'id' property.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        _data id

        Methods

        _updateSubscribers subscribe toJSON duplicate -

        Constructors

        constructor

        Accessors

        Protected _data

        • get _data(): any
        • Protected

          Returns any

          The object data tracked by this store.

          +

        Constructors

        constructor

        Accessors

        Protected_data

        • get _data(): any
        • Protected

          Returns any

          The object data tracked by this store.

        id

        • get id(): string

        • Returns string

          The ID attribute in object data tracked by this store.

          -

        Methods

        Protected _updateSubscribers

        • _updateSubscribers(): void
        • Protected

          Returns void

        subscribe

        • subscribe(handler): Unsubscriber

        • Parameters

          • handler: Subscriber<object>

            Callback function that is invoked on update / - changes.

            +

        Methods

        Protected_updateSubscribers

        • _updateSubscribers(): void
        • Protected

          Returns void

        subscribe

        toJSON

        • toJSON(): any

        • Returns any

        Static duplicate

        • duplicate(data, arrayStore): void

        • Invoked by ArrayObjectStore to provide custom duplication. Override this static method in your entry store.

          +

        toJSON

        • toJSON(): any

        • Returns any

        Staticduplicate

        • duplicate(data, arrayStore): void

        • Invoked by ArrayObjectStore to provide custom duplication. Override this static method in your entry store.

          Parameters

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructor_dataid_updateSubscriberssubscribetoJSONduplicate
        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web_storage.TJSLocalStorage.html b/docs/classes/_runtime_svelte_store_web_storage.TJSLocalStorage.html index b9826a81..d7a46461 100644 --- a/docs/classes/_runtime_svelte_store_web_storage.TJSLocalStorage.html +++ b/docs/classes/_runtime_svelte_store_web_storage.TJSLocalStorage.html @@ -1,5 +1,16 @@ -TJSLocalStorage | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSLocalStorage

        Provides a TJSWebStorage instance for standard browser local storage use cases.

        -

        Hierarchy (view full)

        Constructors

        constructor +TJSLocalStorage | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class TJSLocalStorage

        Provides a TJSWebStorage instance for standard browser local storage use cases.

        +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Methods

        entries getItem getStore @@ -7,28 +18,28 @@ setItem stores swapItemBoolean -

        Constructors

        constructor

        Methods

        entries

        Constructors

        constructor

        Methods

        entries

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          +

          Yields

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: any

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: any

            A default value to return if key not present in session storage.

          Returns any

          Value from session storage or if not defined any default value provided.

        getStore

        • getStore<T>(key, defaultValue?, storageStores?): Writable<T>

        • Returns the backing Svelte store for the given key; potentially sets a default value if the key is not already set.

          Type Parameters

          • T

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: T

            A default value to return if key not present in session storage.

            -
          • Optional storageStores: StorageStores

            Additional store creation options.

            +
          • OptionaldefaultValue: T

            A default value to return if key not present in session storage.

            +
          • OptionalstorageStores: StorageStores

            Additional store creation options.

          Returns Writable<T>

          The Svelte store for this key.

        keys

        • keys(regex?): IterableIterator<string>

        • Returns an iterable for the session storage keys from existing stores.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter by storage keys.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter by storage keys.

            Returns IterableIterator<string>

            Iterable iterator of session storage keys.

            -

            Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          +

          Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

          • value: any

            A value to set for this key.

            -

          Returns void

        stores

        stores

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          +

          Yields

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: boolean

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: boolean

            A default value to return if key not present in session storage.

          Returns boolean

          The boolean swap for the given key.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorentriesgetItemgetStorekeyssetItemstoresswapItemBoolean
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web_storage.TJSSessionStorage.html b/docs/classes/_runtime_svelte_store_web_storage.TJSSessionStorage.html index 0c7a4d7d..e722bc33 100644 --- a/docs/classes/_runtime_svelte_store_web_storage.TJSSessionStorage.html +++ b/docs/classes/_runtime_svelte_store_web_storage.TJSSessionStorage.html @@ -1,5 +1,16 @@ -TJSSessionStorage | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSSessionStorage

        Provides a TJSWebStorage instance for standard browser session storage use cases.

        -

        Hierarchy (view full)

        Constructors

        constructor +TJSSessionStorage | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class TJSSessionStorage

        Provides a TJSWebStorage instance for standard browser session storage use cases.

        +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Methods

        entries getItem getStore @@ -7,28 +18,28 @@ setItem stores swapItemBoolean -

        Constructors

        constructor

        Methods

        entries

        Constructors

        constructor

        Methods

        entries

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          +

          Yields

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: any

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: any

            A default value to return if key not present in session storage.

          Returns any

          Value from session storage or if not defined any default value provided.

        getStore

        • getStore<T>(key, defaultValue?, storageStores?): Writable<T>

        • Returns the backing Svelte store for the given key; potentially sets a default value if the key is not already set.

          Type Parameters

          • T

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: T

            A default value to return if key not present in session storage.

            -
          • Optional storageStores: StorageStores

            Additional store creation options.

            +
          • OptionaldefaultValue: T

            A default value to return if key not present in session storage.

            +
          • OptionalstorageStores: StorageStores

            Additional store creation options.

          Returns Writable<T>

          The Svelte store for this key.

        keys

        • keys(regex?): IterableIterator<string>

        • Returns an iterable for the session storage keys from existing stores.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter by storage keys.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter by storage keys.

            Returns IterableIterator<string>

            Iterable iterator of session storage keys.

            -

            Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          +

          Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

          • value: any

            A value to set for this key.

            -

          Returns void

        stores

        stores

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          +

          Yields

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: boolean

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: boolean

            A default value to return if key not present in session storage.

          Returns boolean

          The boolean swap for the given key.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorentriesgetItemgetStorekeyssetItemstoresswapItemBoolean
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web_storage.TJSWebStorage.html b/docs/classes/_runtime_svelte_store_web_storage.TJSWebStorage.html index 8880946f..6d7ac452 100644 --- a/docs/classes/_runtime_svelte_store_web_storage.TJSWebStorage.html +++ b/docs/classes/_runtime_svelte_store_web_storage.TJSWebStorage.html @@ -1,8 +1,19 @@ -TJSWebStorage | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSWebStorage

        Provides the base Storage API store manager. It is recommended to use TJSLocalStorage & +TJSWebStorage | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class TJSWebStorage

        Provides the base Storage API store manager. It is recommended to use TJSLocalStorage & TJSSessionStorage for standard browser local and session storage use cases. TJSWebStorage exists to provide additional customization options for custom Storage API compatible storage instances and custom serialization configuration.

        -

        Hierarchy (view full)

        Constructors

        constructor +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Methods

        entries getItem getStore @@ -10,30 +21,30 @@ setItem stores swapItemBoolean -

        Constructors

        constructor

        • new TJSWebStorage(storageStores): TJSWebStorage

        • Parameters

          • storageStores: StorageStores

            Provides a complete set of - storage API store helper functions and the associated storage API instance and serializations strategy.

            -

          Returns TJSWebStorage

        Methods

        entries

        Constructors

        constructor

        • new TJSWebStorage(storageStores): TJSWebStorage

        • Parameters

          • storageStores: StorageStores

            Provides a complete set of +storage API store helper functions and the associated storage API instance and serializations strategy.

            +

          Returns TJSWebStorage

        Methods

        entries

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          +

          Yields

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: any

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: any

            A default value to return if key not present in session storage.

          Returns any

          Value from session storage or if not defined any default value provided.

        getStore

        • getStore<T>(key, defaultValue?, storageStores?): Writable<T>

        • Returns the backing Svelte store for the given key; potentially sets a default value if the key is not already set.

          Type Parameters

          • T

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: T

            A default value to return if key not present in session storage.

            -
          • Optional storageStores: StorageStores

            Additional store creation options.

            +
          • OptionaldefaultValue: T

            A default value to return if key not present in session storage.

            +
          • OptionalstorageStores: StorageStores

            Additional store creation options.

          Returns Writable<T>

          The Svelte store for this key.

        keys

        • keys(regex?): IterableIterator<string>

        • Returns an iterable for the session storage keys from existing stores.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter by storage keys.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter by storage keys.

            Returns IterableIterator<string>

            Iterable iterator of session storage keys.

            -

            Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          +

          Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

          • value: any

            A value to set for this key.

            -

          Returns void

        stores

        stores

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          +

          Yields

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: boolean

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: boolean

            A default value to return if key not present in session storage.

          Returns boolean

          The boolean swap for the given key.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorentriesgetItemgetStorekeyssetItemstoresswapItemBoolean
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSLocalStorageBCMP.html b/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSLocalStorageBCMP.html index f23d5ff2..f27948aa 100644 --- a/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSLocalStorageBCMP.html +++ b/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSLocalStorageBCMP.html @@ -1,5 +1,16 @@ -TJSLocalStorageBCMP | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSLocalStorageBCMP

        Provides a TJSWebStorage instance for browser local storage using compressed MessagePack to base64.

        -

        Hierarchy (view full)

        Constructors

        constructor +TJSLocalStorageBCMP | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class TJSLocalStorageBCMP

        Provides a TJSWebStorage instance for browser local storage using compressed MessagePack to base64.

        +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Methods

        entries getItem getStore @@ -7,28 +18,28 @@ setItem stores swapItemBoolean -

        Constructors

        constructor

        Methods

        entries

        Constructors

        constructor

        Methods

        entries

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          +

          Yields

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: any

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: any

            A default value to return if key not present in session storage.

          Returns any

          Value from session storage or if not defined any default value provided.

        getStore

        • getStore<T>(key, defaultValue?, storageStores?): Writable<T>

        • Returns the backing Svelte store for the given key; potentially sets a default value if the key is not already set.

          Type Parameters

          • T

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: T

            A default value to return if key not present in session storage.

            -
          • Optional storageStores: StorageStores

            Additional store creation options.

            +
          • OptionaldefaultValue: T

            A default value to return if key not present in session storage.

            +
          • OptionalstorageStores: StorageStores

            Additional store creation options.

          Returns Writable<T>

          The Svelte store for this key.

        keys

        • keys(regex?): IterableIterator<string>

        • Returns an iterable for the session storage keys from existing stores.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter by storage keys.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter by storage keys.

            Returns IterableIterator<string>

            Iterable iterator of session storage keys.

            -

            Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          +

          Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

          • value: any

            A value to set for this key.

            -

          Returns void

        stores

        stores

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          +

          Yields

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: boolean

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: boolean

            A default value to return if key not present in session storage.

          Returns boolean

          The boolean swap for the given key.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorentriesgetItemgetStorekeyssetItemstoresswapItemBoolean
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSSessionStorageBCMP.html b/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSSessionStorageBCMP.html index 469a2200..413561d3 100644 --- a/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSSessionStorageBCMP.html +++ b/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSSessionStorageBCMP.html @@ -1,5 +1,16 @@ -TJSSessionStorageBCMP | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSSessionStorageBCMP

        Provides a TJSWebStorage instance for browser session storage using compressed MessagePack to base64.

        -

        Hierarchy (view full)

        Constructors

        constructor +TJSSessionStorageBCMP | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class TJSSessionStorageBCMP

        Provides a TJSWebStorage instance for browser session storage using compressed MessagePack to base64.

        +
        +
        + +
        + + Hierarchy
        +         +
        +
        +
        +

        Constructors

        constructor

        Methods

        entries getItem getStore @@ -7,28 +18,28 @@ setItem stores swapItemBoolean -

        Constructors

        constructor

        Methods

        entries

        Constructors

        constructor

        Methods

        entries

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          +

          Yields

        getItem

        • getItem(key, defaultValue?): any

        • Get value from the storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: any

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: any

            A default value to return if key not present in session storage.

          Returns any

          Value from session storage or if not defined any default value provided.

        getStore

        • getStore<T>(key, defaultValue?, storageStores?): Writable<T>

        • Returns the backing Svelte store for the given key; potentially sets a default value if the key is not already set.

          Type Parameters

          • T

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: T

            A default value to return if key not present in session storage.

            -
          • Optional storageStores: StorageStores

            Additional store creation options.

            +
          • OptionaldefaultValue: T

            A default value to return if key not present in session storage.

            +
          • OptionalstorageStores: StorageStores

            Additional store creation options.

          Returns Writable<T>

          The Svelte store for this key.

        keys

        • keys(regex?): IterableIterator<string>

        • Returns an iterable for the session storage keys from existing stores.

          -

          Parameters

          • Optional regex: RegExp

            Optional regular expression to filter by storage keys.

            +

            Parameters

            • Optionalregex: RegExp

              Optional regular expression to filter by storage keys.

            Returns IterableIterator<string>

            Iterable iterator of session storage keys.

            -

            Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          +

          Yields

        setItem

        • setItem(key, value): void

        • Sets the value for the given key in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

          • value: any

            A value to set for this key.

            -

          Returns void

        stores

        stores

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          +

          Yields

        swapItemBoolean

        • swapItemBoolean(key, defaultValue?): boolean

        • Convenience method to swap a boolean value stored in storage API.

          Parameters

          • key: string

            Key to lookup in storage API.

            -
          • Optional defaultValue: boolean

            A default value to return if key not present in session storage.

            +
          • OptionaldefaultValue: boolean

            A default value to return if key not present in session storage.

          Returns boolean

          The boolean swap for the given key.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorentriesgetItemgetStorekeyssetItemstoresswapItemBoolean
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_util.TJSSvelteConfigUtil.html b/docs/classes/_runtime_svelte_util.TJSSvelteConfigUtil.html index 1545b8b8..1f09227f 100644 --- a/docs/classes/_runtime_svelte_util.TJSSvelteConfigUtil.html +++ b/docs/classes/_runtime_svelte_util.TJSSvelteConfigUtil.html @@ -1,16 +1,17 @@ -TJSSvelteConfigUtil | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSSvelteConfigUtil

        Provides utilities to verify and parse TJSSvelteConfig configuration objects.

        -

        Constructors

        constructor +TJSSvelteConfigUtil | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class TJSSvelteConfigUtil

        Provides utilities to verify and parse TJSSvelteConfig configuration objects.

        +

        Constructors

        constructor

        Methods

        isConfig parseConfig -

        Constructors

        constructor

        Methods

        Static isConfig

        Constructors

        constructor

        Methods

        StaticisConfig

        • isConfig(config, options?): config is TJSSvelteConfig

        • Validates config argument whether it is a valid TJSSvelteConfig.

          Parameters

          • config: unknown

            The potential config object to validate.

            -
          • Optional options: {
                raiseException?: boolean;
            }

            Options.

            -
            • Optional raiseException?: boolean

              If validation fails raise an exception.

              +
            • Optionaloptions: {
                  raiseException?: boolean;
              }

              Options.

              +
              • OptionalraiseException?: boolean

                If validation fails raise an exception.

          Returns config is TJSSvelteConfig

          Is the config a valid TJSSvelteConfig.

          -

          Throws

          Any validation error when raiseException is enabled.

          -

        Static parseConfig

        • parseConfig(config, thisArg?): TJSSvelteConfig

        • Parses a TyphonJS Svelte config object ensuring that classes specified are Svelte components and props are set +

          Throws

          Any validation error when raiseException is enabled.

          +

        StaticparseConfig

        • parseConfig(config, thisArg?): TJSSvelteConfig

        • Parses a TyphonJS Svelte config object ensuring that classes specified are Svelte components and props are set correctly.

          Parameters

          • config: TJSSvelteConfig

            Svelte config object.

            -
          • Optional thisArg: any

            This reference to set for invoking any props function.

            +
          • OptionalthisArg: any

            This reference to set for invoking any props function.

          Returns TJSSvelteConfig

          The processed Svelte config object.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorisConfigparseConfig
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_util.TJSSvelteUtil.html b/docs/classes/_runtime_svelte_util.TJSSvelteUtil.html index 7005d63f..59447384 100644 --- a/docs/classes/_runtime_svelte_util.TJSSvelteUtil.html +++ b/docs/classes/_runtime_svelte_util.TJSSvelteUtil.html @@ -1,16 +1,17 @@ -TJSSvelteUtil | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSSvelteUtil

        Various utilities to duck type / detect Svelte components and run outro transition while destroying a component +TJSSvelteUtil | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class TJSSvelteUtil

        Various utilities to duck type / detect Svelte components and run outro transition while destroying a component externally.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Methods

        isComponent isHMRProxy outroAndDestroy -

        Constructors

        constructor

        Methods

        Static isComponent

        • isComponent(comp): boolean

        • Provides basic duck typing to determine if the provided function is a constructor function for a Svelte component.

          +

        Constructors

        constructor

        Methods

        StaticisComponent

        • isComponent(comp): boolean

        • Provides basic duck typing to determine if the provided function is a constructor function for a Svelte component.

          Parameters

          • comp: unknown

            Data to check as a Svelte component.

          Returns boolean

          Whether basic duck typing succeeds.

          -

        Static isHMRProxy

        • isHMRProxy(comp): boolean

        • Provides basic duck typing to determine if the provided object is a HMR ProxyComponent instance or class.

          +

        StaticisHMRProxy

        • isHMRProxy(comp): boolean

        • Provides basic duck typing to determine if the provided object is a HMR ProxyComponent instance or class.

          Parameters

          • comp: unknown

            Data to check as a HMR proxy component.

          Returns boolean

          Whether basic duck typing succeeds.

          -

        Static outroAndDestroy

        StaticoutroAndDestroy

        Settings

        Member Visibility

        Theme

        On This Page

        constructorisComponentisHMRProxyoutroAndDestroy
        \ No newline at end of file +

        Returns Promise<any>

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_util.Hashing.html b/docs/classes/_runtime_util.Hashing.html index d9f5789c..94e86cd4 100644 --- a/docs/classes/_runtime_util.Hashing.html +++ b/docs/classes/_runtime_util.Hashing.html @@ -1,19 +1,22 @@ -Hashing | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class Hashing

        Constructors

        constructor +Hashing | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class Hashing

        Provides various utilities for generating hash codes for strings and UUIDs.

        +

        This class should not be constructed as it only contains static methods.

        +

        Constructors

        constructor

        Methods

        hashCode isUuidv4 uuidv4 -

        Constructors

        constructor

        Methods

        Static hashCode

        Constructors

        constructor

        Methods

        StatichashCode

        • hashCode(str, seed?): number

        • Provides a solid string hashing algorithm.

          +

          Sourced from: https://stackoverflow.com/a/52171480

          Parameters

          • str: string

            String to hash.

            -
          • Optional seed: number

            A seed value altering the hash.

            +
          • Optionalseed: number

            A seed value altering the hash.

          Returns number

          Hash code.

          -

        Static isUuidv4

        • isUuidv4(uuid): boolean

        • Validates that the given string is formatted as a UUIDv4 string.

          +

        StaticisUuidv4

        • isUuidv4(uuid): boolean

        • Validates that the given string is formatted as a UUIDv4 string.

          Parameters

          • uuid: string

            UUID string to test.

          Returns boolean

          Is UUIDv4 string.

          -

        Static uuidv4

        • uuidv4(): string

        • Generates a UUID v4 compliant ID. Please use a complete UUID generation package for guaranteed compliance.

          +

        Staticuuidv4

        Settings

        Member Visibility

        Theme

        On This Page

        constructorhashCodeisUuidv4uuidv4
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_util.Strings.html b/docs/classes/_runtime_util.Strings.html index 996a6e38..a2dffa63 100644 --- a/docs/classes/_runtime_util.Strings.html +++ b/docs/classes/_runtime_util.Strings.html @@ -1,12 +1,14 @@ -Strings | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class Strings

        Provides utility functions for strings.

        -

        Constructors

        constructor +Strings | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class Strings

        Provides utility functions for strings.

        +

        This class should not be constructed as it only contains static methods.

        +

        Constructors

        constructor

        Methods

        escape normalize -

        Constructors

        constructor

        Methods

        Static escape

        • escape(string): string

        • Escape a given input string prefacing special characters with backslashes for use in a regular expression.

          +

        Constructors

        constructor

        Methods

        Staticescape

        • escape(string): string

        • Escape a given input string prefacing special characters with backslashes for use in a regular expression.

          Parameters

          • string: string

            An un-escaped input string.

          Returns string

          The escaped string suitable for use in a regular expression.

          -

        Static normalize

        • normalize(string): string

        • Normalizes a string.

          +

        Staticnormalize

        Settings

        Member Visibility

        Theme

        On This Page

        constructorescapenormalize
        \ No newline at end of file +

        See

        https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize

        +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_util.Timing.html b/docs/classes/_runtime_util.Timing.html index e1ccf039..12e2f45f 100644 --- a/docs/classes/_runtime_util.Timing.html +++ b/docs/classes/_runtime_util.Timing.html @@ -1,15 +1,29 @@ -Timing | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class Timing

        Provides timing related higher-order functions.

        -

        Constructors

        constructor +Timing | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class Timing

        Provides timing related higher-order functions.

        +

        This class should not be constructed as it only contains static methods.

        +

        Constructors

        constructor

        Methods

        debounce doubleClick -

        Constructors

        constructor

        Methods

        Static debounce

        • debounce(callback, delay): Function

        • Wraps a callback in a debounced timeout.

          -

          Delay execution of the callback function until the function has not been called for the given delay in milliseconds.

          -

          Parameters

          • callback: Function

            A function to execute once the debounced threshold has been passed.

            -
          • delay: number

            An amount of time in milliseconds to delay.

            -

          Returns Function

          A wrapped function that can be called to debounce execution.

          -

        Static doubleClick

        • doubleClick(opts): ((event) => void)

        • Parameters

          • opts: {
                delay?: number;
                double: Function;
                single: Function;
            }

            Optional parameters.

            -
            • Optional delay?: number

              Double click delay.

              -
            • double: Function

              Double click callback.

              -
            • single: Function

              Single click callback.

              -

          Returns ((event) => void)

          The gated double-click handler.

          -
            • (event): void

            • Parameters

              Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructordebouncedoubleClick
        \ No newline at end of file +

        Constructors

        constructor

        Methods

        Staticdebounce

        • debounce<Args>(callback, delay): ((...args: Args[]) => void)

        • Wraps a callback in a debounced timeout. Delay execution of the callback function until the function has not been +called for the given delay in milliseconds.

          +

          Type Parameters

          • Args

          Parameters

          • callback: ((...args: Args[]) => void)

            A function to execute once the debounced threshold has been passed.

            +
              • (...args): void

              • Parameters

                Returns void

          • delay: number

            An amount of time in milliseconds to delay.

            +

          Returns ((...args: Args[]) => void)

          A wrapped function that can be called to debounce execution.

          +
            • (...args): void

            • Parameters

              Returns void

          Example

          /**
           * Debounce the update invocation by 500ms.
           */
          const updateDebounced = Timing.debounce(() => doc.update(), 500);

          // Use the function like:
          updateDebounced();
+
          + +

          Example

          /**
           * Debounce the update invocation by 500ms.
           *
           * @param {string} value - A value to update.
           */
          const updateDebounced = Timing.debounce((value) => doc.update(value), 500);

          // Use the function like:
          updateDebounced('new value');
+
          + +

        StaticdoubleClick

        • doubleClick(opts): ((event: Event) => void)

        • Creates a double click event handler that distinguishes between single and double clicks. Calls the single +callback on a single click and the double callback on a double click. The default double click delay to invoke +the double callback is 400 milliseconds.

          +

          Parameters

          • opts: {
                delay?: number;
                double?: ((event: Event) => void);
                single?: ((event: Event) => void);
            }

            Optional parameters.

            +
            • Optionaldelay?: number

              Double click delay.

              +
            • Optionaldouble?: ((event: Event) => void)

              Double click callback.

              +
                • (event): void

                • Parameters

                  Returns void

            • Optionalsingle?: ((event: Event) => void)

              Single click callback.

              +
                • (event): void

                • Parameters

                  Returns void

          Returns ((event: Event) => void)

          The gated double-click handler.

          +
            • (event): void

            • Parameters

              Returns void

          Example

          // Given a button element.
          button.addEventListener('click', Timing.doubleClick({
             single: (event) => console.log('Single click: ', event),
             double: (event) => console.log('Double click: ', event)
          });
+
          + +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_util_async.ManagedPromise.html b/docs/classes/_runtime_util_async.ManagedPromise.html index 9afe2363..64416755 100644 --- a/docs/classes/_runtime_util_async.ManagedPromise.html +++ b/docs/classes/_runtime_util_async.ManagedPromise.html @@ -1,8 +1,9 @@ -ManagedPromise | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class ManagedPromise

        Provides management of a single Promise that can be shared and accessed across JS & Svelte components. This allows a +ManagedPromise | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class ManagedPromise

        Provides management of a single Promise that can be shared and accessed across JS & Svelte components. This allows a Promise to be created and managed as part of the TRL application lifecycle and accessed safely in various control flow scenarios. When resolution of the current managed Promise starts further interaction is prevented.

        Note: to enable debugging / log statements set the static logging variable to true.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        isActive isProcessing logging @@ -10,21 +11,21 @@ get reject resolve -

        Constructors

        constructor

        Accessors

        isActive

        • get isActive(): boolean

        • Returns boolean

          Whether there is an active managed Promise.

          +

        Constructors

        constructor

        Accessors

        isActive

        • get isActive(): boolean

        • Returns boolean

          Whether there is an active managed Promise.

        isProcessing

        • get isProcessing(): boolean

        • Returns boolean

          Whether there is an active managed Promise and resolution is currently being processed.

          -

        Static logging

        • get logging(): boolean

        • Returns boolean

          Whether global logging is enabled.

          +

        Staticlogging

        • get logging(): boolean

        • Returns boolean

          Whether global logging is enabled.

        • set logging(logging): void

        • Sets global logging enabled state.

          Parameters

          • logging: boolean

            New logging enabled state.

            -

          Returns void

        Methods

        create

        • create<T>(opts?): Promise<T>

        • Resolves any current Promise with undefined and creates a new current Promise.

          -

          Type Parameters

          • T

          Parameters

          • Optional opts: {
                reuse?: boolean;
            }

            Options.

            -
            • Optional reuse?: boolean

              When true if there is an existing live Promise it is returned immediately.

              +

          Returns void

        Methods

        create

        • create<T>(opts?): Promise<T>

        • Resolves any current Promise with undefined and creates a new current Promise.

          +

          Type Parameters

          • T

          Parameters

          • Optionalopts: {
                reuse?: boolean;
            }

            Options.

            +
            • Optionalreuse?: boolean

              When true if there is an existing live Promise it is returned immediately.

          Returns Promise<T>

          The new current managed Promise.

        get

        • get(): Promise<any>

        • Gets the current Promise if any.

          Returns Promise<any>

          Current Promise.

        reject

        • reject(result?): boolean

        • Rejects the current Promise if applicable.

          -

          Parameters

          • Optional result: any

            Result to reject.

            +

            Parameters

            • Optionalresult: any

              Result to reject.

            Returns boolean

            Was the promise rejected.

        resolve

        • resolve(result?): boolean

        • Resolves the current Promise if applicable.

          -

          Parameters

          • Optional result: any

            Result to resolve.

            +

            Parameters

            • Optionalresult: any

              Result to resolve.

            Returns boolean

            Was the promise resolved.

            -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorisActiveisProcessingloggingcreategetrejectresolve
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_util_browser.A11yHelper.html b/docs/classes/_runtime_util_browser.A11yHelper.html index c05c7da4..e2f9ed90 100644 --- a/docs/classes/_runtime_util_browser.A11yHelper.html +++ b/docs/classes/_runtime_util_browser.A11yHelper.html @@ -1,22 +1,23 @@ -A11yHelper | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class A11yHelper

        Provides several helpful utility methods for accessibility and keyboard navigation.

        +A11yHelper | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class A11yHelper

        Provides several helpful utility methods for accessibility and keyboard navigation.

        Note: Global debugging can be enabled by setting A11yHelper.debug = true.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        debug prefersReducedMotion

        Methods

        applyFocusSource getFirstFocusableElement -getFocusSource getFocusableElements +getFocusSource getLastFocusableElement +isFocusable isFocusSource isFocusTarget isFocusWithin -isFocusable -

        Constructors

        constructor

        Accessors

        Static debug

        • get debug(): boolean

        • Returns boolean

          Global debugging enabled.

          +

        Constructors

        constructor

        Accessors

        Staticdebug

        • get debug(): boolean

        • Returns boolean

          Global debugging enabled.

        • set debug(debug): void

        • Parameters

          • debug: boolean

            Global debug enabled

            -

          Returns void

        Static prefersReducedMotion

        • get prefersReducedMotion(): boolean

        • Runs a media query to determine if the user / OS configuration is set up for reduced motion / animation.

          +

        Returns void

        StaticprefersReducedMotion

        • get prefersReducedMotion(): boolean

        • Runs a media query to determine if the user / OS configuration is set up for reduced motion / animation.

          Returns boolean

          User prefers reduced motion.

          -

        Methods

        Static applyFocusSource

        • applyFocusSource(options): void

        • Apply focus to the HTMLElement / SVGElement targets in a given A11yFocusSource data object. An iterable list +

        Methods

        StaticapplyFocusSource

        • applyFocusSource(options): void

        • Apply focus to the HTMLElement / SVGElement targets in a given A11yFocusSource data object. An iterable list options.focusEl can contain HTMLElement / SVGElements or selector strings. If multiple focus targets are provided in a list then the first valid target found will be focused. If focus target is a string then a lookup via document.querySelector is performed. In this case you should provide a unique selector for the desired @@ -24,13 +25,21 @@

          Note: The body of this method is postponed to the next clock tick to allow any changes in the DOM to occur that might alter focus targets before applying.

          Parameters

          Returns void

        Static getFirstFocusableElement

        • getFirstFocusableElement(element?, options?): FocusableElement

        • Returns first focusable element within a specified element.

          -

          Parameters

          • Optional element: Element | Document

            Optional element to start query.

            -
          • Optional options: {
                ignoreClasses?: Iterable<string>;
                ignoreElements?: Set<Element>;
            }

            Optional parameters.

            -
            • Optional ignoreClasses?: Iterable<string>

              Iterable list of classes to ignore elements.

              -
            • Optional ignoreElements?: Set<Element>

              Set of elements to ignore.

              +

          Returns void

        StaticgetFirstFocusableElement

        • getFirstFocusableElement(element?, options?): FocusableElement

        • Returns first focusable element within a specified element.

          +

          Parameters

          • Optionalelement: Element | Document

            Optional element to start query.

            +
          • Optionaloptions: {
                ignoreClasses?: Iterable<string>;
                ignoreElements?: Set<Element>;
            }

            Optional parameters.

            +
            • OptionalignoreClasses?: Iterable<string>

              Iterable list of classes to ignore elements.

              +
            • OptionalignoreElements?: Set<Element>

              Set of elements to ignore.

          Returns FocusableElement

          First focusable child element.

          -

        Static getFocusSource

        • getFocusSource(options): A11yFocusSource

        • Gets a A11yFocusSource object from the given DOM event allowing for optional X / Y screen space overrides. +

        StaticgetFocusableElements

        • getFocusableElements(element?, options?): FocusableElement[]

        • Returns all focusable elements within a specified element.

          +

          Parameters

          • Optionalelement: Element | Document

            Optional element to start query.

            +
          • Optionaloptions: {
                anchorHref?: boolean;
                ignoreClasses?: Iterable<string>;
                ignoreElements?: Set<Element>;
                selectors?: string;
            }

            Optional parameters.

            +
            • OptionalanchorHref?: boolean

              When true anchors must have an HREF.

              +
            • OptionalignoreClasses?: Iterable<string>

              Iterable list of classes to ignore elements.

              +
            • OptionalignoreElements?: Set<Element>

              Set of elements to ignore.

              +
            • Optionalselectors?: string

              Custom list of focusable selectors for querySelectorAll.

              +

          Returns FocusableElement[]

          Child keyboard focusable elements.

          +

        StaticgetFocusSource

        Static getFocusableElements

        • getFocusableElements(element?, options?): FocusableElement[]

        • Returns all focusable elements within a specified element.

          -

          Parameters

          • Optional element: Element | Document

            Optional element to start query.

            -
          • Optional options: {
                anchorHref?: boolean;
                ignoreClasses?: Iterable<string>;
                ignoreElements?: Set<Element>;
                selectors?: string;
            }

            Optional parameters.

            -
            • Optional anchorHref?: boolean

              When true anchors must have an HREF.

              -
            • Optional ignoreClasses?: Iterable<string>

              Iterable list of classes to ignore elements.

              -
            • Optional ignoreElements?: Set<Element>

              Set of elements to ignore.

              -
            • Optional selectors?: string

              Custom list of focusable selectors for querySelectorAll.

              -

          Returns FocusableElement[]

          Child keyboard focusable elements.

          -

        Static getLastFocusableElement

        • getLastFocusableElement(element?, options?): FocusableElement

        • Returns first focusable element within a specified element.

          -

          Parameters

          • Optional element: Element | Document

            Optional element to start query.

            -
          • Optional options: {
                ignoreClasses?: Iterable<string>;
                ignoreElements?: Set<Element>;
            }

            Optional parameters.

            -
            • Optional ignoreClasses?: Iterable<string>

              Iterable list of classes to ignore elements.

              -
            • Optional ignoreElements?: Set<Element>

              Set of elements to ignore.

              +

        StaticgetLastFocusableElement

        • getLastFocusableElement(element?, options?): FocusableElement

        • Returns first focusable element within a specified element.

          +

          Parameters

          • Optionalelement: Element | Document

            Optional element to start query.

            +
          • Optionaloptions: {
                ignoreClasses?: Iterable<string>;
                ignoreElements?: Set<Element>;
            }

            Optional parameters.

            +
            • OptionalignoreClasses?: Iterable<string>

              Iterable list of classes to ignore elements.

              +
            • OptionalignoreElements?: Set<Element>

              Set of elements to ignore.

          Returns FocusableElement

          Last focusable child element.

          -

        Static isFocusSource

        • isFocusSource(data): boolean

        • Convenience method to check if the given data is a valid focus source.

          +

        StaticisFocusable

        • isFocusable(el, options?): boolean

        • Tests if the given element is focusable.

          +

          Parameters

          • el: Element

            Element to test.

            +
          • Optionaloptions: {
                anchorHref?: boolean;
                ignoreClasses?: Iterable<string>;
            }

            Optional parameters.

            +
            • OptionalanchorHref?: boolean

              When true anchors must have an HREF.

              +
            • OptionalignoreClasses?: Iterable<string>

              Iterable list of classes to ignore elements.

              +

          Returns boolean

          Element is focusable.

          +

        StaticisFocusSource

        • isFocusSource(data): boolean

        • Convenience method to check if the given data is a valid focus source.

          Parameters

          • data: string | Element

            Either an HTMLElement, SVGElement, or selector string.

          Returns boolean

          Is valid focus source.

          -

        Static isFocusTarget

        • isFocusTarget(element): boolean

        • Tests if the given element is a Element node and has a focus method.

          +

        StaticisFocusTarget

        • isFocusTarget(element): boolean

        • Tests if the given element is a Element node and has a focus method.

          Parameters

          • element: Element

            Element to test for focus method.

          Returns boolean

          Whether the element has a focus method.

          -

        Static isFocusWithin

        • isFocusWithin(element, activeWindow?): boolean

        • Perform a parent traversal from the current active element attempting to match the given element to test whether +

        StaticisFocusWithin

        • isFocusWithin(element, activeWindow?): boolean

        • Perform a parent traversal from the current active element attempting to match the given element to test whether current active element is within that element.

          Parameters

          • element: Element

            An element to match in parent traversal from the active element.

            -
          • Optional activeWindow: Window

            The active window to use for the current active element.

            +
          • OptionalactiveWindow: Window

            The active window to use for the current active element.

          Returns boolean

          Whether there is focus within the given element.

          -

        Static isFocusable

        • isFocusable(el, options?): boolean

        • Tests if the given element is focusable.

          -

          Parameters

          • el: Element

            Element to test.

            -
          • Optional options: {
                anchorHref?: boolean;
                ignoreClasses?: Iterable<string>;
            }

            Optional parameters.

            -
            • Optional anchorHref?: boolean

              When true anchors must have an HREF.

              -
            • Optional ignoreClasses?: Iterable<string>

              Iterable list of classes to ignore elements.

              -

          Returns boolean

          Element is focusable.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructordebugprefersReducedMotionapplyFocusSourcegetFirstFocusableElementgetFocusSourcegetFocusableElementsgetLastFocusableElementisFocusSourceisFocusTargetisFocusWithinisFocusable
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_util_browser.BrowserSupports.html b/docs/classes/_runtime_util_browser.BrowserSupports.html index f20c8c3e..02ff99fd 100644 --- a/docs/classes/_runtime_util_browser.BrowserSupports.html +++ b/docs/classes/_runtime_util_browser.BrowserSupports.html @@ -1,8 +1,9 @@ -BrowserSupports | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class BrowserSupports

        Provides utility methods for checking browser capabilities.

        -

        See

        https://kilianvalkhof.com/2021/web/detecting-media-query-support-in-css-and-javascript/ +BrowserSupports | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class BrowserSupports

        Provides utility methods for checking browser capabilities.

        +

        See

        https://kilianvalkhof.com/2021/web/detecting-media-query-support-in-css-and-javascript/ TODO: perhaps add support for various standard media query checks for level 4 & 5.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        containerQueries -

        Constructors

        constructor

        Accessors

        Static containerQueries

        • get containerQueries(): boolean

        • Check for container query support.

          +

        Constructors

        constructor

        Accessors

        StaticcontainerQueries

        • get containerQueries(): boolean

        • Check for container query support.

          Returns boolean

          True if container queries supported.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorcontainerQueries
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Accessors
        \ No newline at end of file diff --git a/docs/classes/_runtime_util_browser.ClipboardAccess.html b/docs/classes/_runtime_util_browser.ClipboardAccess.html index d00e70f8..d212686a 100644 --- a/docs/classes/_runtime_util_browser.ClipboardAccess.html +++ b/docs/classes/_runtime_util_browser.ClipboardAccess.html @@ -1,17 +1,18 @@ -ClipboardAccess | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class ClipboardAccess

        Provides access to the Clipboard API for reading / writing text strings. This requires a secure context.

        +ClipboardAccess | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class ClipboardAccess

        Provides access to the Clipboard API for reading / writing text strings. This requires a secure context.

        Note: writeText will attempt to use the older execCommand if available when navigator.clipboard is not available.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Methods

        readText writeText -

        Constructors

        constructor

        Methods

        Static readText

        • readText(activeWindow?): Promise<string>

        • Uses navigator.clipboard if available to read text from the clipboard.

          +

        Constructors

        constructor

        Methods

        StaticreadText

        • readText(activeWindow?): Promise<string>

        • Uses navigator.clipboard if available to read text from the clipboard.

          Note: Always returns undefined when navigator.clipboard is not available or the clipboard contains the empty string.

          -

          Parameters

          • Optional activeWindow: Window

            Optional active current window.

            +

            Parameters

            • OptionalactiveWindow: Window

              Optional active current window.

            Returns Promise<string>

            The current clipboard text or undefined.

            -

        Static writeText

        • writeText(text, activeWindow?): Promise<boolean>

        • Uses navigator.clipboard if available then falls back to document.execCommand('copy') if available to copy +

        StaticwriteText

        • writeText(text, activeWindow?): Promise<boolean>

        • Uses navigator.clipboard if available then falls back to document.execCommand('copy') if available to copy the given text to the clipboard.

          Parameters

          • text: string

            Text to copy to the browser clipboard.

            -
          • Optional activeWindow: Window

            Optional active current window.

            +
          • OptionalactiveWindow: Window

            Optional active current window.

          Returns Promise<boolean>

          Copy successful.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorreadTextwriteText
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_util_browser.ResizeObserverManager.html b/docs/classes/_runtime_util_browser.ResizeObserverManager.html index 2206178d..fa7cde26 100644 --- a/docs/classes/_runtime_util_browser.ResizeObserverManager.html +++ b/docs/classes/_runtime_util_browser.ResizeObserverManager.html @@ -1,27 +1,28 @@ -ResizeObserverManager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class ResizeObserverManager

        Provides an instance of ResizeObserver that can manage multiple elements and notify a wide range of +ResizeObserverManager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class ResizeObserverManager

        Provides an instance of ResizeObserver that can manage multiple elements and notify a wide range of ResizeObserverData.ResizeTarget listeners. Offset width and height is also provided through caching the margin and padding styles of the target element.

        The action, resizeObserver, utilizes ResizeObserverManager for automatic registration and removal via Svelte.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Methods

        add clear remove updateCache -

        Constructors

        constructor

        Methods

        add

        Constructors

        constructor

        Methods

        add

        • add(el, target): void

        • Add an HTMLElement and ResizeObserverData.ResizeTarget instance for monitoring. Create cached style attributes for the given element include border & padding dimensions for offset width / height calculations.

          Parameters

          Returns void

        clear

        • clear(): void

        • Clears and unobserves all currently tracked elements and managed targets.

          Returns void

        remove

        • remove(el, target?): void

        • Removes all ResizeObserverData.ResizeTarget instances for the given element from monitoring when just an element is provided otherwise removes a specific target from the monitoring map. If no more targets remain then the element is removed from monitoring.

          Parameters

          Returns void

        updateCache

        • updateCache(el): void

        • Provides a function that when invoked with an element updates the cached styles for each subscriber of the element.

          The style attributes cached to calculate offset height / width include border & padding dimensions. You only need to update the cache if you change border or padding attributes of the element.

          Parameters

          Returns void

        Settings

        Member Visibility

        Theme

        On This Page

        constructoraddclearremoveupdateCache
        \ No newline at end of file +

        Returns void

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_util_browser.StyleParse.html b/docs/classes/_runtime_util_browser.StyleParse.html index 9a1a844e..6b392546 100644 --- a/docs/classes/_runtime_util_browser.StyleParse.html +++ b/docs/classes/_runtime_util_browser.StyleParse.html @@ -1,7 +1,8 @@ -StyleParse | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class StyleParse

        Provides resources for parsing style strings.

        -

        Constructors

        constructor +StyleParse | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
        +

        Class StyleParse

        Provides resources for parsing style strings.

        +

        Constructors

        constructor

        Methods

        pixels -

        Constructors

        constructor

        Methods

        Static pixels

        • pixels(value): number

        • Parses a pixel string / computed styles. Ex. 100px returns 100.

          +

        Constructors

        constructor

        Methods

        Staticpixels

        • pixels(value): number

        • Parses a pixel string / computed styles. Ex. 100px returns 100.

          Parameters

          • value: string

            Value to parse.

          Returns number

          The integer component of a pixel string.

          -

        Settings

        Member Visibility

        Theme

        On This Page

        constructorpixels
        \ No newline at end of file +

        Settings

        Member Visibility

        On This Page

        Constructors
        Methods
        \ No newline at end of file diff --git a/docs/classes/_runtime_util_browser.TJSStyleManager.html b/docs/classes/_runtime_util_browser.TJSStyleManager.html index e159aac2..e96f0c95 100644 --- a/docs/classes/_runtime_util_browser.TJSStyleManager.html +++ b/docs/classes/_runtime_util_browser.TJSStyleManager.html @@ -1,4 +1,5 @@ -TJSStyleManager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        Class TJSStyleManager

        Provides a managed dynamic style sheet / element useful in configuring global CSS variables. When creating an +TJSStyleManager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

        +

        Class TJSStyleManager

        Provides a managed dynamic style sheet / element useful in configuring global CSS variables. When creating an instance of TJSStyleManager you must provide a "document key" / string for the style element added. The style element can be accessed via document[docKey].

        Instances of TJSStyleManager can also be versioned by supplying a positive integer greater than or equal to 1 via @@ -8,7 +9,7 @@ construction of CSS variables exposed, but allows multiple independently compiled TRL packages to load the latest CSS variables. It is recommended to always set overwrite option of TJSStyleManager.setProperty and TJSStyleManager.setProperties to false when loading initial values.

        -

        Constructors

        constructor +

        Constructors

        constructor

        Accessors

        cssText version

        Methods

        clone @@ -18,16 +19,16 @@ removeProperty setProperties setProperty -

        Constructors

        constructor

        • new TJSStyleManager(opts?): TJSStyleManager

        • Parameters

          • Optional opts: {
                docKey: string;
                document?: Document;
                selector?: string;
                version?: number;
            }

            Options.

            +

        Constructors

        constructor

        • new TJSStyleManager(opts?): TJSStyleManager

        • Parameters

          • Optionalopts: {
                docKey: string;
                document?: Document;
                selector?: string;
                version?: number;
            }

            Options.

            • docKey: string

              Required key providing a link to a specific style sheet element.

              -
            • Optional document?: Document

              Target document to load styles into.

              -
            • Optional selector?: string

              Selector element.

              -
            • Optional version?: number

              An integer representing the version / level of styles being managed.

              -

          Returns TJSStyleManager

        Accessors

        cssText

        • get cssText(): string

        • Returns string

          Provides an accessor to get the cssText for the style sheet.

          +
      • Optionaldocument?: Document

        Target document to load styles into.

        +
      • Optionalselector?: string

        Selector element.

        +
      • Optionalversion?: number

        An integer representing the version / level of styles being managed.

        +

        • Returns TJSStyleManager

        Accessors

        cssText

        • get cssText(): string

        • Returns string

          Provides an accessor to get the cssText for the style sheet.

        version

        • get version(): number

        • Returns number

          Returns the version of this instance.

          -

        Methods

        clone

        • clone(document?): TJSStyleManager

        • Provides a copy constructor to duplicate an existing TJSStyleManager instance into a new document.

          +

        Methods

        clone

        • clone(document?): TJSStyleManager

        • Provides a copy constructor to duplicate an existing TJSStyleManager instance into a new document.

          Note: This is used to support the PopOut module.

          -

          Parameters

          • Optional document: Document

            Target browser document to clone into.

            +

            Parameters

            • Optionaldocument: Document

              Target browser document to clone into.

            Returns TJSStyleManager

            New style manager instance.

        get

        • get(): {}

        • Returns {}

          getProperty

          • getProperty(key): string

          • Gets a particular CSS variable.

            Parameters

            • key: string

              CSS variable property key.

              @@ -39,9 +40,9 @@

            Returns string

            CSS variable value when removed.

          setProperties

          • setProperties(rules, overwrite?): void

          • Set rules by property / value; useful for CSS variables.

            Parameters

            • rules: {
                  [key: string]: string;
              }

              An object with property / value string pairs to load.

              -
              • [key: string]: string
            • Optional overwrite: boolean

              When true overwrites any existing values.

              +
              • [key: string]: string
            • Optionaloverwrite: boolean

              When true overwrites any existing values.

            Returns void

          setProperty

          • setProperty(key, value, overwrite?): void

          • Sets a particular property.

            Parameters

            • key: string

              CSS variable property key.

            • value: string

              CSS variable value.

              -
            • Optional overwrite: boolean

              Overwrite any existing value.

              -

            Returns void

          Settings

          Member Visibility

          Theme

          On This Page

          constructorcssTextversionclonegetgetPropertyremovePropertiesremovePropertysetPropertiessetProperty
          \ No newline at end of file +
        • Optionaloverwrite: boolean

          Overwrite any existing value.

          +

          • Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_runtime_util_loader_module.ModuleLoadError.html b/docs/classes/_runtime_util_loader_module.ModuleLoadError.html index cf4aa566..988071dd 100644 --- a/docs/classes/_runtime_util_loader_module.ModuleLoadError.html +++ b/docs/classes/_runtime_util_loader_module.ModuleLoadError.html @@ -1,5 +1,16 @@ -ModuleLoadError | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class ModuleLoadError

          Provides a custom error for Node to combine CJS and ESM module not found errors.

          -

          Hierarchy

          Constructors

          constructor +ModuleLoadError | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class ModuleLoadError

          Provides a custom error for Node to combine CJS and ESM module not found errors.

          +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          captureStackTrace

          Properties

          cause? code @@ -8,10 +19,10 @@ stack? prepareStackTrace? stackTraceLimit -

          Constructors

          constructor

          • new ModuleLoadError(options): ModuleLoadError

          • Parameters

            • options: {
                  code: string;
                  message: string;
              }

              Options object.

              +

          Constructors

          constructor

          • new ModuleLoadError(options): ModuleLoadError

          • Parameters

            • options: {
                  code: string;
                  message: string;
              }

              Options object.

              • code: string

                Error code.

              • message: string

                Error message.

                -

            Returns ModuleLoadError

          Methods

          Static captureStackTrace

          • captureStackTrace(targetObject, constructorOpt?): void

          • Create .stack property on a target object

            -

            Parameters

            • targetObject: object
            • Optional constructorOpt: Function

            Returns void

          Properties

          Optional cause

          cause?: unknown

          code

          code: string

          message

          message: string

          name

          name: string

          Optional stack

          stack?: string

          Static Optional prepareStackTrace

          prepareStackTrace?: ((err, stackTraces) => any)

          Optional override for formatting stack traces

          -

          Type declaration

            • (err, stackTraces): any

            • Parameters

              • err: Error
              • stackTraces: CallSite[]

              Returns any

          See

          https://v8.dev/docs/stack-trace-api#customizing-stack-traces

          -

          Static stackTraceLimit

          stackTraceLimit: number

          Settings

          Member Visibility

          Theme

          On This Page

          constructorcaptureStackTracecausecodemessagenamestackprepareStackTracestackTraceLimit
          \ No newline at end of file +

          Returns ModuleLoadError

          Methods

          StaticcaptureStackTrace

          • captureStackTrace(targetObject, constructorOpt?): void

          • Create .stack property on a target object

            +

            Parameters

            • targetObject: object
            • OptionalconstructorOpt: Function

            Returns void

          Properties

          Optionalcause

          cause?: unknown

          code

          code: string

          message

          message: string

          name

          name: string

          Optionalstack

          stack?: string

          Static OptionalprepareStackTrace

          prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

          Optional override for formatting stack traces

          +

          See

          https://v8.dev/docs/stack-trace-api#customizing-stack-traces

          +

          StaticstackTraceLimit

          stackTraceLimit: number

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          Properties
          \ No newline at end of file diff --git a/docs/classes/_runtime_util_loader_module.ModuleLoader.html b/docs/classes/_runtime_util_loader_module.ModuleLoader.html index 06400c31..bfa2f7a9 100644 --- a/docs/classes/_runtime_util_loader_module.ModuleLoader.html +++ b/docs/classes/_runtime_util_loader_module.ModuleLoader.html @@ -1,9 +1,10 @@ -ModuleLoader | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class ModuleLoader

          Provides universal loading of ES Modules / CommonJS on Node and ES Modules in the browser.

          +ModuleLoader | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class ModuleLoader

          Provides universal loading of ES Modules / CommonJS on Node and ES Modules in the browser.

          ModuleLoaderObj is returned with the loaded module along with metadata that describes the loading mechanism.

          -

          Constructors

          constructor +

          Constructors

          constructor

          Methods

          load -

          Constructors

          constructor

          Methods

          Static load

          • load<M, E>(options): Promise<ModuleLoaderObj<M, E>>

          • Type Parameters

            • M
            • E

            Parameters

            • options: {
                  modulepath: string | URL;
                  resolveModule?: ((M) => E);
              }

              Options object.

              +

          Constructors

          constructor

          Methods

          Staticload

          • load<M, E>(options): Promise<ModuleLoaderObj<M, E>>

          • Type Parameters

            • M
            • E

            Parameters

            • options: {
                  modulepath: string | URL;
                  resolveModule?: ((M: any) => E);
              }

              Options object.

              • modulepath: string | URL

                A module name, file path, or URL.

                -
              • Optional resolveModule?: ((M) => E)

                An optional function which resolves the import to set instance.

                +
              • OptionalresolveModule?: ((M: any) => E)

                An optional function which resolves the import to set instance.

                  • (M): E

                  • Parameters

                    • M: any

                    Returns E

            Returns Promise<ModuleLoaderObj<M, E>>

            The module / instance and data about the loading process.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructorload
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application.FVTTFilePickerControl.html b/docs/classes/_standard_application.FVTTFilePickerControl.html index 456994bf..916e81db 100644 --- a/docs/classes/_standard_application.FVTTFilePickerControl.html +++ b/docs/classes/_standard_application.FVTTFilePickerControl.html @@ -1,4 +1,5 @@ -FVTTFilePickerControl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class FVTTFilePickerControl

          Provides managed control of the Foundry globalThis.FilePicker app simplifying asynchronous use cases. While the stock +FVTTFilePickerControl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class FVTTFilePickerControl

          Provides managed control of the Foundry globalThis.FilePicker app simplifying asynchronous use cases. While the stock FilePicker provides a callback it is not easy to make it asynchronous given that a user can close the app. FVTTFilePickerControl enables a fully asynchronous workflow controlling one FilePicker instance at a time. When FVTTFilePickerControl.browse is invoked any previous FilePicker instance is closed and Promise resolved.

          @@ -12,28 +13,28 @@ https://github.com/typhonjs-fvtt-demo/essential-svelte-esm

          Several ready-made Svelte components are available that are designed around FVTTFilePickerControl.

          Please see the following Svelte components that can be imported from #standard/component/fvtt:

          -

          See

            +

          See

          • TJSFileButton - A standard form button element.
          • TJSFileIconButton - Uses TJSIconButton for display.
          • TJSFileSlotButton - Provides a slotted button where you can provide any containing content.
          -

          Constructors

          constructor +

          Constructors

          constructor

          Accessors

          canBrowse

          Methods

          bringToTop browse close -

          Constructors

          constructor

          Accessors

          Static canBrowse

          • get canBrowse(): boolean

          • Returns boolean

            Test if the current user can browse files.

            -

          Methods

          Static bringToTop

          • bringToTop(id?): boolean

          • Brings any non-modal / glasspane file picker to top. Returning if it is the active file picker.

            -

            Parameters

            • Optional id: string

              The ID of the file picker app.

              +

          Constructors

          constructor

          Accessors

          StaticcanBrowse

          • get canBrowse(): boolean

          • Returns boolean

            Test if the current user can browse files.

            +

          Methods

          StaticbringToTop

          • bringToTop(id?): boolean

          • Brings any non-modal / glasspane file picker to top. Returning if it is the active file picker.

            +

            Parameters

            • Optionalid: string

              The ID of the file picker app.

            Returns boolean

            Whether the file picker app is brought to top.

            -

          Static browse

          • browse(options?, event?): Promise<string>

          • Creates a new Foundry FilePicker app to browse and return a file path selection.

            -

            Parameters

            • Optional options: FVTTFilePickerBrowseOptions

              FVTTFilePickerControl browse options. This may also include any - Application options.

              -
            • Optional event: MouseEvent | KeyboardEvent

              An event to inspect for focus management when a modal file picker - is launched.

              +

          Staticbrowse

          • browse(options?, event?): Promise<string>

          • Creates a new Foundry FilePicker app to browse and return a file path selection.

            +

            Parameters

            • Optionaloptions: FVTTFilePickerBrowseOptions

              FVTTFilePickerControl browse options. This may also include any +Application options.

              +
            • Optionalevent: MouseEvent | KeyboardEvent

              An event to inspect for focus management when a modal file picker +is launched.

            Returns Promise<string>

            The file picker / browse result.

            -

          Static close

          • close(id?): void

          • Closes the file picker with optional id of a specific file picker app to close. You may also provide a list of +

          Staticclose

          • close(id?): void

          • Closes the file picker with optional id of a specific file picker app to close. You may also provide a list of app IDs to close. When provided only the file picker app instance with a matching ID will be closed.

            Note: When close is invoked w/ no id parameter any current file picker app is closed.

            -

            Parameters

            • Optional id: string | Iterable<string>

              Specific IDs to match against any current visible file picker app.

              -

            Returns void

          Settings

          Member Visibility

          Theme

          On This Page

          constructorcanBrowsebringToTopbrowseclose
          \ No newline at end of file +

          Parameters

          • Optionalid: string | Iterable<string>

            Specific IDs to match against any current visible file picker app.

            +

          Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application.FVTTSidebarControl.html b/docs/classes/_standard_application.FVTTSidebarControl.html index 12b8a357..2bee4fcb 100644 --- a/docs/classes/_standard_application.FVTTSidebarControl.html +++ b/docs/classes/_standard_application.FVTTSidebarControl.html @@ -1,4 +1,5 @@ -FVTTSidebarControl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class FVTTSidebarControl

          Provides the ability to mount and control Svelte component based sidebar panels & tabs in the Foundry sidebar.

          +FVTTSidebarControl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class FVTTSidebarControl

          Provides the ability to mount and control Svelte component based sidebar panels & tabs in the Foundry sidebar.

          The nice aspect about FVTTSidebarControl is that all you have to provide is the sidebar component and the rest is handled for you including automatically widening the width of the sidebar to fit the new sidebar tab. Also by default an adhoc SvelteApplication is configured to display the sidebar when popped out automatically without the need to @@ -14,14 +15,17 @@

          Optionally:

            -

          • You can define the icon as a Svelte configuration object to load an interactive component instead of +

          • +

            You can define the icon as a Svelte configuration object to load an interactive component instead of using a FontAwesome icon. This allows you to dynamically show state similar to the chat log sidebar when activity occurs or for other purposes.

            • -

          • You can provide popoutOptions overriding the default options passed to the default adhoc SvelteApplication +

          • +

            You can provide popoutOptions overriding the default options passed to the default adhoc SvelteApplication rendered for the popout.

            • -

          • You can provide a class that extends from SvelteApplication as popoutApplication to provide a fully customized +

          • +

            You can provide a class that extends from SvelteApplication as popoutApplication to provide a fully customized popout sidebar that you fully control.

          @@ -44,25 +48,26 @@

          The FVTTSidebarControl.wait returns a Promise that is resolved after all sidebars have been initialized. allowing handling any special setup as necessary.

          -

          Example

          Minimal setup

          Hooks.once('setup', () =>
          {
             FVTTSidebarControl.add({
                beforeId: 'items',               // Place new tab before the 'items' tab.
                id: 'test',                      // A unique CSS ID.
                icon: 'fas fa-dice-d10',         // FontAwesome icon.
                condition: () => game.user.isGM, // Optional boolean / function to conditionally run the sidebar action.
                title: 'Test Directory',         // Title of popout sidebar app; can be language string.
                tooltip: 'Tests',                // Tooltip for sidebar tab.
                svelte: {                        // A Svelte configuration object.
                   class: TestTab                // A Svelte component.
                }
             });
          });
-
          -

          Constructors

          constructor +

          Example

          Minimal setup

          Hooks.once('setup', () =>
          {
             FVTTSidebarControl.add({
                beforeId: 'items',               // Place new tab before the 'items' tab.
                id: 'test',                      // A unique CSS ID.
                icon: 'fas fa-dice-d10',         // FontAwesome icon.
                condition: () => game.user.isGM, // Optional boolean / function to conditionally run the sidebar action.
                title: 'Test Directory',         // Title of popout sidebar app; can be language string.
                tooltip: 'Tests',                // Tooltip for sidebar tab.
                svelte: {                        // A Svelte configuration object.
                   class: TestTab                // A Svelte component.
                }
             });
          });
+
          + +

          Constructors

          constructor

          Methods

          add get remove replace wait -

          Constructors

          constructor

          Methods

          Static add

          • add(sidebarData): void

          • Adds a new Svelte powered sidebar tab / panel.

            +

          Constructors

          constructor

          Methods

          Staticadd

          • add(sidebarData): void

          • Adds a new Svelte powered sidebar tab / panel.

            Parameters

            Returns void

          Static get

          Returns void

          Staticget

          • get(id): FVTTSidebarEntry

          • Returns a loaded and configured sidebar entry by ID.

            Parameters

            • id: string

              The ID of the sidebar to retrieve.

            Returns FVTTSidebarEntry

            The sidebar entry.

            -

          Static remove

          • remove(sidebarData): void

          • Removes an existing sidebar tab / panel.

            +

          Staticremove

          • remove(sidebarData): void

          • Removes an existing sidebar tab / panel.

            Parameters

            Returns void

          Static replace

          • replace(sidebarData): void

          • Replaces an existing sidebar tab / panel with a new Svelte powered sidebar.

            +

          Returns void

          Staticreplace

          • replace(sidebarData): void

          • Replaces an existing sidebar tab / panel with a new Svelte powered sidebar.

            Parameters

            • sidebarData: FVTTSidebarReplaceData

              The configuration object to replace a core sidebar with a Svelte - sidebar.

              -

            Returns void

          Static wait

          • wait(): Promise<any>

          • Provides a Promise that is resolved after all added sidebars are initialized. This is useful when additional +sidebar.

            +

          Returns void

          Staticwait

          • wait(): Promise<any>

          • Provides a Promise that is resolved after all added sidebars are initialized. This is useful when additional setup or configuration of sidebars needs to be performed after sidebar initialization.

            Returns Promise<any>

            Initialization Promise.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructoraddgetremovereplacewait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application.TJSContextMenu.html b/docs/classes/_standard_application.TJSContextMenu.html index 81b7fbf3..9cd41d46 100644 --- a/docs/classes/_standard_application.TJSContextMenu.html +++ b/docs/classes/_standard_application.TJSContextMenu.html @@ -1,36 +1,37 @@ -TJSContextMenu | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSContextMenu

          Provides and manages browser window wide context menu functionality. The best way to create a context menu is to +TJSContextMenu | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSContextMenu

          Provides and manages browser window wide context menu functionality. The best way to create a context menu is to attach the source KeyboardEvent or MouseEvent / PointerEvent as data in TJSContextMenu.create. This allows proper keyboard handling across browsers supporting the context menu key. A A11yFocusSource data object is generated which allows tracking of the source element that triggered the context menu allowing focus to return to the source when the context menu is closed. This A11yFocusSource object is also forwarded on through the onPress callback and is intended to be supplied as SvelteApplication options particularly for modal dialogs allowing focus to return to the original source after the modal dialog is closed.

          -

          Constructors

          constructor +

          Constructors

          constructor

          Methods

          create -

          Constructors

          constructor

          Methods

          Static create

          • create(opts?): void

          • Creates and manages a browser wide context menu. The best way to create the context menu is to pass in the source +

          Constructors

          constructor

          Methods

          Staticcreate

          • create(opts?): void

          • Creates and manages a browser wide context menu. The best way to create the context menu is to pass in the source DOM event as it is processed for the location of the context menu to display. Likewise, a A11yFocusSource object is generated that allows focus to be returned to the source location. You may supply a default focus target as a fallback via focusEl.

            -

            Parameters

            • Optional opts: {
                  activeWindow?: Window;
                  duration?: number;
                  easing?: EasingReference;
                  event?: MouseEvent | KeyboardEvent;
                  focusDebug?: boolean;
                  focusEl?: string | HTMLElement;
                  id?: string;
                  items?: Iterable<TJSContextMenuItemData>;
                  keyCode?: string;
                  offsetX?: number;
                  offsetY?: number;
                  styles?: Record<string, string>;
                  x?: number;
                  y?: number;
                  zIndex?: number;
              }

              Optional parameters.

              -
              • Optional activeWindow?: Window

                The active browser window that the context menu is - displaying inside.

                -
              • Optional duration?: number

                Transition option for duration of transition.

                -
              • Optional easing?: EasingReference

                Transition option for ease. Either an - easing function or easing function name.

                -
              • Optional event?: MouseEvent | KeyboardEvent

                The source MouseEvent or KeyboardEvent.

                -
              • Optional focusDebug?: boolean

                When true the associated A11yFocusSource object will log focus target - data when applied.

                -
              • Optional focusEl?: string | HTMLElement

                A specific HTMLElement or selector string as the default focus - target.

                -
              • Optional id?: string

                A custom CSS ID to add to the menu. This allows CSS style targeting.

                -
              • Optional items?: Iterable<TJSContextMenuItemData>

                Menu items to display.

                -
              • Optional keyCode?: string

                Key to select menu items.

                -
              • Optional offsetX?: number

                Small positive integer offset for context menu so the pointer / mouse is - over the menu on display.

                -
              • Optional offsetY?: number

                Small positive integer offset for context menu so the pointer / mouse is - over the menu on display.

                -
              • Optional styles?: Record<string, string>

                Optional inline styles to apply.

                -
              • Optional x?: number

                X position override for the top / left of the menu.

                -
              • Optional y?: number

                Y position override for the top / left of the menu.

                -
              • Optional zIndex?: number

                Z-index for context menu.

                -

            Returns void

          Settings

          Member Visibility

          Theme

          On This Page

          constructorcreate
          \ No newline at end of file +

          Parameters

          • Optionalopts: {
                activeWindow?: Window;
                duration?: number;
                easing?: EasingReference;
                event?: MouseEvent | KeyboardEvent;
                focusDebug?: boolean;
                focusEl?: string | HTMLElement;
                id?: string;
                items?: Iterable<TJSContextMenuItemData>;
                keyCode?: string;
                offsetX?: number;
                offsetY?: number;
                styles?: Record<string, string>;
                x?: number;
                y?: number;
                zIndex?: number;
            }

            Optional parameters.

            +
            • OptionalactiveWindow?: Window

              The active browser window that the context menu is +displaying inside.

              +
            • Optionalduration?: number

              Transition option for duration of transition.

              +
            • Optionaleasing?: EasingReference

              Transition option for ease. Either an +easing function or easing function name.

              +
            • Optionalevent?: MouseEvent | KeyboardEvent

              The source MouseEvent or KeyboardEvent.

              +
            • OptionalfocusDebug?: boolean

              When true the associated A11yFocusSource object will log focus target +data when applied.

              +
            • OptionalfocusEl?: string | HTMLElement

              A specific HTMLElement or selector string as the default focus +target.

              +
            • Optionalid?: string

              A custom CSS ID to add to the menu. This allows CSS style targeting.

              +
            • Optionalitems?: Iterable<TJSContextMenuItemData>

              Menu items to display.

              +
            • OptionalkeyCode?: string

              Key to select menu items.

              +
            • OptionaloffsetX?: number

              Small positive integer offset for context menu so the pointer / mouse is +over the menu on display.

              +
            • OptionaloffsetY?: number

              Small positive integer offset for context menu so the pointer / mouse is +over the menu on display.

              +
            • Optionalstyles?: Record<string, string>

              Optional inline styles to apply.

              +
            • Optionalx?: number

              X position override for the top / left of the menu.

              +
            • Optionaly?: number

              Y position override for the top / left of the menu.

              +
            • OptionalzIndex?: number

              Z-index for context menu.

              +

          Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSDocumentCreate.html b/docs/classes/_standard_application_dialog_document.TJSDocumentCreate.html index 8f3a7556..c40524f6 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentCreate.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentCreate.html @@ -1,5 +1,16 @@ -TJSDocumentCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSDocumentCreate

          Provides a dialog for creating documents that by default is modal and not draggable.

          -

          Hierarchy (view full)

          Constructors

          constructor +TJSDocumentCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSDocumentCreate

          Provides a dialog for creating documents that by default is modal and not draggable.

          +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          data elementContent elementTarget @@ -17,18 +28,18 @@ prompt show wait -

          Constructors

          constructor

          • new TJSDocumentCreate(documentCls, data?, context?, dialogData?): TJSDocumentCreate

          • Create a new Document of the type specified by documentCls by rendering a dialog window to provide basic +

          Constructors

          constructor

          • new TJSDocumentCreate(documentCls, data?, context?, dialogData?): TJSDocumentCreate

          • Create a new Document of the type specified by documentCls by rendering a dialog window to provide basic creation details.

            Parameters

            • documentCls: object

              Document class to create.

              -
            • Optional data: object

              Document data.

              -
            • Optional context: {
                  options?: Partial<any>;
                  pack?: object;
                  parent?: object;
                  renderSheet?: boolean;
              }

              Additional context options or dialog positioning options.

              -
              • Optional options?: Partial<any>

                Rest of options +

              • Optionaldata: object

                Document data.

                +
              • Optionalcontext: {
                    options?: Partial<any>;
                    pack?: object;
                    parent?: object;
                    renderSheet?: boolean;
                }

                Additional context options or dialog positioning options.

                +
                • Optionaloptions?: Partial<any>

                  Rest of options to pass to TJSDialog / Application.

                  -
                • Optional pack?: object

                  A Compendium pack identifier within which the Documents should be modified.

                  -
                • Optional parent?: object

                  A parent Document within which these Documents should be embedded.

                  -
                • Optional renderSheet?: boolean

                  Render the sheet for the new document.

                  -
              • Optional dialogData: any

                Optional data to modify dialog.

                -

            Returns TJSDocumentCreate

          Accessors

          data

          • get data(): TJSDialogData

          • Returns the dialog data.

            +
          • Optionalpack?: object

            A Compendium pack identifier within which the Documents should be modified.

            +
          • Optionalparent?: object

            A parent Document within which these Documents should be embedded.

            +
          • OptionalrenderSheet?: boolean

            Render the sheet for the new document.

            +
        • OptionaldialogData: any

          Optional data to modify dialog.

          +

          • Returns TJSDocumentCreate

          Accessors

          data

          elementContent

          • get elementContent(): HTMLElement

          • Returns the content element if an application shell is mounted.

            Returns HTMLElement

            Content element.

            @@ -43,74 +54,76 @@

          Returns ApplicationState

          The application state manager.

          svelte

          • get svelte(): GetSvelteData

          • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

            Returns GetSvelteData

            GetSvelteData

            -

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            +

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default maximizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default maximizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          minimize

          • minimize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for minimized.

            Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default minimizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default minimizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          onSvelteMount

          • onSvelteMount(mountedAppShell?): void

          • Provides a callback after all Svelte components are initialized.

            -

            Parameters

          onSvelteRemount

          • onSvelteRemount(mountedAppShell?): void

          • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

            -

            Parameters

          wait

          • wait<T>(options?): Promise<T>

          • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

            Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: null is returned if the dialog is closed without a user making a choice.

            -

            Type Parameters

            • T

            Parameters

            • Optional options: {
                  reuse?: boolean;
              }

              Options.

              -
              • Optional reuse?: boolean

                When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

                +

                Type Parameters

                • T

                Parameters

                • Optionaloptions: {
                      reuse?: boolean;
                  }

                  Options.

                  +
                  • Optionalreuse?: boolean

                    When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

                Returns Promise<T>

                A promise for dialog resolution.

                -

          Static confirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

          Staticconfirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

            -

            Type Parameters

            • T_1

            Parameters

            • Optional data: TJSDialogOptions & {
                  onNo?: string | ((data?) => any);
                  onYes?: string | ((data?) => any);
              }

              Confirm dialog options.

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Type Parameters

              • T_1

              Parameters

              • Optionaldata: TJSDialogOptions & {
                    onNo?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                    onYes?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                }

                Confirm dialog options.

                +
              • Optionaloptions: SvelteApplicationOptions

                SvelteApplication options passed to the TJSDialog +constructor.

              Returns Promise<T_1>

              A promise which resolves with result of yes / no callbacks or true / false.

              -

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
-
              -

          Static prompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            -

            Type Parameters

            • T_2

            Parameters

            • Optional data: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
+
              + +

          Staticprompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            +

            Type Parameters

            • T_2

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_2>

            The returned value from the provided callback function or true if the button - is pressed.

            -

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

          Static show

          • show(documentCls, data?, context?, dialogData?): Promise<object>

          • Create a new Document of the type specified by documentCls by rendering a dialog window to provide basic +is pressed.

            +

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

          Staticshow

          • show(documentCls, data?, context?, dialogData?): Promise<object>

          • Create a new Document of the type specified by documentCls by rendering a dialog window to provide basic creation details.

            Parameters

            • documentCls: object

              Document class to create.

              -
            • Optional data: object

              Document data.

              -
            • Optional context: {
                  options?: any;
                  pack?: object;
                  parent?: object;
                  renderSheet?: boolean;
              }

              Additional context options or dialog positioning options.

              -
              • Optional options?: any

                Rest of options - to pass to TJSDialog / Application.

                -
              • Optional pack?: object

                A Compendium pack identifier within which the Documents should be modified.

                -
              • Optional parent?: object

                A parent Document within which these Documents should be embedded.

                -
              • Optional renderSheet?: boolean

                Render the sheet for the new document.

                -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaldata: object

              Document data.

              +
            • Optionalcontext: {
                  options?: any;
                  pack?: object;
                  parent?: object;
                  renderSheet?: boolean;
              }

              Additional context options or dialog positioning options.

              +
              • Optionaloptions?: any

                Rest of options +to pass to TJSDialog / Application.

                +
              • Optionalpack?: object

                A Compendium pack identifier within which the Documents should be modified.

                +
              • Optionalparent?: object

                A parent Document within which these Documents should be embedded.

                +
              • OptionalrenderSheet?: boolean

                Render the sheet for the new document.

                +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<object>

            The newly created document or a falsy value; either 'false' for - cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static wait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          Staticwait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: By default null is returned if the dialog is closed without a user making a choice.

            Type Parameters

            • T_3

            Parameters

            Returns Promise<T_3>

            A Promise that resolves to the chosen result.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptshowwait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSDocumentDelete.html b/docs/classes/_standard_application_dialog_document.TJSDocumentDelete.html index 927ed476..a23b8397 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentDelete.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentDelete.html @@ -1,7 +1,18 @@ -TJSDocumentDelete | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSDocumentDelete

          Provides a reactive dialog for deleting documents that by default is modal and not draggable. An additional set of +TJSDocumentDelete | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSDocumentDelete

          Provides a reactive dialog for deleting documents that by default is modal and not draggable. An additional set of accessors for the document assigned are available via the this.reactive.document. You may swap out the document at any time by setting it to a different document.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          data elementContent elementTarget @@ -19,12 +30,12 @@ prompt show wait -

          Constructors

          constructor

          • new TJSDocumentDelete(document, opts?, dialogData?): TJSDocumentDelete

          • Parameters

            • document: object

              Document to delete.

              -
            • Optional opts: {
                  context?: object;
                  options?: any;
              }

              Additional context options or dialog positioning options.

              -
              • Optional context?: object

                DocumentModificationContext.

                -
              • Optional options?: any

                Rest of options to pass to TJSDialog / Application.

                -
            • Optional dialogData: any

              Optional data to modify dialog.

              -

            Returns TJSDocumentDelete

          Accessors

          data

          Constructors

          constructor

          • new TJSDocumentDelete(document, opts?, dialogData?): TJSDocumentDelete

          • Parameters

            • document: object

              Document to delete.

              +
            • Optionalopts: {
                  context?: object;
                  options?: any;
              }

              Additional context options or dialog positioning options.

              +
              • Optionalcontext?: object

                DocumentModificationContext.

                +
              • Optionaloptions?: any

                Rest of options to pass to TJSDialog / Application.

                +
            • OptionaldialogData: any

              Optional data to modify dialog.

              +

            Returns TJSDocumentDelete

          Accessors

          data

          elementContent

          • get elementContent(): HTMLElement

          • Returns the content element if an application shell is mounted.

            Returns HTMLElement

            Content element.

            @@ -39,70 +50,72 @@

          Returns ApplicationState

          The application state manager.

          svelte

          • get svelte(): GetSvelteData

          • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

            Returns GetSvelteData

            GetSvelteData

            -

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            +

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default maximizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default maximizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          minimize

          • minimize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for minimized.

            Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default minimizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default minimizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          onSvelteMount

          • onSvelteMount(mountedAppShell?): void

          • Provides a callback after all Svelte components are initialized.

            -

            Parameters

          onSvelteRemount

          • onSvelteRemount(mountedAppShell?): void

          • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

            -

            Parameters

          wait

          • wait<T>(options?): Promise<T>

          • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

            Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: null is returned if the dialog is closed without a user making a choice.

            -

            Type Parameters

            • T

            Parameters

            • Optional options: {
                  reuse?: boolean;
              }

              Options.

              -
              • Optional reuse?: boolean

                When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

                +

                Type Parameters

                • T

                Parameters

                • Optionaloptions: {
                      reuse?: boolean;
                  }

                  Options.

                  +
                  • Optionalreuse?: boolean

                    When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

                Returns Promise<T>

                A promise for dialog resolution.

                -

          Static confirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

          Staticconfirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

            -

            Type Parameters

            • T_1

            Parameters

            • Optional data: TJSDialogOptions & {
                  onNo?: string | ((data?) => any);
                  onYes?: string | ((data?) => any);
              }

              Confirm dialog options.

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Type Parameters

              • T_1

              Parameters

              • Optionaldata: TJSDialogOptions & {
                    onNo?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                    onYes?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                }

                Confirm dialog options.

                +
              • Optionaloptions: SvelteApplicationOptions

                SvelteApplication options passed to the TJSDialog +constructor.

              Returns Promise<T_1>

              A promise which resolves with result of yes / no callbacks or true / false.

              -

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
-
              -

          Static prompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            -

            Type Parameters

            • T_2

            Parameters

            • Optional data: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
+
              + +

          Staticprompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            +

            Type Parameters

            • T_2

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_2>

            The returned value from the provided callback function or true if the button - is pressed.

            -

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

          Static show

          • show(document, opts?, dialogData?): Promise<boolean | object>

          • Shows a modal / non-draggable dialog to delete a document.

            +is pressed.

            +

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

          Staticshow

          • show(document, opts?, dialogData?): Promise<boolean | object>

          • Shows a modal / non-draggable dialog to delete a document.

            Parameters

            • document: object

              Document to delete.

              -
            • Optional opts: {
                  context?: object;
                  options?: any;
              }

              Additional context options or dialog positioning options.

              -
              • Optional context?: object

                DocumentModificationContext.

                -
              • Optional options?: any

                Rest of options to pass to - TJSDialog / Application.

                -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionalopts: {
                  context?: object;
                  options?: any;
              }

              Additional context options or dialog positioning options.

              +
              • Optionalcontext?: object

                DocumentModificationContext.

                +
              • Optionaloptions?: any

                Rest of options to pass to +TJSDialog / Application.

                +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The document if deleted or a falsy value; either - 'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static wait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          Staticwait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: By default null is returned if the dialog is closed without a user making a choice.

            Type Parameters

            • T_3

            Parameters

            Returns Promise<T_3>

            A Promise that resolves to the chosen result.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptshowwait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSDocumentDialog.html b/docs/classes/_standard_application_dialog_document.TJSDocumentDialog.html index 7987ea5a..5214fe5c 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentDialog.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentDialog.html @@ -1,6 +1,7 @@ -TJSDocumentDialog | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSDocumentDialog

          Provides several methods to create documents, folders, and modify them through use of TJSDialog and a modal and +TJSDocumentDialog | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSDocumentDialog

          Provides several methods to create documents, folders, and modify them through use of TJSDialog and a modal and non-draggable by default user experience.

          -

          Constructors

          constructor +

          Constructors

          constructor

          Methods

          configureOwnership documentCreate documentDelete @@ -11,86 +12,86 @@ folderRolltable folderUpdate importFromJSON -

          Constructors

          constructor

          Methods

          Static configureOwnership

          • configureOwnership(document, options?, dialogData?): Promise<object>

          • Change ownership of a document by rendering a dialog to alter the default and all user / player ownership.

            +

          Constructors

          constructor

          Methods

          StaticconfigureOwnership

          • configureOwnership(document, options?, dialogData?): Promise<object>

          • Change ownership of a document by rendering a dialog to alter the default and all user / player ownership.

            Parameters

            • document: object

              Document instance to modify.

              -
            • Optional options: any

              Rest of options to pass to - TJSDialog / Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Rest of options to pass to +TJSDialog / Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<object>

            The modified document or 'null' if the user closed the - dialog via <Esc> or the close header button.

            -

          Static documentCreate

          • documentCreate(documentCls, data?, context?, dialogData?): Promise<object>

          • Create a new Document of the type specified by documentCls by rendering a dialog window to provide basic +dialog via <Esc> or the close header button.

            +

          StaticdocumentCreate

          • documentCreate(documentCls, data?, context?, dialogData?): Promise<object>

          • Create a new Document of the type specified by documentCls by rendering a dialog window to provide basic creation details.

            Parameters

            • documentCls: object

              Document class to create.

              -
            • Optional data: object

              Document data.

              -
            • Optional context: {
                  options?: any;
                  pack?: object;
                  parent?: object;
                  renderSheet?: boolean;
              }

              Additional context options or dialog positioning options.

              -
              • Optional options?: any

                Rest of options to pass - to TJSDialog / Application.

                -
              • Optional pack?: object

                A Compendium pack identifier within which the Documents should be modified.

                -
              • Optional parent?: object

                A parent Document within which these Documents should be embedded.

                -
              • Optional renderSheet?: boolean

                Render the sheet for the new document.

                -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaldata: object

              Document data.

              +
            • Optionalcontext: {
                  options?: any;
                  pack?: object;
                  parent?: object;
                  renderSheet?: boolean;
              }

              Additional context options or dialog positioning options.

              +
              • Optionaloptions?: any

                Rest of options to pass +to TJSDialog / Application.

                +
              • Optionalpack?: object

                A Compendium pack identifier within which the Documents should be modified.

                +
              • Optionalparent?: object

                A parent Document within which these Documents should be embedded.

                +
              • OptionalrenderSheet?: boolean

                Render the sheet for the new document.

                +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<object>

            The newly created document or a falsy value; either 'false' - for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static documentDelete

          • documentDelete(document, opts?, dialogData?): Promise<boolean | object>

          • Shows a modal / non-draggable dialog to delete a document.

            +for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          StaticdocumentDelete

          • documentDelete(document, opts?, dialogData?): Promise<boolean | object>

          • Shows a modal / non-draggable dialog to delete a document.

            Parameters

            • document: object

              Document to delete.

              -
            • Optional opts: {
                  context?: object;
                  options?: any;
              }

              Additional context options or dialog positioning options.

              -
              • Optional context?: object

                DocumentModificationContext.

                -
              • Optional options?: any

                Rest of options to pass - to TJSDialog / Application.

                -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionalopts: {
                  context?: object;
                  options?: any;
              }

              Additional context options or dialog positioning options.

              +
              • Optionalcontext?: object

                DocumentModificationContext.

                +
              • Optionaloptions?: any

                Rest of options to pass +to TJSDialog / Application.

                +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The document if deleted or a falsy value; either - 'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static folderCreate

          • folderCreate(folderData, options?, dialogData?): Promise<object>

          • Create a new Folder by rendering a dialog window to provide basic creation details.

            +'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          StaticfolderCreate

          • folderCreate(folderData, options?, dialogData?): Promise<object>

          • Create a new Folder by rendering a dialog window to provide basic creation details.

            Parameters

            • folderData: object

              Initial data with which to populate the creation form.

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<object>

            The newly created Folder or null if the dialog is closed.

            -

          Static folderDelete

          • folderDelete(document, options?, dialogData?): Promise<boolean | object>

          • Deletes a folder and does delete subfolders / documents.

            +

          StaticfolderDelete

          • folderDelete(document, options?, dialogData?): Promise<boolean | object>

          • Deletes a folder and does delete subfolders / documents.

            Parameters

            • document: object

              Folder to delete.

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The deleted Folder or a falsy value; either 'false' for - cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static folderExport

          • folderExport(document, opts?, dialogData?): Promise<boolean | object>

          • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

            +cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          StaticfolderExport

          • folderExport(document, opts?, dialogData?): Promise<boolean | object>

          • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

            Parameters

            • document: object

              Folder to export.

              -
            • Optional opts: {
                  keepId?: boolean;
                  merge?: boolean;
                  options?: any;
                  pack?: string;
              }

              Additional options.

              -
              • Optional keepId?: boolean

                Keep document IDs.

                -
              • Optional merge?: boolean

                Update existing entries in the Compendium pack, matching by name

                -
              • Optional options?: any

                Rest of options to pass to - TJSDialog / Application.

                -
              • Optional pack?: string

                The name of the compendium pack to provide an initial selection value in the dialog.

                -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionalopts: {
                  keepId?: boolean;
                  merge?: boolean;
                  options?: any;
                  pack?: string;
              }

              Additional options.

              +
              • OptionalkeepId?: boolean

                Keep document IDs.

                +
              • Optionalmerge?: boolean

                Update existing entries in the Compendium pack, matching by name

                +
              • Optionaloptions?: any

                Rest of options to pass to +TJSDialog / Application.

                +
              • Optionalpack?: string

                The name of the compendium pack to provide an initial selection value in the dialog.

                +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The compendium collection the folder is exported - to or a falsy value; either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> - or the close header button.

            -

          Static folderRemove

          • folderRemove(document, options?, dialogData?): Promise<boolean | object>

          • Removes a folder, but does not delete / remove sub-folders / documents.

            +to or a falsy value; either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> +or the close header button.

            +

          StaticfolderRemove

          • folderRemove(document, options?, dialogData?): Promise<boolean | object>

          • Removes a folder, but does not delete / remove sub-folders / documents.

            Parameters

            • document: object

              Folder to remove.

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The removed Folder or a falsy value; either 'false' for - cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static folderRolltable

          • folderRolltable(document, options?, dialogData?): Promise<boolean | object>

          • Create a RollTable from the contents of the Folder.

            +cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          StaticfolderRolltable

          • folderRolltable(document, options?, dialogData?): Promise<boolean | object>

          • Create a RollTable from the contents of the Folder.

            Parameters

            • document: object

              Folder to create roll table from...

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The newly created RollTable or a falsy value; either - 'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static folderUpdate

          • folderUpdate(document, options?, dialogData?): Promise<object>

          • Updates an existing Folder by rendering a dialog window with basic details.

            +'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          StaticfolderUpdate

          • folderUpdate(document, options?, dialogData?): Promise<object>

          • Updates an existing Folder by rendering a dialog window with basic details.

            Parameters

            • document: object

              The folder to edit.

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<object>

            The modified Folder or null if the dialog is closed.

            -

          Static importFromJSON

          • importFromJSON(document, options?, dialogData?): Promise<boolean | object>

          • Render an import dialog for updating the data related to this Document through an exported JSON file

            +

          StaticimportFromJSON

          • importFromJSON(document, options?, dialogData?): Promise<boolean | object>

          • Render an import dialog for updating the data related to this Document through an exported JSON file

            Parameters

            • document: object

              The document to import JSON to...

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The document after import completes or a falsy value; - either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header - button.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructorconfigureOwnershipdocumentCreatedocumentDeletefolderCreatefolderDeletefolderExportfolderRemovefolderRolltablefolderUpdateimportFromJSON
          \ No newline at end of file +either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header +button.

          +

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSDocumentImport.html b/docs/classes/_standard_application_dialog_document.TJSDocumentImport.html index fc785101..46bae73a 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentImport.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentImport.html @@ -1,7 +1,18 @@ -TJSDocumentImport | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSDocumentImport

          Provides a reactive dialog for importing documents that by default is modal and not draggable. An additional set of +TJSDocumentImport | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSDocumentImport

          Provides a reactive dialog for importing documents that by default is modal and not draggable. An additional set of accessors for the document assigned are available via the this.reactive.document. You may swap out the document at any time by setting it to a different document.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          data elementContent elementTarget @@ -19,12 +30,12 @@ prompt show wait -

          Constructors

          constructor

          • new TJSDocumentImport(document, options?, dialogData?): TJSDocumentImport

          • Render an import dialog for updating the data related to this Document through an exported JSON file

            +

          Constructors

          constructor

          • new TJSDocumentImport(document, options?, dialogData?): TJSDocumentImport

          • Render an import dialog for updating the data related to this Document through an exported JSON file

            Parameters

            • document: object

              The document to import JSON to...

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              -

            Returns TJSDocumentImport

          Accessors

          data

          • get data(): TJSDialogData

          • Returns the dialog data.

            +
          • Optionaloptions: any

            Options to pass to TJSDialog / +Application.

            +
          • OptionaldialogData: any

            Optional data to modify dialog.

            +

          Returns TJSDocumentImport

          Accessors

          data

          elementContent

          • get elementContent(): HTMLElement

          • Returns the content element if an application shell is mounted.

            Returns HTMLElement

            Content element.

            @@ -39,69 +50,71 @@

          Returns ApplicationState

          The application state manager.

          svelte

          • get svelte(): GetSvelteData

          • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

            Returns GetSvelteData

            GetSvelteData

            -

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            +

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default maximizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default maximizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          minimize

          • minimize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for minimized.

            Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default minimizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default minimizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          onSvelteMount

          • onSvelteMount(mountedAppShell?): void

          • Provides a callback after all Svelte components are initialized.

            -

            Parameters

          onSvelteRemount

          • onSvelteRemount(mountedAppShell?): void

          • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

            -

            Parameters

          wait

          • wait<T>(options?): Promise<T>

          • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

            Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: null is returned if the dialog is closed without a user making a choice.

            -

            Type Parameters

            • T

            Parameters

            • Optional options: {
                  reuse?: boolean;
              }

              Options.

              -
              • Optional reuse?: boolean

                When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

                +

                Type Parameters

                • T

                Parameters

                • Optionaloptions: {
                      reuse?: boolean;
                  }

                  Options.

                  +
                  • Optionalreuse?: boolean

                    When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

                Returns Promise<T>

                A promise for dialog resolution.

                -

          Static confirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

          Staticconfirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

            -

            Type Parameters

            • T_1

            Parameters

            • Optional data: TJSDialogOptions & {
                  onNo?: string | ((data?) => any);
                  onYes?: string | ((data?) => any);
              }

              Confirm dialog options.

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Type Parameters

              • T_1

              Parameters

              • Optionaldata: TJSDialogOptions & {
                    onNo?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                    onYes?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                }

                Confirm dialog options.

                +
              • Optionaloptions: SvelteApplicationOptions

                SvelteApplication options passed to the TJSDialog +constructor.

              Returns Promise<T_1>

              A promise which resolves with result of yes / no callbacks or true / false.

              -

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
-
              -

          Static prompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            -

            Type Parameters

            • T_2

            Parameters

            • Optional data: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
+
              + +

          Staticprompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            +

            Type Parameters

            • T_2

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_2>

            The returned value from the provided callback function or true if the button - is pressed.

            -

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

          Static show

          • show(document, options?, dialogData?): Promise<boolean | object>

          • Render an import dialog for updating the data related to this Document through an exported JSON file

            +is pressed.

            +

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

          Staticshow

          • show(document, options?, dialogData?): Promise<boolean | object>

          • Render an import dialog for updating the data related to this Document through an exported JSON file

            Parameters

            • document: object

              The document to import JSON to...

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The document after import completes or a falsy value; - either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header - button.

            -

          Static wait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header +button.

            +

          Staticwait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: By default null is returned if the dialog is closed without a user making a choice.

            Type Parameters

            • T_3

            Parameters

            Returns Promise<T_3>

            A Promise that resolves to the chosen result.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptshowwait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSDocumentOwnership.html b/docs/classes/_standard_application_dialog_document.TJSDocumentOwnership.html index 82a11f49..234f257b 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentOwnership.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentOwnership.html @@ -1,7 +1,18 @@ -TJSDocumentOwnership | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSDocumentOwnership

          Provides a reactive dialog for permission control that by default is modal and not draggable. An additional set of +TJSDocumentOwnership | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSDocumentOwnership

          Provides a reactive dialog for permission control that by default is modal and not draggable. An additional set of accessors for the document assigned are available via the this.reactive.document. You may swap out the document at any time by setting it to a different document.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          data elementContent elementTarget @@ -19,11 +30,11 @@ prompt show wait -

          Constructors

          constructor

          • new TJSDocumentOwnership(document, options?, dialogData?): TJSDocumentOwnership

          • Parameters

            • document: object

              Document instance to modify.

              -
            • Optional options: any

              Rest of options to pass to - TJSDialog / Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              -

            Returns TJSDocumentOwnership

          Accessors

          data

          Constructors

          constructor

          • new TJSDocumentOwnership(document, options?, dialogData?): TJSDocumentOwnership

          • Parameters

            • document: object

              Document instance to modify.

              +
            • Optionaloptions: any

              Rest of options to pass to +TJSDialog / Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

              +

            Returns TJSDocumentOwnership

          Accessors

          data

          elementContent

          • get elementContent(): HTMLElement

          • Returns the content element if an application shell is mounted.

            Returns HTMLElement

            Content element.

            @@ -38,68 +49,70 @@

          Returns ApplicationState

          The application state manager.

          svelte

          • get svelte(): GetSvelteData

          • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

            Returns GetSvelteData

            GetSvelteData

            -

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            +

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default maximizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default maximizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          minimize

          • minimize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for minimized.

            Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default minimizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default minimizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          onSvelteMount

          • onSvelteMount(mountedAppShell?): void

          • Provides a callback after all Svelte components are initialized.

            -

            Parameters

          onSvelteRemount

          • onSvelteRemount(mountedAppShell?): void

          • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

            -

            Parameters

          wait

          • wait<T>(options?): Promise<T>

          • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

            Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: null is returned if the dialog is closed without a user making a choice.

            -

            Type Parameters

            • T

            Parameters

            • Optional options: {
                  reuse?: boolean;
              }

              Options.

              -
              • Optional reuse?: boolean

                When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

                +

                Type Parameters

                • T

                Parameters

                • Optionaloptions: {
                      reuse?: boolean;
                  }

                  Options.

                  +
                  • Optionalreuse?: boolean

                    When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

                Returns Promise<T>

                A promise for dialog resolution.

                -

          Static confirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

          Staticconfirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

            -

            Type Parameters

            • T_1

            Parameters

            • Optional data: TJSDialogOptions & {
                  onNo?: string | ((data?) => any);
                  onYes?: string | ((data?) => any);
              }

              Confirm dialog options.

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Type Parameters

              • T_1

              Parameters

              • Optionaldata: TJSDialogOptions & {
                    onNo?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                    onYes?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                }

                Confirm dialog options.

                +
              • Optionaloptions: SvelteApplicationOptions

                SvelteApplication options passed to the TJSDialog +constructor.

              Returns Promise<T_1>

              A promise which resolves with result of yes / no callbacks or true / false.

              -

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
-
              -

          Static prompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            -

            Type Parameters

            • T_2

            Parameters

            • Optional data: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
+
              + +

          Staticprompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            +

            Type Parameters

            • T_2

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_2>

            The returned value from the provided callback function or true if the button - is pressed.

            -

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

          Static show

          • show(document, options?, dialogData?): Promise<object>

          • Change permissions of a document by rendering a dialog to alter the default and all user / player permissions.

            +is pressed.

            +

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

          Staticshow

          • show(document, options?, dialogData?): Promise<object>

          • Change permissions of a document by rendering a dialog to alter the default and all user / player permissions.

            Parameters

            • document: object

              Document instance to modify.

              -
            • Optional options: any

              Rest of options to pass to - TJSDialog / Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Rest of options to pass to +TJSDialog / Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<object>

            The modified document or 'null' if the user closed the dialog - via <Esc> or the close header button.

            -

          Static wait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +via <Esc> or the close header button.

            +

          Staticwait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: By default null is returned if the dialog is closed without a user making a choice.

            Type Parameters

            • T_3

            Parameters

            Returns Promise<T_3>

            A Promise that resolves to the chosen result.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptshowwait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSFolderCreateUpdate.html b/docs/classes/_standard_application_dialog_document.TJSFolderCreateUpdate.html index 0140d64b..4ab78687 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderCreateUpdate.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderCreateUpdate.html @@ -1,7 +1,18 @@ -TJSFolderCreateUpdate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSFolderCreateUpdate

          Provides a reactive dialog for modifying folders that by default is modal and not draggable. An additional set of +TJSFolderCreateUpdate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSFolderCreateUpdate

          Provides a reactive dialog for modifying folders that by default is modal and not draggable. An additional set of accessors for the folder assigned are available via the this.reactive.document. You may swap out the folder at any time by setting it to a different folder document.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          data elementContent elementTarget @@ -20,11 +31,11 @@ showCreate showUpdate wait -

          Constructors

          constructor

          • new TJSFolderCreateUpdate(document, options?, dialogData?): TJSFolderCreateUpdate

          • Updates an existing Folder by rendering a dialog window with basic details.

            +

          Constructors

          constructor

          • new TJSFolderCreateUpdate(document, options?, dialogData?): TJSFolderCreateUpdate

          • Updates an existing Folder by rendering a dialog window with basic details.

            Parameters

            • document: object

              The folder to edit.

              -
            • Optional options: object

              Options to pass to TJSDialog / Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              -

            Returns TJSFolderCreateUpdate

          Accessors

          data

          • get data(): TJSDialogData

          • Returns the dialog data.

            +
          • Optionaloptions: object

            Options to pass to TJSDialog / Application.

            +
          • OptionaldialogData: any

            Optional data to modify dialog.

            +

          Returns TJSFolderCreateUpdate

          Accessors

          data

          elementContent

          • get elementContent(): HTMLElement

          • Returns the content element if an application shell is mounted.

            Returns HTMLElement

            Content element.

            @@ -39,71 +50,73 @@

          Returns ApplicationState

          The application state manager.

          svelte

          • get svelte(): GetSvelteData

          • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

            Returns GetSvelteData

            GetSvelteData

            -

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            +

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default maximizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default maximizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          minimize

          • minimize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for minimized.

            Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default minimizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default minimizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          onSvelteMount

          • onSvelteMount(mountedAppShell?): void

          • Provides a callback after all Svelte components are initialized.

            -

            Parameters

          onSvelteRemount

          • onSvelteRemount(mountedAppShell?): void

          • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

            -

            Parameters

          wait

          • wait<T>(options?): Promise<T>

          • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

            Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: null is returned if the dialog is closed without a user making a choice.

            -

            Type Parameters

            • T

            Parameters

            • Optional options: {
                  reuse?: boolean;
              }

              Options.

              -
              • Optional reuse?: boolean

                When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

                +

                Type Parameters

                • T

                Parameters

                • Optionaloptions: {
                      reuse?: boolean;
                  }

                  Options.

                  +
                  • Optionalreuse?: boolean

                    When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

                Returns Promise<T>

                A promise for dialog resolution.

                -

          Static confirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

          Staticconfirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

            -

            Type Parameters

            • T_1

            Parameters

            • Optional data: TJSDialogOptions & {
                  onNo?: string | ((data?) => any);
                  onYes?: string | ((data?) => any);
              }

              Confirm dialog options.

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Type Parameters

              • T_1

              Parameters

              • Optionaldata: TJSDialogOptions & {
                    onNo?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                    onYes?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                }

                Confirm dialog options.

                +
              • Optionaloptions: SvelteApplicationOptions

                SvelteApplication options passed to the TJSDialog +constructor.

              Returns Promise<T_1>

              A promise which resolves with result of yes / no callbacks or true / false.

              -

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
-
              -

          Static prompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            -

            Type Parameters

            • T_2

            Parameters

            • Optional data: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
+
              + +

          Staticprompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            +

            Type Parameters

            • T_2

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_2>

            The returned value from the provided callback function or true if the button - is pressed.

            -

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

          Static showCreate

          • showCreate(folderData, options?, dialogData?): Promise<object>

          • Create a new Folder by rendering a dialog window to provide basic creation details.

            +is pressed.

            +

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

          StaticshowCreate

          • showCreate(folderData, options?, dialogData?): Promise<object>

          • Create a new Folder by rendering a dialog window to provide basic creation details.

            Parameters

            • folderData: object

              Initial data with which to populate the creation form.

              -
            • Optional options: object

              Options to pass to TJSDialog / Application.

              -
            • Optional dialogData: object

              Optional data to modify dialog.

              +
            • Optionaloptions: object

              Options to pass to TJSDialog / Application.

              +
            • OptionaldialogData: object

              Optional data to modify dialog.

            Returns Promise<object>

            The newly created Folder or null if the dialog is closed.

            -

          Static showUpdate

          • showUpdate(document, options?, dialogData?): Promise<object>

          • Updates an existing Folder by rendering a dialog window with basic details.

            +

          StaticshowUpdate

          • showUpdate(document, options?, dialogData?): Promise<object>

          • Updates an existing Folder by rendering a dialog window with basic details.

            Parameters

            • document: object

              The folder to edit.

              -
            • Optional options: object

              Options to pass to TJSDialog / Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: object

              Options to pass to TJSDialog / Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<object>

            The modified Folder or null if the dialog is closed.

            -

          Static wait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

          Staticwait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: By default null is returned if the dialog is closed without a user making a choice.

            Type Parameters

            • T_3

            Parameters

            Returns Promise<T_3>

            A Promise that resolves to the chosen result.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptshowCreateshowUpdatewait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSFolderDelete.html b/docs/classes/_standard_application_dialog_document.TJSFolderDelete.html index 74ccc343..daa2c269 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderDelete.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderDelete.html @@ -1,7 +1,18 @@ -TJSFolderDelete | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSFolderDelete

          Provides a reactive dialog for deleting a folder that by default is modal and not draggable. An additional set of +TJSFolderDelete | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSFolderDelete

          Provides a reactive dialog for deleting a folder that by default is modal and not draggable. An additional set of accessors for the folder assigned are available via the this.reactive.document. You may swap out the folder at any time by setting it to a different folder document.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          data elementContent elementTarget @@ -19,12 +30,12 @@ prompt show wait -

          Constructors

          constructor

          • new TJSFolderDelete(document, options?, dialogData?): TJSFolderDelete

          • Deletes a folder and does delete sub-folders / documents.

            +

          Constructors

          constructor

          • new TJSFolderDelete(document, options?, dialogData?): TJSFolderDelete

          • Deletes a folder and does delete sub-folders / documents.

            Parameters

            • document: object

              Folder to delete.

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              -

            Returns TJSFolderDelete

          Accessors

          data

          • get data(): TJSDialogData

          • Returns the dialog data.

            +
          • Optionaloptions: any

            Options to pass to TJSDialog / +Application.

            +
          • OptionaldialogData: any

            Optional data to modify dialog.

            +

          Returns TJSFolderDelete

          Accessors

          data

          elementContent

          • get elementContent(): HTMLElement

          • Returns the content element if an application shell is mounted.

            Returns HTMLElement

            Content element.

            @@ -39,68 +50,70 @@

          Returns ApplicationState

          The application state manager.

          svelte

          • get svelte(): GetSvelteData

          • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

            Returns GetSvelteData

            GetSvelteData

            -

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            +

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default maximizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default maximizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          minimize

          • minimize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for minimized.

            Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default minimizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default minimizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          onSvelteMount

          • onSvelteMount(mountedAppShell?): void

          • Provides a callback after all Svelte components are initialized.

            -

            Parameters

          onSvelteRemount

          • onSvelteRemount(mountedAppShell?): void

          • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

            -

            Parameters

          wait

          • wait<T>(options?): Promise<T>

          • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

            Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: null is returned if the dialog is closed without a user making a choice.

            -

            Type Parameters

            • T

            Parameters

            • Optional options: {
                  reuse?: boolean;
              }

              Options.

              -
              • Optional reuse?: boolean

                When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

                +

                Type Parameters

                • T

                Parameters

                • Optionaloptions: {
                      reuse?: boolean;
                  }

                  Options.

                  +
                  • Optionalreuse?: boolean

                    When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

                Returns Promise<T>

                A promise for dialog resolution.

                -

          Static confirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

          Staticconfirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

            -

            Type Parameters

            • T_1

            Parameters

            • Optional data: TJSDialogOptions & {
                  onNo?: string | ((data?) => any);
                  onYes?: string | ((data?) => any);
              }

              Confirm dialog options.

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Type Parameters

              • T_1

              Parameters

              • Optionaldata: TJSDialogOptions & {
                    onNo?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                    onYes?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                }

                Confirm dialog options.

                +
              • Optionaloptions: SvelteApplicationOptions

                SvelteApplication options passed to the TJSDialog +constructor.

              Returns Promise<T_1>

              A promise which resolves with result of yes / no callbacks or true / false.

              -

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
-
              -

          Static prompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            -

            Type Parameters

            • T_2

            Parameters

            • Optional data: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
+
              + +

          Staticprompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            +

            Type Parameters

            • T_2

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_2>

            The returned value from the provided callback function or true if the button - is pressed.

            -

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

          Static show

          • show(document, options?, dialogData?): Promise<boolean | object>

          • Deletes a folder and does delete sub-folders / documents.

            +is pressed.

            +

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

          Staticshow

          • show(document, options?, dialogData?): Promise<boolean | object>

          • Deletes a folder and does delete sub-folders / documents.

            Parameters

            • document: object

              Folder to delete.

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The deleted Folder or a falsy value; either 'false' for - cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static wait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          Staticwait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: By default null is returned if the dialog is closed without a user making a choice.

            Type Parameters

            • T_3

            Parameters

            Returns Promise<T_3>

            A Promise that resolves to the chosen result.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptshowwait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSFolderExport.html b/docs/classes/_standard_application_dialog_document.TJSFolderExport.html index 087f712b..d885c17d 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderExport.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderExport.html @@ -1,5 +1,16 @@ -TJSFolderExport | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSFolderExport

          Provides a reactive dialog for exporting folders to a compendium that by default is modal and not draggable.

          -

          Hierarchy (view full)

          Constructors

          constructor +TJSFolderExport | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSFolderExport

          Provides a reactive dialog for exporting folders to a compendium that by default is modal and not draggable.

          +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          data elementContent elementTarget @@ -17,19 +28,19 @@ prompt show wait -

          Constructors

          constructor

          • new TJSFolderExport(document, opts?, dialogData?): TJSFolderExport

          • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

            +

          Constructors

          constructor

          • new TJSFolderExport(document, opts?, dialogData?): TJSFolderExport

          • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

            Parameters

            • document: object

              Folder to export.

              -
            • Optional opts: {
                  keepId?: boolean;
                  merge?: boolean;
                  options?: any;
                  pack?: string;
              }

              Additional options.

              -
              • Optional keepId?: boolean

                Keep document IDs.

                -
              • Optional merge?: boolean

                Update existing entries in the Compendium pack, matching by name

                -
              • Optional options?: any

                Rest of options to pass to - TJSDialog / Application.

                -
              • Optional pack?: string

                The name of the compendium pack to provide an initial selection value in the dialog.

                -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionalopts: {
                  keepId?: boolean;
                  merge?: boolean;
                  options?: any;
                  pack?: string;
              }

              Additional options.

              +
              • OptionalkeepId?: boolean

                Keep document IDs.

                +
              • Optionalmerge?: boolean

                Update existing entries in the Compendium pack, matching by name

                +
              • Optionaloptions?: any

                Rest of options to pass to +TJSDialog / Application.

                +
              • Optionalpack?: string

                The name of the compendium pack to provide an initial selection value in the dialog.

                +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns TJSFolderExport

            The compendium collection the folder is exported - to or a falsy value; either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> - or the close header button.

            -

          Accessors

          data

          • get data(): TJSDialogData

          • Returns the dialog data.

            +to or a falsy value; either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> +or the close header button.

            +

          Accessors

          data

          elementContent

          • get elementContent(): HTMLElement

          • Returns the content element if an application shell is mounted.

            Returns HTMLElement

            Content element.

            @@ -44,73 +55,75 @@

          Returns ApplicationState

          The application state manager.

          svelte

          • get svelte(): GetSvelteData

          • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

            Returns GetSvelteData

            GetSvelteData

            -

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            +

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default maximizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default maximizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          minimize

          • minimize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for minimized.

            Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default minimizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default minimizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          onSvelteMount

          • onSvelteMount(mountedAppShell?): void

          • Provides a callback after all Svelte components are initialized.

            -

            Parameters

          onSvelteRemount

          • onSvelteRemount(mountedAppShell?): void

          • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

            -

            Parameters

          wait

          • wait<T>(options?): Promise<T>

          • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

            Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: null is returned if the dialog is closed without a user making a choice.

            -

            Type Parameters

            • T

            Parameters

            • Optional options: {
                  reuse?: boolean;
              }

              Options.

              -
              • Optional reuse?: boolean

                When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

                +

                Type Parameters

                • T

                Parameters

                • Optionaloptions: {
                      reuse?: boolean;
                  }

                  Options.

                  +
                  • Optionalreuse?: boolean

                    When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

                Returns Promise<T>

                A promise for dialog resolution.

                -

          Static confirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

          Staticconfirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

            -

            Type Parameters

            • T_1

            Parameters

            • Optional data: TJSDialogOptions & {
                  onNo?: string | ((data?) => any);
                  onYes?: string | ((data?) => any);
              }

              Confirm dialog options.

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Type Parameters

              • T_1

              Parameters

              • Optionaldata: TJSDialogOptions & {
                    onNo?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                    onYes?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                }

                Confirm dialog options.

                +
              • Optionaloptions: SvelteApplicationOptions

                SvelteApplication options passed to the TJSDialog +constructor.

              Returns Promise<T_1>

              A promise which resolves with result of yes / no callbacks or true / false.

              -

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
-
              -

          Static prompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            -

            Type Parameters

            • T_2

            Parameters

            • Optional data: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
+
              + +

          Staticprompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            +

            Type Parameters

            • T_2

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_2>

            The returned value from the provided callback function or true if the button - is pressed.

            -

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

          Static show

          • show(document, opts?, dialogData?): Promise<boolean | object>

          • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

            +is pressed.

            +

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

          Staticshow

          • show(document, opts?, dialogData?): Promise<boolean | object>

          • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

            Parameters

            • document: object

              Folder to export.

              -
            • Optional opts: {
                  keepId?: boolean;
                  merge?: boolean;
                  options?: any;
                  pack?: string;
              }

              Additional options.

              -
              • Optional keepId?: boolean

                Keep document IDs.

                -
              • Optional merge?: boolean

                Update existing entries in the Compendium pack, matching by name

                -
              • Optional options?: any

                Rest of options to pass to - TJSDialog / Application.

                -
              • Optional pack?: string

                The name of the compendium pack to provide an initial selection value in the dialog.

                -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionalopts: {
                  keepId?: boolean;
                  merge?: boolean;
                  options?: any;
                  pack?: string;
              }

              Additional options.

              +
              • OptionalkeepId?: boolean

                Keep document IDs.

                +
              • Optionalmerge?: boolean

                Update existing entries in the Compendium pack, matching by name

                +
              • Optionaloptions?: any

                Rest of options to pass to +TJSDialog / Application.

                +
              • Optionalpack?: string

                The name of the compendium pack to provide an initial selection value in the dialog.

                +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The compendium collection the folder is exported - to or a falsy value; either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> - or the close header button.

            -

          Static wait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +to or a falsy value; either 'false' for cancelling or 'null' if the user closed the dialog via <Esc> +or the close header button.

            +

          Staticwait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: By default null is returned if the dialog is closed without a user making a choice.

            Type Parameters

            • T_3

            Parameters

            Returns Promise<T_3>

            A Promise that resolves to the chosen result.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptshowwait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSFolderRemove.html b/docs/classes/_standard_application_dialog_document.TJSFolderRemove.html index e682582f..48b33dca 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderRemove.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderRemove.html @@ -1,7 +1,18 @@ -TJSFolderRemove | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSFolderRemove

          Provides a reactive dialog for removing a folder that by default is modal and not draggable. An additional set of +TJSFolderRemove | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSFolderRemove

          Provides a reactive dialog for removing a folder that by default is modal and not draggable. An additional set of accessors for the folder assigned are available via the this.reactive.document. You may swap out the folder at any time by setting it to a different folder document.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          data elementContent elementTarget @@ -19,11 +30,11 @@ prompt show wait -

          Constructors

          constructor

          • new TJSFolderRemove(document, options?, dialogData?): TJSFolderRemove

          • Parameters

            • document: object

              Folder to remove.

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              -

            Returns TJSFolderRemove

          Accessors

          data

          Constructors

          constructor

          • new TJSFolderRemove(document, options?, dialogData?): TJSFolderRemove

          • Parameters

            • document: object

              Folder to remove.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

              +

            Returns TJSFolderRemove

          Accessors

          data

          elementContent

          • get elementContent(): HTMLElement

          • Returns the content element if an application shell is mounted.

            Returns HTMLElement

            Content element.

            @@ -38,68 +49,70 @@

          Returns ApplicationState

          The application state manager.

          svelte

          • get svelte(): GetSvelteData

          • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

            Returns GetSvelteData

            GetSvelteData

            -

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            +

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default maximizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default maximizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          minimize

          • minimize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for minimized.

            Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default minimizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default minimizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          onSvelteMount

          • onSvelteMount(mountedAppShell?): void

          • Provides a callback after all Svelte components are initialized.

            -

            Parameters

          onSvelteRemount

          • onSvelteRemount(mountedAppShell?): void

          • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

            -

            Parameters

          wait

          • wait<T>(options?): Promise<T>

          • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

            Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: null is returned if the dialog is closed without a user making a choice.

            -

            Type Parameters

            • T

            Parameters

            • Optional options: {
                  reuse?: boolean;
              }

              Options.

              -
              • Optional reuse?: boolean

                When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

                +

                Type Parameters

                • T

                Parameters

                • Optionaloptions: {
                      reuse?: boolean;
                  }

                  Options.

                  +
                  • Optionalreuse?: boolean

                    When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

                Returns Promise<T>

                A promise for dialog resolution.

                -

          Static confirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

          Staticconfirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

            -

            Type Parameters

            • T_1

            Parameters

            • Optional data: TJSDialogOptions & {
                  onNo?: string | ((data?) => any);
                  onYes?: string | ((data?) => any);
              }

              Confirm dialog options.

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Type Parameters

              • T_1

              Parameters

              • Optionaldata: TJSDialogOptions & {
                    onNo?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                    onYes?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                }

                Confirm dialog options.

                +
              • Optionaloptions: SvelteApplicationOptions

                SvelteApplication options passed to the TJSDialog +constructor.

              Returns Promise<T_1>

              A promise which resolves with result of yes / no callbacks or true / false.

              -

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
-
              -

          Static prompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            -

            Type Parameters

            • T_2

            Parameters

            • Optional data: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
+
              + +

          Staticprompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            +

            Type Parameters

            • T_2

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_2>

            The returned value from the provided callback function or true if the button - is pressed.

            -

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

          Static show

          • show(document, options?, dialogData?): Promise<boolean | object>

          • Removes a folder, but does not delete / remove subfolders / documents.

            +is pressed.

            +

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

          Staticshow

          • show(document, options?, dialogData?): Promise<boolean | object>

          • Removes a folder, but does not delete / remove subfolders / documents.

            Parameters

            • document: object

              Folder to remove.

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The removed Folder or a falsy value; either 'false' for - cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static wait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          Staticwait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: By default null is returned if the dialog is closed without a user making a choice.

            Type Parameters

            • T_3

            Parameters

            Returns Promise<T_3>

            A Promise that resolves to the chosen result.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptshowwait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_application_dialog_document.TJSFolderRolltable.html b/docs/classes/_standard_application_dialog_document.TJSFolderRolltable.html index 7d1b049b..1ca8f885 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderRolltable.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderRolltable.html @@ -1,7 +1,18 @@ -TJSFolderRolltable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSFolderRolltable

          Provides a reactive dialog for creating a RollTable from a folder that by default is modal and not draggable. An +TJSFolderRolltable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSFolderRolltable

          Provides a reactive dialog for creating a RollTable from a folder that by default is modal and not draggable. An additional set of accessors for the folder assigned are available via the this.reactive.document. You may swap out the folder at any time by setting it to a different folder document.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          data elementContent elementTarget @@ -19,11 +30,11 @@ prompt show wait -

          Constructors

          constructor

          • new TJSFolderRolltable(document, options?, dialogData?): TJSFolderRolltable

          • Parameters

            • document: object

              Folder to create roll table from...

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              -

            Returns TJSFolderRolltable

          Accessors

          data

          Constructors

          constructor

          • new TJSFolderRolltable(document, options?, dialogData?): TJSFolderRolltable

          • Parameters

            • document: object

              Folder to create roll table from...

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

              +

            Returns TJSFolderRolltable

          Accessors

          data

          elementContent

          • get elementContent(): HTMLElement

          • Returns the content element if an application shell is mounted.

            Returns HTMLElement

            Content element.

            @@ -38,68 +49,70 @@

          Returns ApplicationState

          The application state manager.

          svelte

          • get svelte(): GetSvelteData

          • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

            Returns GetSvelteData

            GetSvelteData

            -

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            +

          Methods

          maximize

          • maximize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for maximized.

            Note: the sanity check is duplicated from Application.maximize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default maximizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default maximizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          minimize

          • minimize(opts?): Promise<void>

          • Provides a mechanism to update the UI options store for minimized.

            Note: the sanity check is duplicated from Application.minimize the store is updated before performing the rest of animations. This allows application shells to remove / show any resize handlers correctly. Extra constraint data is stored in a saved position state in SvelteApplication.minimize to animate the content area.

            -

            Parameters

            • Optional opts: {
                  animate?: boolean;
                  duration?: number;
              }

              Optional parameters.

              -
              • Optional animate?: boolean

                When true perform default minimizing animation.

                -
              • Optional duration?: number

                Controls content area animation duration in seconds.

                +

                Parameters

                • Optionalopts: {
                      animate?: boolean;
                      duration?: number;
                  }

                  Optional parameters.

                  +
                  • Optionalanimate?: boolean

                    When true perform default minimizing animation.

                    +
                  • Optionalduration?: number

                    Controls content area animation duration in seconds.

                Returns Promise<void>

          onSvelteMount

          • onSvelteMount(mountedAppShell?): void

          • Provides a callback after all Svelte components are initialized.

            -

            Parameters

          onSvelteRemount

          • onSvelteRemount(mountedAppShell?): void

          • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module replacement or directly invoked from the elementRootUpdate callback passed to the application shell component context.

            -

            Parameters

          wait

          • wait<T>(options?): Promise<T>

          • Brings to top or renders this dialog returning a Promise that is resolved any button pressed or when the dialog is closed.

            Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: null is returned if the dialog is closed without a user making a choice.

            -

            Type Parameters

            • T

            Parameters

            • Optional options: {
                  reuse?: boolean;
              }

              Options.

              -
              • Optional reuse?: boolean

                When true if there is an existing managed Promise this allows multiple - sources to await on the same result.

                +

                Type Parameters

                • T

                Parameters

                • Optionaloptions: {
                      reuse?: boolean;
                  }

                  Options.

                  +
                  • Optionalreuse?: boolean

                    When true if there is an existing managed Promise this allows multiple +sources to await on the same result.

                Returns Promise<T>

                A promise for dialog resolution.

                -

          Static confirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

          Staticconfirm

          • confirm<T_1>(data?, options?): Promise<T_1>

          • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. If you require more flexibility, a custom TJSDialog instance is preferred. The default focused button is 'yes'. You can change the default focused button by setting default to yes or no.

            -

            Type Parameters

            • T_1

            Parameters

            • Optional data: TJSDialogOptions & {
                  onNo?: string | ((data?) => any);
                  onYes?: string | ((data?) => any);
              }

              Confirm dialog options.

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Type Parameters

              • T_1

              Parameters

              • Optionaldata: TJSDialogOptions & {
                    onNo?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                    onYes?: string | ((data?: {
                        application?: TJSDialog;
                    }) => any);
                }

                Confirm dialog options.

                +
              • Optionaloptions: SvelteApplicationOptions

                SvelteApplication options passed to the TJSDialog +constructor.

              Returns Promise<T_1>

              A promise which resolves with result of yes / no callbacks or true / false.

              -

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
-
              -

          Static prompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            -

            Type Parameters

            • T_2

            Parameters

            • Optional data: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              -
            • Optional options: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog - constructor.

              +

              Example

              const result = await TJSDialog.confirm({
               title: 'A Yes or No Question',
               content: '<p>Choose wisely.</p>',
               onYes: () => 'YES Result',
               onNo: () => 'NO Result'
              });

              // Logs 'YES result', 'NO Result', or null if the user closed the dialog without making a selection.
              console.log(result);
+
              + +

          Staticprompt

          • prompt<T_2>(data?, options?): Promise<T_2>

          • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

            +

            Type Parameters

            • T_2

            Parameters

            • Optionaldata: TJSDialogOptions & {
                  icon?: string;
                  label?: string;
                  onOk?: string | ((data?: {
                      application?: TJSDialog;
                  }) => any);
              }

              Prompt dialog options that includes any TJSDialog options along with the following optional fields:

              +
            • Optionaloptions: SvelteApplicationOptions

              SvelteApplication options passed to the TJSDialog +constructor.

            Returns Promise<T_2>

            The returned value from the provided callback function or true if the button - is pressed.

            -

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
-
            -

          Static show

          • show(document, options?, dialogData?): Promise<boolean | object>

          • Create a RollTable from the contents of the Folder.

            +is pressed.

            +

            Example

            const result = await TJSDialog.prompt({
             title: 'Are you OK?',
             content: '<p>Are you OK?.</p>',
             label: 'Feeling Fine!',
             onOk: () => 'OK'
            });

            // Logs 'OK' or null if the user closed the dialog without making a selection.
            console.log(result);
+
            + +

          Staticshow

          • show(document, options?, dialogData?): Promise<boolean | object>

          • Create a RollTable from the contents of the Folder.

            Parameters

            • document: object

              Folder to create roll table from...

              -
            • Optional options: any

              Options to pass to TJSDialog / - Application.

              -
            • Optional dialogData: any

              Optional data to modify dialog.

              +
            • Optionaloptions: any

              Options to pass to TJSDialog / +Application.

              +
            • OptionaldialogData: any

              Optional data to modify dialog.

            Returns Promise<boolean | object>

            The newly created RollTable or a falsy value; either - 'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            -

          Static wait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +'false' for cancelling or 'null' if the user closed the dialog via <Esc> or the close header button.

            +

          Staticwait

          • wait<T_3>(data, options?): Promise<T_3>

          • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a choice.

            Note: By default null is returned if the dialog is closed without a user making a choice.

            Type Parameters

            • T_3

            Parameters

            Returns Promise<T_3>

            A Promise that resolves to the chosen result.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructordataelementContentelementTargetmanagedPromisepositionreactivestatesveltemaximizeminimizeonSvelteMountonSvelteRemountwaitconfirmpromptshowwait
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSButton.html b/docs/classes/_standard_component.TJSButton.html index 477987a7..43dadc2f 100644 --- a/docs/classes/_standard_component.TJSButton.html +++ b/docs/classes/_standard_component.TJSButton.html @@ -1,6 +1,17 @@ -TJSButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSButton

          TODO: Add description

          -

          Hierarchy (view full)

          Constructors

          constructor +TJSButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSButton

          TODO: Add description

          +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSColordButton.html b/docs/classes/_standard_component.TJSColordButton.html index 1fca776b..569f6900 100644 --- a/docs/classes/_standard_component.TJSColordButton.html +++ b/docs/classes/_standard_component.TJSColordButton.html @@ -1,7 +1,19 @@ -TJSColordButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSColordButton

          --tjs-default-text-shadow-focus-hover: system default
          --tjs-default-outline-focus-visible: undefined; global replacement for focus-visible outline.

          --tjs-button-background
          --tjs-button-background-focus-visible
          --tjs-button-background-hover
          --tjs-button-background-selected
          --tjs-button-border
          --tjs-button-border-radius
          --tjs-button-border-width
          --tjs-button-box-shadow-focus-visible
          --tjs-button-clip-path
          --tjs-button-clip-path-focus
          --tjs-button-clip-path-hover
          --tjs-button-cursor
          --tjs-button-diameter
          --tjs-button-outline-focus-visible
          --tjs-button-text-shadow-focus: undefined
          --tjs-button-text-shadow-hover: undefined
          --tjs-button-transition
          --tjs-button-transition-focus-visible

          --tjs-icon-button-background
          --tjs-icon-button-background-focus-visible
          --tjs-icon-button-background-hover
          --tjs-icon-button-background-selected
          --tjs-icon-button-border
          --tjs-icon-button-border-radius
          --tjs-icon-button-border-width
          --tjs-icon-button-box-shadow-focus-visible
          --tjs-icon-button-clip-path
          --tjs-icon-button-clip-path-focus
          --tjs-icon-button-clip-path-hover
          --tjs-icon-button-cursor
          --tjs-icon-button-diameter
          --tjs-icon-button-outline-focus-visible
          --tjs-icon-button-text-shadow-focus: undefined
          --tjs-icon-button-text-shadow-hover: undefined
          --tjs-icon-button-transition
          --tjs-icon-button-transition-focus-visible
+TJSColordButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          
+
          Class TJSColordButton
          --tjs-default-text-shadow-focus-hover: system default
          --tjs-default-outline-focus-visible: undefined; global replacement for focus-visible outline.

          --tjs-button-background
          --tjs-button-background-focus-visible
          --tjs-button-background-hover
          --tjs-button-background-selected
          --tjs-button-border
          --tjs-button-border-radius
          --tjs-button-border-width
          --tjs-button-box-shadow-focus-visible
          --tjs-button-clip-path
          --tjs-button-clip-path-focus
          --tjs-button-clip-path-hover
          --tjs-button-cursor
          --tjs-button-diameter
          --tjs-button-outline-focus-visible
          --tjs-button-text-shadow-focus: undefined
          --tjs-button-text-shadow-hover: undefined
          --tjs-button-transition
          --tjs-button-transition-focus-visible

          --tjs-icon-button-background
          --tjs-icon-button-background-focus-visible
          --tjs-icon-button-background-hover
          --tjs-icon-button-background-selected
          --tjs-icon-button-border
          --tjs-icon-button-border-radius
          --tjs-icon-button-border-width
          --tjs-icon-button-box-shadow-focus-visible
          --tjs-icon-button-clip-path
          --tjs-icon-button-clip-path-focus
          --tjs-icon-button-clip-path-hover
          --tjs-icon-button-cursor
          --tjs-icon-button-diameter
          --tjs-icon-button-outline-focus-visible
          --tjs-icon-button-text-shadow-focus: undefined
          --tjs-icon-button-text-shadow-hover: undefined
          --tjs-icon-button-transition
          --tjs-icon-button-transition-focus-visible
 
          
-
          Hierarchy (view full)
          Constructors
          constructor
+
+
          
+            
          
+              
+                 
          
+                    
+                  Hierarchy
          
+                        
+              
          
+              
          
+           
          
+         
          Constructors
          constructor
 
          Methods
          $destroy
 $on
 $set
-
          Constructors
          constructor
          Methods
          $destroy
          $on
          • $on<K>(type, callback): (() => void)
          • Type Parameters
            • K extends string
            Parameters
            Returns (() => void)
              • (): void
              • Returns void
          $set
          Settings
          Member Visibility
          Theme
          On This Page
          constructor$destroy$on$set
          
\ No newline at end of file
+

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSColordPicker.html b/docs/classes/_standard_component.TJSColordPicker.html index 85793d13..3dd540e6 100644 --- a/docs/classes/_standard_component.TJSColordPicker.html +++ b/docs/classes/_standard_component.TJSColordPicker.html @@ -1,10 +1,21 @@ -TJSColordPicker | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSColordPicker

          TODO: Finish documentation.

          +TJSColordPicker | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSColordPicker

          TODO: Finish documentation.

          Events:

          • color: current color
          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSColordPickerSavedColors.html b/docs/classes/_standard_component.TJSColordPickerSavedColors.html index 79af8582..ece8fa4c 100644 --- a/docs/classes/_standard_component.TJSColordPickerSavedColors.html +++ b/docs/classes/_standard_component.TJSColordPickerSavedColors.html @@ -1,14 +1,15 @@ -TJSColordPickerSavedColors | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSColordPickerSavedColors

          Provides the main addon example for TJSColordPicker. Addons allow extension of the color picker. This addon provides +TJSColordPickerSavedColors | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSColordPickerSavedColors

          Provides the main addon example for TJSColordPicker. Addons allow extension of the color picker. This addon provides session storage for saving / restoring colors.

          An oddon for TJSColordPicker must provide a static accessor for a unique id and also provide a TJSFolderData object via a folderData accessor.

          -

          Constructors

          constructor +

          Constructors

          constructor

          Accessors

          folderData savedColorsState id

          Methods

          destroy -

          Constructors

          constructor

          Accessors

          folderData

          Constructors

          constructor

          Accessors

          folderData

          • get folderData(): TJSFolderData

          • Returns TJSFolderData

            The TJSFolderData object to configure the TJSSvgFolder component the addon is installed into.

          savedColorsState

          • get savedColorsState(): SavedColorsState

          • Returns SavedColorsState

            Gets SavedColorState data.

            -

          Static id

          • get id(): string

          • Returns string

            ID of the addon.

            -

          Methods

          destroy

          • destroy(): void

          • Returns void

          Settings

          Member Visibility

          Theme

          On This Page

          constructorfolderDatasavedColorsStateiddestroy
          \ No newline at end of file +

          Staticid

          • get id(): string

          • Returns string

            ID of the addon.

            +

          Methods

          destroy

          • destroy(): void

          • Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSContentEdit.html b/docs/classes/_standard_component.TJSContentEdit.html index eaddc5e8..e0b95862 100644 --- a/docs/classes/_standard_component.TJSContentEdit.html +++ b/docs/classes/_standard_component.TJSContentEdit.html @@ -1,38 +1,58 @@ -TJSContentEdit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSContentEdit

          Provides a reactive wrapper for direct content editable elements. Allows editing Foundry document data or +TJSContentEdit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSContentEdit

          Provides a reactive wrapper for direct content editable elements. Allows editing Foundry document data or directly from content prop. Automatic HTML enrichment occurs for the content when saved.

          -

          Props

          There are no required props, but the following are available to set:

          +

          Props

          There are no required props, but the following are available to set:

            -

          • content - Provides an initial content string; you can bind to content from a parent component to get reactive - updates when content changes. Two-way binding.

            +
          • +

            content - Provides an initial content string; you can bind to content from a parent component to get reactive +updates when content changes. Two-way binding.

            • -

          • enrichedContent - Provides the enriched content via TextEditor.enrichHTML when content changes. - You can bind to enrichedContent from a parent component to get reactive updates though it is not - recommended to change enrichedContent externally. One-way binding.

            +
          • +

            enrichedContent - Provides the enriched content via TextEditor.enrichHTML when content changes. +You can bind to enrichedContent from a parent component to get reactive updates though it is not +recommended to change enrichedContent externally. One-way binding.

            • -

          • options - Defines the options object for this component. Please review all the options defined below - TJSContentEditOptions.

            +
          • +

            options - Defines the options object for this component. Please review all the options defined below +TJSContentEditOptions.

          -

          Events

          There are five events fired when the editor is canceled, saved, and started:

          +

          Events

          There are five events fired when the editor is canceled, saved, and started:

            -

          • editor:cancel - Fired when editing is canceled by a user action or reactive response to document changes.

            +
          • +

            editor:cancel - Fired when editing is canceled by a user action or reactive response to document changes.

            • -

          • editor:document:deleted - Fired when the edited document is deleted. Access the document from - event.detail.document.

            +
          • +

            editor:document:deleted - Fired when the edited document is deleted. Access the document from +event.detail.document.

            • -

          • editor:enrichedContent - Fired when content is enriched. Access enriched content from - event.detail.enrichedContent.

            +
          • +

            editor:enrichedContent - Fired when content is enriched. Access enriched content from +event.detail.enrichedContent.

            • -

          • editor:save - Fired when editing is saved. Access the content from event.detail.content.

            +
          • +

            editor:save - Fired when editing is saved. Access the content from event.detail.content.

            • -

          • editor:start - Fired when editing is started.

            +
          • +

            editor:start - Fired when editing is started.

          -

          CSS Variables

          The following CSS variables control the associated styles with the default values:

          -
          `.editor` HTMLDivElement:
          ---------------------------------
          --tjs-editor-background - none
          --tjs-editor-border - none
          --tjs-editor-border-radius - 0
          --tjs-editor-height - 100%
          --tjs-editor-margin - 0
          --tjs-editor-overflow - auto
          --tjs-editor-transition
          --tjs-editor-width - 100%

          `.editor` HTMLDivElement; properties available when activated:
          ---------------------------------
          --tjs-editor-active-box-shadow, unset; Foundry default: 0 0 5px var(--color-shadow-primary)
          --tjs-editor-active-outline - unset
          --tjs-editor-active-overflow - unset; When inactive the editor overflow is auto; when active overflow is unset.

          `.editor` HTMLDivElement; properties available when inactive, but manually focused:
          ---------------------------------
          --tjs-editor-inactive-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
          --tjs-editor-inactive-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
          --tjs-editor-inactive-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

          `.editor` HTMLDivElement; properties available when inactive, but hovered:
          ---------------------------------
          --tjs-editor-inactive-cursor-hover - text
          --tjs-editor-inactive-box-shadow-hover - unset
          --tjs-editor-inactive-outline-hover - unset
          --tjs-editor-inactive-user-select-hover - text

          `.editor` HTMLDivElement; when editing - the content overflow is set to auto:
          ---------------------------------
          --tjs-editor-content-color - #000
          --tjs-editor-content-font-family - "Signika"
          --tjs-editor-content-font-size - 10.5pt
          --tjs-editor-content-line-height - 1.2
          --tjs-editor-content-overflow - auto
          --tjs-editor-content-padding - 0

          .editor-edit; Defines the position of the edit button from top / right absolute positioning:
          ---------------------------------
          --tjs-editor-edit-button-right - 5px
          --tjs-editor-edit-button-top - 0
+
          CSS Variables
          The following CSS variables control the associated styles with the default values:
          
+
          `.editor` HTMLDivElement:
          ---------------------------------
          --tjs-editor-background - none
          --tjs-editor-border - none
          --tjs-editor-border-radius - 0
          --tjs-editor-height - 100%
          --tjs-editor-margin - 0
          --tjs-editor-overflow - auto
          --tjs-editor-transition
          --tjs-editor-width - 100%

          `.editor` HTMLDivElement; properties available when activated:
          ---------------------------------
          --tjs-editor-active-box-shadow, unset; Foundry default: 0 0 5px var(--color-shadow-primary)
          --tjs-editor-active-outline - unset
          --tjs-editor-active-overflow - unset; When inactive the editor overflow is auto; when active overflow is unset.

          `.editor` HTMLDivElement; properties available when inactive, but manually focused:
          ---------------------------------
          --tjs-editor-inactive-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
          --tjs-editor-inactive-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
          --tjs-editor-inactive-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

          `.editor` HTMLDivElement; properties available when inactive, but hovered:
          ---------------------------------
          --tjs-editor-inactive-cursor-hover - text
          --tjs-editor-inactive-box-shadow-hover - unset
          --tjs-editor-inactive-outline-hover - unset
          --tjs-editor-inactive-user-select-hover - text

          `.editor` HTMLDivElement; when editing - the content overflow is set to auto:
          ---------------------------------
          --tjs-editor-content-color - #000
          --tjs-editor-content-font-family - "Signika"
          --tjs-editor-content-font-size - 10.5pt
          --tjs-editor-content-line-height - 1.2
          --tjs-editor-content-overflow - auto
          --tjs-editor-content-padding - 0

          .editor-edit; Defines the position of the edit button from top / right absolute positioning:
          ---------------------------------
          --tjs-editor-edit-button-right - 5px
          --tjs-editor-edit-button-top - 0
 
          
-

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          PropsEventsCSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSIconButton.html b/docs/classes/_standard_component.TJSIconButton.html index 8ee7a5e9..679f2a98 100644 --- a/docs/classes/_standard_component.TJSIconButton.html +++ b/docs/classes/_standard_component.TJSIconButton.html @@ -1,7 +1,19 @@ -TJSIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSIconButton

          CSS Variables

          --tjs-default-text-shadow-focus-hover: system default
          --tjs-default-outline-focus-visible: undefined; global replacement for focus-visible outline.

          --tjs-button-background
          --tjs-button-background-focus
          --tjs-button-background-focus-visible
          --tjs-button-background-hover
          --tjs-button-background-selected
          --tjs-button-border
          --tjs-button-border-radius
          --tjs-button-border-width
          --tjs-button-box-shadow-focus-visible
          --tjs-button-clip-path
          --tjs-button-clip-path-hover
          --tjs-button-clip-path-focus
          --tjs-button-cursor
          --tjs-button-cursor-disabled
          --tjs-button-diameter
          --tjs-button-outline-focus-visible
          --tjs-button-text-shadow-focus: undefined
          --tjs-button-text-shadow-hover: undefined
          --tjs-button-transition
          --tjs-button-transition-focus-visible

          --tjs-icon-button-background
          --tjs-icon-button-background-focus
          --tjs-icon-button-background-focus-visible
          --tjs-icon-button-background-hover
          --tjs-icon-button-background-selected
          --tjs-icon-button-border
          --tjs-icon-button-border-radius
          --tjs-icon-button-border-width
          --tjs-icon-button-box-shadow-focus-visible
          --tjs-icon-button-clip-path
          --tjs-icon-button-clip-path-focus
          --tjs-icon-button-clip-path-hover
          --tjs-icon-button-cursor
          --tjs-icon-button-cursor-disabled
          --tjs-icon-button-diameter
          --tjs-icon-button-outline-focus-visible
          --tjs-icon-button-text-shadow-focus: undefined
          --tjs-icon-button-text-shadow-hover: undefined
          --tjs-icon-button-transition
          --tjs-icon-button-transition-focus-visible
+TJSIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          
+
          Class TJSIconButton
          CSS Variables
          --tjs-default-text-shadow-focus-hover: system default
          --tjs-default-outline-focus-visible: undefined; global replacement for focus-visible outline.

          --tjs-button-background
          --tjs-button-background-focus
          --tjs-button-background-focus-visible
          --tjs-button-background-hover
          --tjs-button-background-selected
          --tjs-button-border
          --tjs-button-border-radius
          --tjs-button-border-width
          --tjs-button-box-shadow-focus-visible
          --tjs-button-clip-path
          --tjs-button-clip-path-hover
          --tjs-button-clip-path-focus
          --tjs-button-cursor
          --tjs-button-cursor-disabled
          --tjs-button-diameter
          --tjs-button-outline-focus-visible
          --tjs-button-text-shadow-focus: undefined
          --tjs-button-text-shadow-hover: undefined
          --tjs-button-transition
          --tjs-button-transition-focus-visible

          --tjs-icon-button-background
          --tjs-icon-button-background-focus
          --tjs-icon-button-background-focus-visible
          --tjs-icon-button-background-hover
          --tjs-icon-button-background-selected
          --tjs-icon-button-border
          --tjs-icon-button-border-radius
          --tjs-icon-button-border-width
          --tjs-icon-button-box-shadow-focus-visible
          --tjs-icon-button-clip-path
          --tjs-icon-button-clip-path-focus
          --tjs-icon-button-clip-path-hover
          --tjs-icon-button-cursor
          --tjs-icon-button-cursor-disabled
          --tjs-icon-button-diameter
          --tjs-icon-button-outline-focus-visible
          --tjs-icon-button-text-shadow-focus: undefined
          --tjs-icon-button-text-shadow-hover: undefined
          --tjs-icon-button-transition
          --tjs-icon-button-transition-focus-visible
 
          
-
          Hierarchy (view full)
          Constructors
          constructor
+
+
          
+            
          
+              
+                 
          
+                    
+                  Hierarchy
          
+                        
+              
          
+              
          
+           
          
+         
          Constructors
          constructor
 
          Methods
          $destroy
 $on
 $set
-
          Constructors
          constructor
          Methods
          $destroy
          $on
          • $on<K>(type, callback): (() => void)
          • Type Parameters
            • K extends string
            Parameters
            Returns (() => void)
              • (): void
              • Returns void
          $set
          Settings
          Member Visibility
          Theme
          On This Page
          constructor$destroy$on$set
          
\ No newline at end of file
+

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSIconFolder.html b/docs/classes/_standard_component.TJSIconFolder.html index ade1349f..06d5ca32 100644 --- a/docs/classes/_standard_component.TJSIconFolder.html +++ b/docs/classes/_standard_component.TJSIconFolder.html @@ -1,47 +1,59 @@ -TJSIconFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSIconFolder

          TJSFolder provides a collapsible folder using the details and summary HTMLElements.

          +TJSIconFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSIconFolder

          TJSFolder provides a collapsible folder using the details and summary HTMLElements.

          This is a slotted component. The default slot is the collapsible contents. There are also two additional optional named slots available for the summary element. label allows setting custom content with the fallback being the label string. Additionally, summary-end allows a component or text to be slotted after the label. This can be useful for say an "expand all" button.

          -

          Exported props

            +

            Exported props

            • folder (TJSFolderData): An object defining all properties of a folder including potentially data driven minimal Svelte configuration objects (slotDefault, slotLabel, and slotSummaryEnd) providing default component implementations.

            Or in lieu of passing the folder object you can assign these props directly:

              -

            • id: Anything used for an ID.

              +
            • +

              id: Anything used for an ID.

              • -

            • label: The label name of the folder; string.

              +
            • +

              label: The label name of the folder; string.

              • -

            • store: The store tracking the open / close state: Writable

              +
            • +

              store: The store tracking the open / close state: Writable

              • -

            • styles: Styles to be applied inline via applyStyles action.

              +
            • +

              styles: Styles to be applied inline via applyStyles action.

            -

            Events

            There are several events that are fired and / or bubbled up through parent elements. There are four +

            Events

            There are several events that are fired and / or bubbled up through parent elements. There are four custom events that pass a details object including: the details element, id, label, and store.

            The following events are bubbled up such that assigning a listener in any parent component receives them from all children folders:

              -

            • click - Basic MouseEvent of folder being clicked.

              +
            • +

              click - Basic MouseEvent of folder being clicked.

              • -

            • keydown - Key down event.

              +
            • +

              keydown - Key down event.

              • -

            • keyup - Key up event.

              +
            • +

              keyup - Key up event.

              • -

            • closeAny - Triggered when any child folder is closed w/ details object.

              +
            • +

              closeAny - Triggered when any child folder is closed w/ details object.

              • -

            • openAny - Triggered when any child folder is opened w/ details object.

              +
            • +

              openAny - Triggered when any child folder is opened w/ details object.

            The following events do not propagate / bubble up and can be registered with:

              -

            • close - Triggered when direct descendent folder is closed w/ details object.

              +
            • +

              close - Triggered when direct descendent folder is closed w/ details object.

              • -

            • open - Triggered when direct descendent folder is opened w/ details object.

              +
            • +

              open - Triggered when direct descendent folder is opened w/ details object.

            @@ -49,11 +61,22 @@ attributes for id and label.

            There are several local CSS variables that you can use to change the appearance dynamically. Either use CSS props or pass in a styles object w/ key / value props to set to the details.

            -

            CSS Variables

            The following CSS variables are supported, but not defined by default:

            -
            Details element (attributes follow `--tjs-folder-details-`):
            --tjs-folder-details-margin-left: -0.4em;
            --tjs-folder-details-padding-left: 0.4em; set for children to indent more;

            Summary element (attributes follow `--tjs-folder-summary-`):
            --tjs-folder-summary-background-blend-mode: initial
            --tjs-folder-summary-background: none
            --tjs-folder-summary-background-open - fallback: --tjs-folder-summary-background; default: inherit
            --tjs-folder-summary-border: none
            --tjs-folder-summary-border-radius: 0
            --tjs-folder-summary-border-width: initial
            --tjs-folder-summary-cursor: pointer
            --tjs-folder-summary-font-size: inherit
            --tjs-folder-summary-font-weight: bold
            --tjs-folder-summary-font-family: inherit
            --tjs-folder-summary-gap: 0.125em
            --tjs-folder-summary-padding: 0.25em
            --tjs-folder-summary-transition: background 0.1s
            --tjs-folder-summary-width: fit-content; wraps content initially, set to 100% or other width measurement

            Summary element (focus visible):
            --tjs-folder-summary-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
            --tjs-folder-summary-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
            --tjs-folder-summary-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

            A keyboard focus indicator is defined by the following CSS variables:
            --tjs-folder-summary-focus-indicator-align-self - fallback: --tjs-default-focus-indicator-align-self; default: stretch
            --tjs-folder-summary-focus-indicator-background - fallback: --tjs-default-focus-indicator-background; default: white
            --tjs-folder-summary-focus-indicator-border - fallback: --tjs-default-focus-indicator-border; default: undefined
            --tjs-folder-summary-focus-indicator-border-radius - fallback: --tjs-default-focus-indicator-border-radius; default: 0.1em
            --tjs-folder-summary-focus-indicator-height - fallback: --tjs-default-focus-indicator-height; default: undefined
            --tjs-folder-summary-focus-indicator-transition - fallback: --tjs-default-focus-indicator-transition
            --tjs-folder-summary-focus-indicator-width - fallback: --tjs-default-focus-indicator-width; default: 0.25em

            Summary icon / chevron element (attributes follow `--tjs-folder-summary-chevron-`):

            --tjs-folder-summary-chevron-border-radius: 0
            --tjs-folder-summary-chevron-color: inherit
            --tjs-folder-summary-chevron-opacity: 1; Opacity when not hovering.
            --tjs-folder-summary-chevron-opacity-focus-visible: 1; When summary focus-visible.
            --tjs-folder-summary-chevron-opacity-hover: 1; Opacity when hovering.
            --tjs-folder-summary-chevron-margin: 0 0 0 0.25em;
            --tjs-folder-summary-chevron-transition: opacity 0.2s, transform 0.1s
            --tjs-folder-summary-chevron-width: 1.25em

            Summary label element (attributes follow `--tjs-folder-summary-label-`):

            By default, the label element does not wrap and uses ellipsis for text overflow.

            --tjs-folder-summary-label-overflow: hidden
            --tjs-folder-summary-label-text-overflow: ellipsis
            --tjs-folder-summary-label-white-space: nowrap
            --tjs-folder-summary-label-width: fit-content

            Default label (focus visible):
            --tjs-folder-summary-label-text-shadow-focus-visible - fallback: --tjs-default-text-shadow-focus-hover; default: revert

            Contents element (attributes follow `--tjs-folder-contents-`):
            --tjs-folder-contents-background-blend-mode: initial
            --tjs-folder-contents-background: none
            --tjs-folder-contents-border: none
            --tjs-folder-contents-margin: 0 0 0 -0.4em

            Padding is set directly by `--tjs-folder-contents-padding` or follows the following calculation:
            `0 0 0 calc(var(--tjs-folder-summary-font-size, 1em) * 0.8)`

            If neither `--tjs-folder-contents-padding` or `--tjs-folder-summary-font-size` is defined the default is
            `1em * 0.8`.
+
            CSS Variables
            The following CSS variables are supported, but not defined by default:
            
+
            Details element (attributes follow `--tjs-folder-details-`):
            --tjs-folder-details-margin-left: -0.4em;
            --tjs-folder-details-padding-left: 0.4em; set for children to indent more;

            Summary element (attributes follow `--tjs-folder-summary-`):
            --tjs-folder-summary-background-blend-mode: initial
            --tjs-folder-summary-background: none
            --tjs-folder-summary-background-open - fallback: --tjs-folder-summary-background; default: inherit
            --tjs-folder-summary-border: none
            --tjs-folder-summary-border-radius: 0
            --tjs-folder-summary-border-width: initial
            --tjs-folder-summary-cursor: pointer
            --tjs-folder-summary-font-size: inherit
            --tjs-folder-summary-font-weight: bold
            --tjs-folder-summary-font-family: inherit
            --tjs-folder-summary-gap: 0.125em
            --tjs-folder-summary-padding: 0.25em
            --tjs-folder-summary-transition: background 0.1s
            --tjs-folder-summary-width: fit-content; wraps content initially, set to 100% or other width measurement

            Summary element (focus visible):
            --tjs-folder-summary-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
            --tjs-folder-summary-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
            --tjs-folder-summary-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

            A keyboard focus indicator is defined by the following CSS variables:
            --tjs-folder-summary-focus-indicator-align-self - fallback: --tjs-default-focus-indicator-align-self; default: stretch
            --tjs-folder-summary-focus-indicator-background - fallback: --tjs-default-focus-indicator-background; default: white
            --tjs-folder-summary-focus-indicator-border - fallback: --tjs-default-focus-indicator-border; default: undefined
            --tjs-folder-summary-focus-indicator-border-radius - fallback: --tjs-default-focus-indicator-border-radius; default: 0.1em
            --tjs-folder-summary-focus-indicator-height - fallback: --tjs-default-focus-indicator-height; default: undefined
            --tjs-folder-summary-focus-indicator-transition - fallback: --tjs-default-focus-indicator-transition
            --tjs-folder-summary-focus-indicator-width - fallback: --tjs-default-focus-indicator-width; default: 0.25em

            Summary icon / chevron element (attributes follow `--tjs-folder-summary-chevron-`):

            --tjs-folder-summary-chevron-border-radius: 0
            --tjs-folder-summary-chevron-color: inherit
            --tjs-folder-summary-chevron-opacity: 1; Opacity when not hovering.
            --tjs-folder-summary-chevron-opacity-focus-visible: 1; When summary focus-visible.
            --tjs-folder-summary-chevron-opacity-hover: 1; Opacity when hovering.
            --tjs-folder-summary-chevron-margin: 0 0 0 0.25em;
            --tjs-folder-summary-chevron-transition: opacity 0.2s, transform 0.1s
            --tjs-folder-summary-chevron-width: 1.25em

            Summary label element (attributes follow `--tjs-folder-summary-label-`):

            By default, the label element does not wrap and uses ellipsis for text overflow.

            --tjs-folder-summary-label-overflow: hidden
            --tjs-folder-summary-label-text-overflow: ellipsis
            --tjs-folder-summary-label-white-space: nowrap
            --tjs-folder-summary-label-width: fit-content

            Default label (focus visible):
            --tjs-folder-summary-label-text-shadow-focus-visible - fallback: --tjs-default-text-shadow-focus-hover; default: revert

            Contents element (attributes follow `--tjs-folder-contents-`):
            --tjs-folder-contents-background-blend-mode: initial
            --tjs-folder-contents-background: none
            --tjs-folder-contents-border: none
            --tjs-folder-contents-margin: 0 0 0 -0.4em

            Padding is set directly by `--tjs-folder-contents-padding` or follows the following calculation:
            `0 0 0 calc(var(--tjs-folder-summary-font-size, 1em) * 0.8)`

            If neither `--tjs-folder-contents-padding` or `--tjs-folder-summary-font-size` is defined the default is
            `1em * 0.8`.
 
            
-

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          Exported propsEventsCSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSInput.html b/docs/classes/_standard_component.TJSInput.html index 3a61cf30..37348acc 100644 --- a/docs/classes/_standard_component.TJSInput.html +++ b/docs/classes/_standard_component.TJSInput.html @@ -1,13 +1,25 @@ -TJSInput | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSInput

          Provides a generic "input" component that creates the specific input component based on 'type'. If no type +TJSInput | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSInput

          Provides a generic "input" component that creates the specific input component based on 'type'. If no type property is available in the input object text is the default.

          You may optionally define a label either as input.label or through the label prop as a string. The label element uses display: contents which ignores the label element and lays out the children as if the label element does not exist which is perfect for a grid layout.

          -

          CSS Variables

          The following CSS variables control the associated styles with the default values:

          +

          CSS Variables

          The following CSS variables control the associated styles with the default values:

          --tjs-input-label-display - content
          --tjs-input-label-text-align - right
          --tjs-input-label-white-space - nowrap
          -

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSInputCheckbox.html b/docs/classes/_standard_component.TJSInputCheckbox.html index 35cc7ffa..d8b906f0 100644 --- a/docs/classes/_standard_component.TJSInputCheckbox.html +++ b/docs/classes/_standard_component.TJSInputCheckbox.html @@ -1,8 +1,20 @@ -TJSInputCheckbox | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSInputCheckbox

          Provides a data driven checkbox input w/ label.

          -

          CSS Variables:

          --tjs-input-appearance
          --tjs-input-border
          --tjs-input-border-radius
          --tjs-input-border-disabled
          --tjs-input-box-shadow-focus
          --tjs-input-box-shadow-focus-visible
          --tjs-input-cursor
          --tjs-input-cursor-disabled
          --tjs-input-flex
          --tjs-input-outline-focus-visible
          --tjs-input-outline-offset
          --tjs-input-transition-focus-visible
          --tjs-input-transition-hover

          --tjs-input-checkbox-appearance
          --tjs-input-checkbox-background
          --tjs-input-checkbox-border
          --tjs-input-checkbox-border-radius
          --tjs-input-checkbox-border-disabled
          --tjs-input-checkbox-box-shadow-focus
          --tjs-input-checkbox-box-shadow-focus-visible
          --tjs-input-checkbox-cursor
          --tjs-input-checkbox-cursor-disabled
          --tjs-input-checkbox-diameter
          --tjs-input-checkbox-flex
          --tjs-input-checkbox-height
          --tjs-input-checkbox-outline-hover
          --tjs-input-checkbox-outline-focus-visible
          --tjs-input-checkbox-outline-offset
          --tjs-input-checkbox-transition-focus-visible
          --tjs-input-checkbox-transition-hover
          --tjs-input-checkbox-width
+TJSInputCheckbox | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          
+
          Class TJSInputCheckbox
          Provides a data driven checkbox input w/ label.
          
+
          CSS Variables:
          --tjs-input-appearance
          --tjs-input-border
          --tjs-input-border-radius
          --tjs-input-border-disabled
          --tjs-input-box-shadow-focus
          --tjs-input-box-shadow-focus-visible
          --tjs-input-cursor
          --tjs-input-cursor-disabled
          --tjs-input-flex
          --tjs-input-outline-focus-visible
          --tjs-input-outline-offset
          --tjs-input-transition-focus-visible
          --tjs-input-transition-hover

          --tjs-input-checkbox-appearance
          --tjs-input-checkbox-background
          --tjs-input-checkbox-border
          --tjs-input-checkbox-border-radius
          --tjs-input-checkbox-border-disabled
          --tjs-input-checkbox-box-shadow-focus
          --tjs-input-checkbox-box-shadow-focus-visible
          --tjs-input-checkbox-cursor
          --tjs-input-checkbox-cursor-disabled
          --tjs-input-checkbox-diameter
          --tjs-input-checkbox-flex
          --tjs-input-checkbox-height
          --tjs-input-checkbox-outline-hover
          --tjs-input-checkbox-outline-focus-visible
          --tjs-input-checkbox-outline-offset
          --tjs-input-checkbox-transition-focus-visible
          --tjs-input-checkbox-transition-hover
          --tjs-input-checkbox-width
 
          
-
          Hierarchy (view full)
          Constructors
          constructor
+
+
          
+            
          
+              
+                 
          
+                    
+                  Hierarchy
          
+                        
+              
          
+              
          
+           
          
+         
          Constructors
          constructor
 
          Methods
          $destroy
 $on
 $set
-
          Constructors
          constructor
          Methods
          $destroy
          $on
          • $on<K>(type, callback): (() => void)
          • Type Parameters
            • K extends string
            Parameters
            Returns (() => void)
              • (): void
              • Returns void
          $set
          Settings
          Member Visibility
          Theme
          On This Page
          constructor$destroy$on$set
          
\ No newline at end of file
+

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables:
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSInputNumber.html b/docs/classes/_standard_component.TJSInputNumber.html index d59bfa5e..50178dae 100644 --- a/docs/classes/_standard_component.TJSInputNumber.html +++ b/docs/classes/_standard_component.TJSInputNumber.html @@ -1,8 +1,20 @@ -TJSInputNumber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSInputNumber

          A number input type.

          -

          CSS Variables:

          --tjs-input-appearance
          --tjs-input-background
          --tjs-input-border
          --tjs-input-border-radius
          --tjs-input-border-disabled
          --tjs-input-box-shadow-focus
          --tjs-input-box-shadow-focus-visible
          --tjs-input-caret-color
          --tjs-input-color
          --tjs-input-color-disabled
          --tjs-input-cursor
          --tjs-input-cursor-disabled
          --tjs-input-flex
          --tjs-input-font-family
          --tjs-input-font-size
          --tjs-input-height
          --tjs-input-line-height
          --tjs-input-padding
          --tjs-input-placeholder-color
          --tjs-input-outline-focus-visible
          --tjs-input-outline-offset
          --tjs-input-overflow
          --tjs-input-text-align
          --tjs-input-transition-focus-visible
          --tjs-input-value-invalid-color
          --tjs-input-width

          --tjs-input-number-appearance
          --tjs-input-number-background
          --tjs-input-number-border
          --tjs-input-number-border-radius
          --tjs-input-number-border-disabled
          --tjs-input-number-box-shadow-focus
          --tjs-input-number-box-shadow-focus-visible
          --tjs-input-number-caret-color
          --tjs-input-number-color
          --tjs-input-number-color-disabled
          --tjs-input-number-cursor
          --tjs-input-number-cursor-disabled
          --tjs-input-number-flex
          --tjs-input-number-font-family
          --tjs-input-number-font-size
          --tjs-input-number-height
          --tjs-input-number-line-height
          --tjs-input-number-outline-focus-visible
          --tjs-input-number-outline-offset
          --tjs-input-number-overflow
          --tjs-input-number-padding
          --tjs-input-number-placeholder-color
          --tjs-input-number-text-align
          --tjs-input-number-transition-focus-visible
          --tjs-input-number-value-invalid-color
          --tjs-input-number-width

          Webkit unique variables:
          --tjs-input-number-webkit-inner-spin-button-opacity
          --tjs-input-number-webkit-outer-spin-button-opacity
+TJSInputNumber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          
+
          Class TJSInputNumber
          A number input type.
          
+
          CSS Variables:
          --tjs-input-appearance
          --tjs-input-background
          --tjs-input-border
          --tjs-input-border-radius
          --tjs-input-border-disabled
          --tjs-input-box-shadow-focus
          --tjs-input-box-shadow-focus-visible
          --tjs-input-caret-color
          --tjs-input-color
          --tjs-input-color-disabled
          --tjs-input-cursor
          --tjs-input-cursor-disabled
          --tjs-input-flex
          --tjs-input-font-family
          --tjs-input-font-size
          --tjs-input-height
          --tjs-input-line-height
          --tjs-input-padding
          --tjs-input-placeholder-color
          --tjs-input-outline-focus-visible
          --tjs-input-outline-offset
          --tjs-input-overflow
          --tjs-input-text-align
          --tjs-input-transition-focus-visible
          --tjs-input-value-invalid-color
          --tjs-input-width

          --tjs-input-number-appearance
          --tjs-input-number-background
          --tjs-input-number-border
          --tjs-input-number-border-radius
          --tjs-input-number-border-disabled
          --tjs-input-number-box-shadow-focus
          --tjs-input-number-box-shadow-focus-visible
          --tjs-input-number-caret-color
          --tjs-input-number-color
          --tjs-input-number-color-disabled
          --tjs-input-number-cursor
          --tjs-input-number-cursor-disabled
          --tjs-input-number-flex
          --tjs-input-number-font-family
          --tjs-input-number-font-size
          --tjs-input-number-height
          --tjs-input-number-line-height
          --tjs-input-number-outline-focus-visible
          --tjs-input-number-outline-offset
          --tjs-input-number-overflow
          --tjs-input-number-padding
          --tjs-input-number-placeholder-color
          --tjs-input-number-text-align
          --tjs-input-number-transition-focus-visible
          --tjs-input-number-value-invalid-color
          --tjs-input-number-width

          Webkit unique variables:
          --tjs-input-number-webkit-inner-spin-button-opacity
          --tjs-input-number-webkit-outer-spin-button-opacity
 
          
-
          Hierarchy (view full)
          Constructors
          constructor
+
+
          
+            
          
+              
+                 
          
+                    
+                  Hierarchy
          
+                        
+              
          
+              
          
+           
          
+         
          Constructors
          constructor
 
          Methods
          $destroy
 $on
 $set
-
          Constructors
          constructor
          Methods
          $destroy
          $on
          • $on<K>(type, callback): (() => void)
          • Type Parameters
            • K extends string
            Parameters
            Returns (() => void)
              • (): void
              • Returns void
          $set
          Settings
          Member Visibility
          Theme
          On This Page
          constructor$destroy$on$set
          
\ No newline at end of file
+

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables:
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSInputText.html b/docs/classes/_standard_component.TJSInputText.html index 1095efaa..ec13c34f 100644 --- a/docs/classes/_standard_component.TJSInputText.html +++ b/docs/classes/_standard_component.TJSInputText.html @@ -1,11 +1,23 @@ -TJSInputText | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSInputText

          A generic input type has issues w/ 2-way binding w/ Svelte. -https://github.com/sveltejs/svelte/issues/3921

          +TJSInputText | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSInputText

          A generic input type has issues w/ 2-way binding w/ Svelte. +https://github.com/sveltejs/svelte/issues/3921

          A "hack" is used to set the type on the input element: {...{ type }}

          Only use this component for text inputs presently. More work to come.

          -

          CSS Variables:

          --tjs-input-appearance
          --tjs-input-background
          --tjs-input-border
          --tjs-input-border-radius
          --tjs-input-border-disabled
          --tjs-input-box-shadow-focus
          --tjs-input-box-shadow-focus-visible
          --tjs-input-caret-color
          --tjs-input-color
          --tjs-input-color-disabled
          --tjs-input-cursor
          --tjs-input-cursor-disabled
          --tjs-input-flex
          --tjs-input-font-family
          --tjs-input-font-size
          --tjs-input-height
          --tjs-input-line-height
          --tjs-input-padding
          --tjs-input-placeholder-color
          --tjs-input-outline-focus-visible
          --tjs-input-outline-offset
          --tjs-input-overflow
          --tjs-input-text-align
          --tjs-input-transition-focus-visible
          --tjs-input-value-invalid-color
          --tjs-input-width

          --tjs-input-text-appearance
          --tjs-input-text-background
          --tjs-input-text-border
          --tjs-input-text-border-radius
          --tjs-input-text-border-disabled
          --tjs-input-text-box-shadow-focus
          --tjs-input-text-box-shadow-focus-visible
          --tjs-input-text-caret-color
          --tjs-input-text-color
          --tjs-input-text-color-disabled
          --tjs-input-text-cursor
          --tjs-input-text-cursor-disabled
          --tjs-input-text-flex
          --tjs-input-text-font-family
          --tjs-input-text-font-size
          --tjs-input-text-height
          --tjs-input-text-line-height
          --tjs-input-text-outline-focus-visible
          --tjs-input-text-outline-offset
          --tjs-input-text-overflow
          --tjs-input-text-padding
          --tjs-input-text-placeholder-color
          --tjs-input-text-text-align
          --tjs-input-text-transition-focus-visible
          --tjs-input-text-value-invalid-color
          --tjs-input-text-width
+
          CSS Variables:
          --tjs-input-appearance
          --tjs-input-background
          --tjs-input-border
          --tjs-input-border-radius
          --tjs-input-border-disabled
          --tjs-input-box-shadow-focus
          --tjs-input-box-shadow-focus-visible
          --tjs-input-caret-color
          --tjs-input-color
          --tjs-input-color-disabled
          --tjs-input-cursor
          --tjs-input-cursor-disabled
          --tjs-input-flex
          --tjs-input-font-family
          --tjs-input-font-size
          --tjs-input-height
          --tjs-input-line-height
          --tjs-input-padding
          --tjs-input-placeholder-color
          --tjs-input-outline-focus-visible
          --tjs-input-outline-offset
          --tjs-input-overflow
          --tjs-input-text-align
          --tjs-input-transition-focus-visible
          --tjs-input-value-invalid-color
          --tjs-input-width

          --tjs-input-text-appearance
          --tjs-input-text-background
          --tjs-input-text-border
          --tjs-input-text-border-radius
          --tjs-input-text-border-disabled
          --tjs-input-text-box-shadow-focus
          --tjs-input-text-box-shadow-focus-visible
          --tjs-input-text-caret-color
          --tjs-input-text-color
          --tjs-input-text-color-disabled
          --tjs-input-text-cursor
          --tjs-input-text-cursor-disabled
          --tjs-input-text-flex
          --tjs-input-text-font-family
          --tjs-input-text-font-size
          --tjs-input-text-height
          --tjs-input-text-line-height
          --tjs-input-text-outline-focus-visible
          --tjs-input-text-outline-offset
          --tjs-input-text-overflow
          --tjs-input-text-padding
          --tjs-input-text-placeholder-color
          --tjs-input-text-text-align
          --tjs-input-text-transition-focus-visible
          --tjs-input-text-value-invalid-color
          --tjs-input-text-width
 
          
-

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables:
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSMenu.html b/docs/classes/_standard_component.TJSMenu.html index 0b7b4e24..dc442732 100644 --- a/docs/classes/_standard_component.TJSMenu.html +++ b/docs/classes/_standard_component.TJSMenu.html @@ -1,4 +1,5 @@ -TJSMenu | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSMenu

          TJSMenu provides a menu component that can be slotted into toggle components like TJSToggleIconButton and +TJSMenu | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSMenu

          TJSMenu provides a menu component that can be slotted into toggle components like TJSToggleIconButton and TJSToggleLabel.

          TJSMenu supports a flexible data driven way to construct the menu items. Depending on the item data that is passed into the menu you can define 4 types of items: 'icon / label', 'image / label', 'class / Svelte component', and @@ -14,37 +15,54 @@

          Or in lieu of passing the folder object you can assign these props directly:

            -

          • items: An iterable list of TJSMenuItemData; defines data driven menu items.

            +
          • +

            items: An iterable list of TJSMenuItemData; defines data driven menu items.

            • -

          • offset: Optional X / Y offsets for the menu display.

            +
          • +

            offset: Optional X / Y offsets for the menu display.

            • -

          • styles: Styles to be applied inline via applyStyles action.

            +
          • +

            styles: Styles to be applied inline via applyStyles action.

            • -

          • efx: Currently unused; for any future action effects.

            +
          • +

            efx: Currently unused; for any future action effects.

            • -

          • keyCode: The key code to activate menu items.

            +
          • +

            keyCode: The key code to activate menu items.

            • -

          • transitionOptions: Custom transition options for duration and easing function.

            +
          • +

            transitionOptions: Custom transition options for duration and easing function.

          -

          Events

          There is a single that is fired and bubbled up through parent elements:

          +

          Events

          There is a single that is fired and bubbled up through parent elements:

          • close:popup - A CustomEvent fired when the menu closes allowing any parent components to update state. The - detail data may have two optional fields of data including keyboardFocus / boolean if the - close action originated from keyboard navigation and the other is target / HTMLElement that is - the original event target for the close action.
            • +detail data may have two optional fields of data including keyboardFocus / boolean if the +close action originated from keyboard navigation and the other is target / HTMLElement that is +the original event target for the close action.
          -

          Styling

          To style this component use .tjs-menu as the base selector.

          +

          Styling

          To style this component use .tjs-menu as the base selector.

          There are several local CSS variables that you can use to change the appearance dynamically. Either use CSS props or pass in a styles object w/ key / value props to set to the details. The default fallback variables target both TJSMenu and TJSContextMenu. The few popup defaults target first level overlaid components inside an application.

          -

          CSS Variables

          The following CSS variables are supported, but not defined by default:

          --tjs-menu-background - fallback: --tjs-default-menu-background; fallback: --tjs-default-popup-background; default: #23221d
          --tjs-menu-border - fallback: --tjs-default-popup-border; default: 1px solid #000
          --tjs-menu-border-radius - fallback: --tjs-default-popup-border-radius; default: 5px
          --tjs-menu-box-shadow - fallback: --tjs-default-popup-box-shadow; default: 0 0 2px #000
          --tjs-menu-primary-color - fallback: --tjs-default-menu-primary-color; fallback: --tjs-default-popup-primary-color; default: #b5b3a4
          --tjs-menu-max-width - fallback: --tjs-default-menu-max-width; default: 360px
          --tjs-menu-min-width - fallback: --tjs-default-menu-min-width; default: 20px
          --tjs-menu-z-index - fallback: --tjs-default-popup-z-index; default: 100

          The following CSS variables define attributes for the data driven menu items.

          All menu items:
          --tjs-menu-item-line-height - fallback: --tjs-default-menu-item-line-height; default: 2em
          --tjs-menu-item-padding - fallback: --tjs-default-menu-item-padding; default: 0 0.5em 0 0

          Icon / Image menu items (considered a button item):
          --tjs-menu-item-button-gap - fallback: --tjs-default-menu-item-button-gap; default: 0.25em
          --tjs-menu-item-highlight-color - fallback: --tjs-default-menu-highlight-color; fallback: --tjs-default-popup-highlight-color; default: #f0f0e0
          --tjs-menu-item-text-shadow-focus-hover - fallback: --tjs-default-text-shadow-focus-hover; default: 0 0 8px red

          Specific targeting for the label of button items (allows control of wrapping / set `white-space` to `nowrap`):
          --tjs-menu-item-label-overflow - fallback: --tjs-default-menu-item-label-overflow; default: hidden
          --tjs-menu-item-label-text-overflow - fallback: --tjs-default-menu-item-label-text-overflow; default: ellipsis
          --tjs-menu-item-label-white-space - fallback: --tjs-default-menu-item-label-white-space; default: undefined

          Icon menu item:
          --tjs-menu-item-icon-width - fallback: --tjs-default-menu-item-icon-width; default: 1.25em

          Image menu item:
          --tjs-menu-item-image-width - fallback: --tjs-default-menu-item-image-width; default: 1.25em
          --tjs-menu-item-image-height - fallback: --tjs-default-menu-item-image-height; default: 1.25em

          Separator / HR:
          --tjs-menu-hr-margin - fallback: --tjs-default-hr-margin; default: 0 0.25em
          --tjs-menu-hr-border-top - fallback: --tjs-default-hr-border-top; default: 1px solid #555
          --tjs-menu-hr-border-bottom - fallback: --tjs-default-hr-border-bottom; default: 1px solid #444

          The following CSS variables define the keyboard / a11y focus indicator for menu items:
          --tjs-menu-focus-indicator-align-self - fallback: --tjs-default-focus-indicator-align-self; default: stretch
          --tjs-menu-focus-indicator-background - fallback: --tjs-default-focus-indicator-background; default: white
          --tjs-menu-focus-indicator-border - fallback: --tjs-default-focus-indicator-border; default: undefined
          --tjs-menu-focus-indicator-border-radius - fallback: --tjs-default-focus-indicator-border-radius; default: 0.1em
          --tjs-menu-focus-indicator-height - fallback: --tjs-default-focus-indicator-height; default: undefined
          --tjs-menu-focus-indicator-width - fallback: --tjs-default-focus-indicator-width; default: 0.25em
          --tjs-menu-focus-indicator-transition - fallback: --tjs-default-focus-indicator-transition
+
          CSS Variables
          The following CSS variables are supported, but not defined by default:

          --tjs-menu-background - fallback: --tjs-default-menu-background; fallback: --tjs-default-popup-background; default: #23221d
          --tjs-menu-border - fallback: --tjs-default-popup-border; default: 1px solid #000
          --tjs-menu-border-radius - fallback: --tjs-default-popup-border-radius; default: 5px
          --tjs-menu-box-shadow - fallback: --tjs-default-popup-box-shadow; default: 0 0 2px #000
          --tjs-menu-primary-color - fallback: --tjs-default-menu-primary-color; fallback: --tjs-default-popup-primary-color; default: #b5b3a4
          --tjs-menu-max-width - fallback: --tjs-default-menu-max-width; default: 360px
          --tjs-menu-min-width - fallback: --tjs-default-menu-min-width; default: 20px
          --tjs-menu-z-index - fallback: --tjs-default-popup-z-index; default: 100

          The following CSS variables define attributes for the data driven menu items.

          All menu items:
          --tjs-menu-item-line-height - fallback: --tjs-default-menu-item-line-height; default: 2em
          --tjs-menu-item-padding - fallback: --tjs-default-menu-item-padding; default: 0 0.5em 0 0

          Icon / Image menu items (considered a button item):
          --tjs-menu-item-button-gap - fallback: --tjs-default-menu-item-button-gap; default: 0.25em
          --tjs-menu-item-highlight-color - fallback: --tjs-default-menu-highlight-color; fallback: --tjs-default-popup-highlight-color; default: #f0f0e0
          --tjs-menu-item-text-shadow-focus-hover - fallback: --tjs-default-text-shadow-focus-hover; default: 0 0 8px red

          Specific targeting for the label of button items (allows control of wrapping / set `white-space` to `nowrap`):
          --tjs-menu-item-label-overflow - fallback: --tjs-default-menu-item-label-overflow; default: hidden
          --tjs-menu-item-label-text-overflow - fallback: --tjs-default-menu-item-label-text-overflow; default: ellipsis
          --tjs-menu-item-label-white-space - fallback: --tjs-default-menu-item-label-white-space; default: undefined

          Icon menu item:
          --tjs-menu-item-icon-width - fallback: --tjs-default-menu-item-icon-width; default: 1.25em

          Image menu item:
          --tjs-menu-item-image-width - fallback: --tjs-default-menu-item-image-width; default: 1.25em
          --tjs-menu-item-image-height - fallback: --tjs-default-menu-item-image-height; default: 1.25em

          Separator / HR:
          --tjs-menu-hr-margin - fallback: --tjs-default-hr-margin; default: 0 0.25em
          --tjs-menu-hr-border-top - fallback: --tjs-default-hr-border-top; default: 1px solid #555
          --tjs-menu-hr-border-bottom - fallback: --tjs-default-hr-border-bottom; default: 1px solid #444

          The following CSS variables define the keyboard / a11y focus indicator for menu items:
          --tjs-menu-focus-indicator-align-self - fallback: --tjs-default-focus-indicator-align-self; default: stretch
          --tjs-menu-focus-indicator-background - fallback: --tjs-default-focus-indicator-background; default: white
          --tjs-menu-focus-indicator-border - fallback: --tjs-default-focus-indicator-border; default: undefined
          --tjs-menu-focus-indicator-border-radius - fallback: --tjs-default-focus-indicator-border-radius; default: 0.1em
          --tjs-menu-focus-indicator-height - fallback: --tjs-default-focus-indicator-height; default: undefined
          --tjs-menu-focus-indicator-width - fallback: --tjs-default-focus-indicator-width; default: 0.25em
          --tjs-menu-focus-indicator-transition - fallback: --tjs-default-focus-indicator-transition
 
          
-

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          EventsStylingCSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSPositionControlLayer.html b/docs/classes/_standard_component.TJSPositionControlLayer.html index cbbd08c8..6555ee0d 100644 --- a/docs/classes/_standard_component.TJSPositionControlLayer.html +++ b/docs/classes/_standard_component.TJSPositionControlLayer.html @@ -1,6 +1,17 @@ -TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSPositionControlLayer

          TODO: Add description

          -

          Hierarchy (view full)

          Constructors

          constructor +TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSPositionControlLayer

          TODO: Add description

          +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSProseMirror.html b/docs/classes/_standard_component.TJSProseMirror.html index a375d70f..a4036b63 100644 --- a/docs/classes/_standard_component.TJSProseMirror.html +++ b/docs/classes/_standard_component.TJSProseMirror.html @@ -1,46 +1,68 @@ -TJSProseMirror | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSProseMirror

          Provides a reactive wrapper for Foundry ProseMirror editor support. Allows editing Foundry document data or +TJSProseMirror | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSProseMirror

          Provides a reactive wrapper for Foundry ProseMirror editor support. Allows editing Foundry document data or directly from content prop. Automatic HTML enrichment occurs for the content when saved.

          -

          Props

          There are no required props, but the following are available to set:

          +

          Props

          There are no required props, but the following are available to set:

            -

          • content - Provides an initial content string; you can bind to content from a parent component to get reactive - updates when content changes. Two-way binding.

            +
          • +

            content - Provides an initial content string; you can bind to content from a parent component to get reactive +updates when content changes. Two-way binding.

            • -

          • enrichedContent - Provides the enriched content via TextEditor.enrichHTML when content changes. - You can bind to enrichedContent from a parent component to get reactive updates though it is not - recommended to change enrichedContent externally. One-way binding.

            +
          • +

            enrichedContent - Provides the enriched content via TextEditor.enrichHTML when content changes. +You can bind to enrichedContent from a parent component to get reactive updates though it is not +recommended to change enrichedContent externally. One-way binding.

            • -

          • options - Defines the options object for this component and passed on to the Foundry TinyMCE support. - Please review all the options defined below TJSProseMirrorOptions.

            +
          • +

            options - Defines the options object for this component and passed on to the Foundry TinyMCE support. +Please review all the options defined below TJSProseMirrorOptions.

          Notable options passed onto Foundry ProseMirror support:

            -

          • options.collaborate - [boolean: false] When a document and fieldName is provided set this to true to - enable collaborative editing.

            +
          • +

            options.collaborate - [boolean: false] When a document and fieldName is provided set this to true to +enable collaborative editing.

            • -

          • options.plugins - [object] An additional set of ProseMirror plugins to load.

            +
          • +

            options.plugins - [object] An additional set of ProseMirror plugins to load.

          -

          Events

          There are five events fired when the editor is canceled, saved, and started:

          +

          Events

          There are five events fired when the editor is canceled, saved, and started:

            -

          • editor:cancel - Fired when editing is canceled by a user action or reactive response to document changes.

            +
          • +

            editor:cancel - Fired when editing is canceled by a user action or reactive response to document changes.

            • -

          • editor:document:deleted - Fired when the edited document is deleted. Access the document from - event.detail.document.

            +
          • +

            editor:document:deleted - Fired when the edited document is deleted. Access the document from +event.detail.document.

            • -

          • editor:enrichedContent - Fired when content is enriched. Access enriched content from - event.detail.enrichedContent.

            +
          • +

            editor:enrichedContent - Fired when content is enriched. Access enriched content from +event.detail.enrichedContent.

            • -

          • editor:save - Fired when editing is saved. Access the content from event.detail.content.

            +
          • +

            editor:save - Fired when editing is saved. Access the content from event.detail.content.

            • -

          • editor:start - Fired when editing is started.

            +
          • +

            editor:start - Fired when editing is started.

          -

          CSS Variables

          The following CSS variables control the associated styles with the default values:

          -
          `.editor` HTMLDivElement:
          ---------------------------------
          --tjs-editor-background - none
          --tjs-editor-border - none
          --tjs-editor-border-radius - 0
          --tjs-editor-height - 100%
          --tjs-editor-margin - 0
          --tjs-editor-overflow - auto
          --tjs-editor-transition
          --tjs-editor-width - 100%

          `.editor` HTMLDivElement; properties available when activated:
          ---------------------------------
          --tjs-editor-active-box-shadow, unset; Foundry default: 0 0 5px var(--color-shadow-primary)
          --tjs-editor-active-outline - unset
          --tjs-editor-active-overflow - unset; When inactive the editor overflow is auto; when active overflow is unset.

          `.editor` HTMLDivElement; properties available when inactive, but manually focused:
          ---------------------------------
          --tjs-editor-inactive-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
          --tjs-editor-inactive-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
          --tjs-editor-inactive-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

          `.editor` HTMLDivElement; properties available when inactive, but hovered:
          ---------------------------------
          --tjs-editor-inactive-cursor-hover - text
          --tjs-editor-inactive-box-shadow-hover - unset
          --tjs-editor-inactive-outline-hover - unset
          --tjs-editor-inactive-user-select-hover - text

          `.editor-content` HTMLDivElement; when editing - the content overflow is set to auto:
          ---------------------------------
          --tjs-editor-content-overflow - auto
          --tjs-editor-content-padding - 0 0 0 0.25em

          `.editor-container` HTMLDivElement; when editing - removes default margins.
          ---------------------------------
          --tjs-editor-container-margin - 0

          .editor-edit; Defines the position of the edit button from top / right absolute positioning:
          ---------------------------------
          --tjs-editor-edit-button-right - 5px
          --tjs-editor-edit-button-top - 0

          .editor-menu; Defines the toolbar / menu.
          ---------------------------------
          --tjs-editor-toolbar-background - rgba(0, 0, 0, 0.1)
          --tjs-editor-toolbar-border-radius - 6px
          --tjs-editor-toolbar-box-shadow - 0 2px 2px -2px rgb(34 47 62 / 10%), 0 8px 8px -4px rgb(34 47 62 / 7%)
          --tjs-editor-toolbar-padding - 2px 0
          --tjs-editor-toolbar-width - 100%
+
          CSS Variables
          The following CSS variables control the associated styles with the default values:
          
+
          `.editor` HTMLDivElement:
          ---------------------------------
          --tjs-editor-background - none
          --tjs-editor-border - none
          --tjs-editor-border-radius - 0
          --tjs-editor-height - 100%
          --tjs-editor-margin - 0
          --tjs-editor-overflow - auto
          --tjs-editor-transition
          --tjs-editor-width - 100%

          `.editor` HTMLDivElement; properties available when activated:
          ---------------------------------
          --tjs-editor-active-box-shadow, unset; Foundry default: 0 0 5px var(--color-shadow-primary)
          --tjs-editor-active-outline - unset
          --tjs-editor-active-overflow - unset; When inactive the editor overflow is auto; when active overflow is unset.

          `.editor` HTMLDivElement; properties available when inactive, but manually focused:
          ---------------------------------
          --tjs-editor-inactive-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
          --tjs-editor-inactive-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
          --tjs-editor-inactive-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

          `.editor` HTMLDivElement; properties available when inactive, but hovered:
          ---------------------------------
          --tjs-editor-inactive-cursor-hover - text
          --tjs-editor-inactive-box-shadow-hover - unset
          --tjs-editor-inactive-outline-hover - unset
          --tjs-editor-inactive-user-select-hover - text

          `.editor-content` HTMLDivElement; when editing - the content overflow is set to auto:
          ---------------------------------
          --tjs-editor-content-overflow - auto
          --tjs-editor-content-padding - 0 0 0 0.25em

          `.editor-container` HTMLDivElement; when editing - removes default margins.
          ---------------------------------
          --tjs-editor-container-margin - 0

          .editor-edit; Defines the position of the edit button from top / right absolute positioning:
          ---------------------------------
          --tjs-editor-edit-button-right - 5px
          --tjs-editor-edit-button-top - 0

          .editor-menu; Defines the toolbar / menu.
          ---------------------------------
          --tjs-editor-toolbar-background - rgba(0, 0, 0, 0.1)
          --tjs-editor-toolbar-border-radius - 6px
          --tjs-editor-toolbar-box-shadow - 0 2px 2px -2px rgb(34 47 62 / 10%), 0 8px 8px -4px rgb(34 47 62 / 7%)
          --tjs-editor-toolbar-padding - 2px 0
          --tjs-editor-toolbar-width - 100%
 
          
-

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          PropsEventsCSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSScrollContainer.html b/docs/classes/_standard_component.TJSScrollContainer.html index 0243ef59..bd5cbca7 100644 --- a/docs/classes/_standard_component.TJSScrollContainer.html +++ b/docs/classes/_standard_component.TJSScrollContainer.html @@ -1,10 +1,21 @@ -TJSScrollContainer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSScrollContainer

          Provides a convenient scrollable container / DIV that always allows keyboard scroll navigation by stopping +TJSScrollContainer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSScrollContainer

          Provides a convenient scrollable container / DIV that always allows keyboard scroll navigation by stopping propagation of page up / down key events when the active element is or is contained by the container.

          Auto serialization of scroll state is handled by providing a store / scrollTop.

          A main slot is provided for a content component, but a fallback allows a child content component to be defined by the class and props fields in TJSScrollContainerData.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSSelect.html b/docs/classes/_standard_component.TJSSelect.html index f95e260c..4c15aa91 100644 --- a/docs/classes/_standard_component.TJSSelect.html +++ b/docs/classes/_standard_component.TJSSelect.html @@ -1,7 +1,19 @@ -TJSSelect | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSSelect

          CSS Variables

          --tjs-input-appearance
          --tjs-input-background
          --tjs-input-border
          --tjs-input-border-radius
          --tjs-input-border-disabled
          --tjs-input-box-shadow-focus
          --tjs-input-box-shadow-focus-visible
          --tjs-input-color
          --tjs-input-color-disabled
          --tjs-input-cursor
          --tjs-input-cursor-disabled
          --tjs-input-flex
          --tjs-input-font-family
          --tjs-input-font-size
          --tjs-input-height
          --tjs-input-line-height
          --tjs-input-outline-focus-visible
          --tjs-input-outline-offset
          --tjs-input-overflow
          --tjs-input-text-overflow
          --tjs-input-transition-focus-visible
          --tjs-input-width

          --tjs-select-appearance
          --tjs-select-background
          --tjs-select-border
          --tjs-select-border-radius
          --tjs-select-border-disabled
          --tjs-select-box-shadow-focus
          --tjs-select-box-shadow-focus-visible
          --tjs-select-color
          --tjs-select-color-disabled
          --tjs-select-cursor
          --tjs-select-cursor-disabled
          --tjs-select-flex
          --tjs-select-font-family
          --tjs-select-font-size
          --tjs-select-height
          --tjs-select-line-height
          --tjs-select-outline-focus-visible
          --tjs-select-outline-offset
          --tjs-select-overflow
          --tjs-select-text-overflow
          --tjs-select-transition-focus-visible
          --tjs-select-width

          --tjs-select-option-background; fallback: --tjs-default-popup-background; default: #23221d
          --tjs-select-option-color; fallback: --tjs-default-popup-primary-color; default: #b5b3a4
+TJSSelect | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          
+
          Class TJSSelect
          CSS Variables
          --tjs-input-appearance
          --tjs-input-background
          --tjs-input-border
          --tjs-input-border-radius
          --tjs-input-border-disabled
          --tjs-input-box-shadow-focus
          --tjs-input-box-shadow-focus-visible
          --tjs-input-color
          --tjs-input-color-disabled
          --tjs-input-cursor
          --tjs-input-cursor-disabled
          --tjs-input-flex
          --tjs-input-font-family
          --tjs-input-font-size
          --tjs-input-height
          --tjs-input-line-height
          --tjs-input-outline-focus-visible
          --tjs-input-outline-offset
          --tjs-input-overflow
          --tjs-input-text-overflow
          --tjs-input-transition-focus-visible
          --tjs-input-width

          --tjs-select-appearance
          --tjs-select-background
          --tjs-select-border
          --tjs-select-border-radius
          --tjs-select-border-disabled
          --tjs-select-box-shadow-focus
          --tjs-select-box-shadow-focus-visible
          --tjs-select-color
          --tjs-select-color-disabled
          --tjs-select-cursor
          --tjs-select-cursor-disabled
          --tjs-select-flex
          --tjs-select-font-family
          --tjs-select-font-size
          --tjs-select-height
          --tjs-select-line-height
          --tjs-select-outline-focus-visible
          --tjs-select-outline-offset
          --tjs-select-overflow
          --tjs-select-text-overflow
          --tjs-select-transition-focus-visible
          --tjs-select-width

          --tjs-select-option-background; fallback: --tjs-default-popup-background; default: #23221d
          --tjs-select-option-color; fallback: --tjs-default-popup-primary-color; default: #b5b3a4
 
          
-
          Hierarchy (view full)
          Constructors
          constructor
+
+
          
+            
          
+              
+                 
          
+                    
+                  Hierarchy
          
+                        
+              
          
+              
          
+           
          
+         
          Constructors
          constructor
 
          Methods
          $destroy
 $on
 $set
-
          Constructors
          constructor
          Methods
          $destroy
          $on
          • $on<K>(type, callback): (() => void)
          • Type Parameters
            • K extends string
            Parameters
            Returns (() => void)
              • (): void
              • Returns void
          $set
          Settings
          Member Visibility
          Theme
          On This Page
          constructor$destroy$on$set
          
\ No newline at end of file
+

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSSettingsEdit.html b/docs/classes/_standard_component.TJSSettingsEdit.html index a41c3ed2..3d15ecd5 100644 --- a/docs/classes/_standard_component.TJSSettingsEdit.html +++ b/docs/classes/_standard_component.TJSSettingsEdit.html @@ -1,4 +1,5 @@ -TJSSettingsEdit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSSettingsEdit

          TJSSettingsEdit provides the main Svelte component to display and modify settings registered with +TJSSettingsEdit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSSettingsEdit

          TJSSettingsEdit provides the main Svelte component to display and modify settings registered with TJSGameSettings. Refer to the documentation in TJSGameSettings.register and TJSGameSettings.registerAll. Adding custom defined sections is accomplished with TJSGameSettings.addSection. You must pass an instance of TJSGameSettings as the settings prop.

          @@ -16,11 +17,22 @@ modal dialog is opened to inform the user that a setting changed that requires reloading.

          If you need an easy to use slotted component that allows swapping from the main slot and TJSSettingsEdit please refer to TJSSettingsSwap.

          -

          CSS Variables

          CSS variables available include the following options:

          -
          Top level 'main' element:
          --tjs-settings-section-background - none

          Scrollable div element:
          --tjs-settings-padding - 0

          Each section element for a grouping of settings:
          --tjs-settings-section-background - none
          --tjs-settings-section-border - none
          --tjs-settings-section-border-radius - 0
          --tjs-settings-section-margin-bottom - 0.75em
          --tjs-settings-section-padding - 0.5em
+
          CSS Variables
          CSS variables available include the following options:
          
+
          Top level 'main' element:
          --tjs-settings-section-background - none

          Scrollable div element:
          --tjs-settings-padding - 0

          Each section element for a grouping of settings:
          --tjs-settings-section-background - none
          --tjs-settings-section-border - none
          --tjs-settings-section-border-radius - 0
          --tjs-settings-section-margin-bottom - 0.75em
          --tjs-settings-section-padding - 0.5em
 
          
-

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSSettingsSwap.html b/docs/classes/_standard_component.TJSSettingsSwap.html index bc688e9a..5632bd81 100644 --- a/docs/classes/_standard_component.TJSSettingsSwap.html +++ b/docs/classes/_standard_component.TJSSettingsSwap.html @@ -1,12 +1,23 @@ -TJSSettingsSwap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSSettingsSwap

          TJSSettingsSwap provides a convenience component to swap a main slotted component with TJSSettingsEdit.

          +TJSSettingsSwap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSSettingsSwap

          TJSSettingsSwap provides a convenience component to swap a main slotted component with TJSSettingsEdit.

          The component props are the same and documented in TJSSettingsEdit. The only difference is that to support slot forwarding for TJSSettingsEdit is that you define the settings-header and settings-footer slots inside the TJSSettingsSwap content.

          Controlling the swap state is accessible from TJSGameSettings.showSettings accessor (get or set). This allows for instance the creation of an app header button to swap between the main slotted component and TJSSettingsEdit.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSSideSlideLayer.html b/docs/classes/_standard_component.TJSSideSlideLayer.html index e3bc3632..8ccf5f48 100644 --- a/docs/classes/_standard_component.TJSSideSlideLayer.html +++ b/docs/classes/_standard_component.TJSSideSlideLayer.html @@ -1,7 +1,18 @@ -TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSSideSlideLayer

          Provides a component to display an absolutely positioned side layer in a parent element featuring a column of +TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSSideSlideLayer

          Provides a component to display an absolutely positioned side layer in a parent element featuring a column of icons that slide out panels defined as Svelte components.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSSlotButton.html b/docs/classes/_standard_component.TJSSlotButton.html index bc8a1cf6..216a30b9 100644 --- a/docs/classes/_standard_component.TJSSlotButton.html +++ b/docs/classes/_standard_component.TJSSlotButton.html @@ -1,7 +1,19 @@ -TJSSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSSlotButton

          CSS Variables:

          --tjs-default-text-shadow-focus-hover: system default
          --tjs-default-outline-focus-visible: undefined; global replacement for focus-visible outline.

          --tjs-slot-button-background
          --tjs-slot-button-background-focus
          --tjs-slot-button-background-focus-visible
          --tjs-slot-button-background-hover
          --tjs-slot-button-border
          --tjs-slot-button-border-radius
          --tjs-slot-button-box-shadow-focus-visible
          --tjs-slot-button-cursor
          --tjs-slot-button-cursor-disabled
          --tjs-slot-button-diameter
          --tjs-slot-button-outline-focus-visible
          --tjs-slot-button-transition
          --tjs-slot-button-transition-focus-visible
+TJSSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          
+
          Class TJSSlotButton
          CSS Variables:
          --tjs-default-text-shadow-focus-hover: system default
          --tjs-default-outline-focus-visible: undefined; global replacement for focus-visible outline.

          --tjs-slot-button-background
          --tjs-slot-button-background-focus
          --tjs-slot-button-background-focus-visible
          --tjs-slot-button-background-hover
          --tjs-slot-button-border
          --tjs-slot-button-border-radius
          --tjs-slot-button-box-shadow-focus-visible
          --tjs-slot-button-cursor
          --tjs-slot-button-cursor-disabled
          --tjs-slot-button-diameter
          --tjs-slot-button-outline-focus-visible
          --tjs-slot-button-transition
          --tjs-slot-button-transition-focus-visible
 
          
-
          Hierarchy (view full)
          Constructors
          constructor
+
+
          
+            
          
+              
+                 
          
+                    
+                  Hierarchy
          
+                        
+              
          
+              
          
+           
          
+         
          Constructors
          constructor
 
          Methods
          $destroy
 $on
 $set
-
          Constructors
          constructor
          Methods
          $destroy
          $on
          • $on<K>(type, callback): (() => void)
          • Type Parameters
            • K extends string
            Parameters
            Returns (() => void)
              • (): void
              • Returns void
          $set
          Settings
          Member Visibility
          Theme
          On This Page
          constructor$destroy$on$set
          
\ No newline at end of file
+

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables:
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSSlotLabel.html b/docs/classes/_standard_component.TJSSlotLabel.html index 0d405d33..9a98400e 100644 --- a/docs/classes/_standard_component.TJSSlotLabel.html +++ b/docs/classes/_standard_component.TJSSlotLabel.html @@ -1,13 +1,25 @@ -TJSSlotLabel | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSSlotLabel

          Provides a slotted component wrapped in a label element. The label prop can either be a string or a Svelte +TJSSlotLabel | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSSlotLabel

          Provides a slotted component wrapped in a label element. The label prop can either be a string or a Svelte configuration object to be used as the label text. The label element uses display: contents which ignores the label element and lays out the children as if the label element does not exist which is perfect for a grid layout. Optionally, there are CSS variables available to change the display and additional flex layout configuration possibilities.

          -

          CSS Variables

          The following CSS variables control the associated styles with the default values:

          +

          CSS Variables

          The following CSS variables control the associated styles with the default values:

          For layout:
          -----------------------------------------------------
          --tjs-slot-label-display - contents
          --tjs-slot-label-flex - unset
          --tjs-slot-label-flex-direction - unset
          --tjs-slot-label-flex-wrap - unset

          For text / string label:
          -----------------------------------------------------
          --tjs-slot-label-color - inherit
          --tjs-slot-label-font-family - inherit
          --tjs-slot-label-font-size - inherit
          --tjs-slot-label-line-height - inherit
          --tjs-slot-label-text-align - right
          --tjs-slot-label-white-space - nowrap
          -

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSSlotLabelUtil.html b/docs/classes/_standard_component.TJSSlotLabelUtil.html index 1bb8951a..eabfafe3 100644 --- a/docs/classes/_standard_component.TJSSlotLabelUtil.html +++ b/docs/classes/_standard_component.TJSSlotLabelUtil.html @@ -1,5 +1,6 @@ -TJSSlotLabelUtil | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSSlotLabelUtil

          Provides a helper utility to verify if a label prop is valid for the TJSSlotLabel component.

          -

          Constructors

          constructor +TJSSlotLabelUtil | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSSlotLabelUtil

          Provides a helper utility to verify if a label prop is valid for the TJSSlotLabel component.

          +

          Constructors

          constructor

          Methods

          isValid -

          Constructors

          constructor

          Methods

          Static isValid

          • isValid(label): boolean

          • Test if the given label is valid data / prop for the TJSSlotLabel component.

            -

            Parameters

            • label: any

            Returns boolean

          Settings

          Member Visibility

          Theme

          On This Page

          constructorisValid
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          StaticisValid

          • isValid(label): boolean

          • Test if the given label is valid data / prop for the TJSSlotLabel component.

            +

            Parameters

            • label: any

            Returns boolean

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSSvgFolder.html b/docs/classes/_standard_component.TJSSvgFolder.html index 39150415..42dd7c54 100644 --- a/docs/classes/_standard_component.TJSSvgFolder.html +++ b/docs/classes/_standard_component.TJSSvgFolder.html @@ -1,10 +1,11 @@ -TJSSvgFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSSvgFolder

          TJSFolder provides a collapsible folder using the details and summary HTMLElements.

          +TJSSvgFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSSvgFolder

          TJSFolder provides a collapsible folder using the details and summary HTMLElements.

          This is a slotted component. The default slot is the collapsible contents. There are also two additional optional named slots available for the summary element. label allows setting custom content with the fallback being the label string. Additionally, summary-end allows a component or text to be slotted after the label. This can be useful for say an "expand all" button.

          -

          Exported props

            +

            Exported props

            • folder (TJSFolderData): An object defining all properties of a folder including potentially data driven minimal Svelte configuration objects (slotDefault, slotLabel, and slotSummaryEnd) providing default component implementations.
              • @@ -17,27 +18,34 @@

              -store: The store tracking the open / close state: Writable

              -styles: Styles to be applied inline via applyStyles action.

              -

              Events

              There are several events that are fired and / or bubbled up through parent elements. There are four +

              Events

              There are several events that are fired and / or bubbled up through parent elements. There are four custom events that pass a details object including: the details element, id, label, and store.

              The following events are bubbled up such that assigning a listener in any parent component receives them from all children folders:

                -

              • click - Basic MouseEvent of folder being clicked.

                +
              • +

                click - Basic MouseEvent of folder being clicked.

                • -

              • keydown - Key down event.

                +
              • +

                keydown - Key down event.

                • -

              • keyup - Key up event.

                +
              • +

                keyup - Key up event.

                • -

              • closeAny - Triggered when any child folder is closed w/ details object.

                +
              • +

                closeAny - Triggered when any child folder is closed w/ details object.

                • -

              • openAny - Triggered when any child folder is opened w/ details object.

                +
              • +

                openAny - Triggered when any child folder is opened w/ details object.

              The following events do not propagate / bubble up and can be registered with:

                -

              • close - Triggered when direct descendent folder is closed w/ details object.

                +
              • +

                close - Triggered when direct descendent folder is closed w/ details object.

                • -

              • open - Triggered when direct descendent folder is opened w/ details object.

                +
              • +

                open - Triggered when direct descendent folder is opened w/ details object.

              @@ -45,11 +53,22 @@ attributes for id and label.

              There are several local CSS variables that you can use to change the appearance dynamically. Either use CSS props or pass in a styles object w/ key / value props to set to the details element.

              -

              CSS Variables

              The following CSS variables are supported, but not defined by default:

              -
              Details element (attributes follow `--tjs-folder-details-`):
              --tjs-folder-details-margin-left: -0.4em;
              --tjs-folder-details-padding-left: 0.4em; set for children to indent more;

              Summary element (attributes follow `--tjs-folder-summary-`):
              --tjs-folder-summary-background-blend-mode: initial
              --tjs-folder-summary-background: none
              --tjs-folder-summary-background-open - fallback: --tjs-folder-summary-background; default: inherit
              --tjs-folder-summary-border: none
              --tjs-folder-summary-border-radius: 0
              --tjs-folder-summary-border-width: initial
              --tjs-folder-summary-cursor: pointer
              --tjs-folder-summary-font-size: inherit
              --tjs-folder-summary-font-weight: bold
              --tjs-folder-summary-font-family: inherit
              --tjs-folder-summary-gap: 0.125em
              --tjs-folder-summary-padding: 0.25em
              --tjs-folder-summary-transition: background 0.1s
              --tjs-folder-summary-width: fit-content; wraps content initially, set to 100% or other width measurement

              Summary element (focus visible):
              --tjs-folder-summary-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
              --tjs-folder-summary-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
              --tjs-folder-summary-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

              A keyboard focus indicator is defined by the following CSS variables:
              --tjs-folder-summary-focus-indicator-align-self - fallback: --tjs-default-focus-indicator-align-self; default: stretch
              --tjs-folder-summary-focus-indicator-background - fallback: --tjs-default-focus-indicator-background; default: white
              --tjs-folder-summary-focus-indicator-border - fallback: --tjs-default-focus-indicator-border; default: undefined
              --tjs-folder-summary-focus-indicator-border-radius - fallback: --tjs-default-focus-indicator-border-radius; default: 0.1em
              --tjs-folder-summary-focus-indicator-height - fallback: --tjs-default-focus-indicator-height; default: undefined
              --tjs-folder-summary-focus-indicator-transition - fallback: --tjs-default-focus-indicator-transition
              --tjs-folder-summary-focus-indicator-width - fallback: --tjs-default-focus-indicator-width; default: 0.25em

              Summary SVG / chevron element (attributes follow `--tjs-folder-summary-chevron-`):

              The width and height use multiple fallback variables before setting a default of 1.25em. You can provide
              `--tjs-folder-summary-chevron-size`. If not provided then the chevron dimensions are set by
              `--tjs-folder-summary-font-size`; default: 1.25em.

              --tjs-folder-summary-chevron-border-radius: 0
              --tjs-folder-summary-chevron-color: currentColor
              --tjs-folder-summary-chevron-opacity: 0.2; Opacity when not hovering.
              --tjs-folder-summary-chevron-opacity-focus-visible: 1; When summary focus-visible.
              --tjs-folder-summary-chevron-opacity-hover: 1; Opacity when hovering.
              --tjs-folder-summary-chevron-margin: 0;
              --tjs-folder-summary-chevron-transition: opacity 0.2s, transform 0.1s
              --tjs-folder-summary-chevron-rotate-closed: -90deg; rotation angle when closed.
              --tjs-folder-summary-chevron-rotate-open: 0; rotation angle when open.

              Summary label element (attributes follow `--tjs-folder-summary-label-):

              By default, the label element does not wrap and uses ellipsis for text overflow.

              --tjs-folder-summary-label-overflow: hidden
              --tjs-folder-summary-label-text-overflow: ellipsis
              --tjs-folder-summary-label-white-space: nowrap
              --tjs-folder-summary-label-width: fit-content

              Default label (focus visible):
              --tjs-folder-summary-label-text-shadow-focus-visible - fallback: --tjs-default-text-shadow-focus-hover; default: revert

              Contents element (attributes follow `--tjs-folder-contents-`):
              --tjs-folder-contents-background-blend-mode: initial
              --tjs-folder-contents-background: none
              --tjs-folder-contents-border: none
              --tjs-folder-contents-margin: 0 0 0 -0.4em

              Padding is set directly by `--tjs-folder-contents-padding` or follows the following calculation:
              `0 0 0 calc(var(--tjs-folder-summary-font-size, 1em) * 0.8)`

              If neither `--tjs-folder-contents-padding` or `--tjs-folder-summary-font-size` is defined the default is
              `1em * 0.8`.
+
              CSS Variables
              The following CSS variables are supported, but not defined by default:
              
+
              Details element (attributes follow `--tjs-folder-details-`):
              --tjs-folder-details-margin-left: -0.4em;
              --tjs-folder-details-padding-left: 0.4em; set for children to indent more;

              Summary element (attributes follow `--tjs-folder-summary-`):
              --tjs-folder-summary-background-blend-mode: initial
              --tjs-folder-summary-background: none
              --tjs-folder-summary-background-open - fallback: --tjs-folder-summary-background; default: inherit
              --tjs-folder-summary-border: none
              --tjs-folder-summary-border-radius: 0
              --tjs-folder-summary-border-width: initial
              --tjs-folder-summary-cursor: pointer
              --tjs-folder-summary-font-size: inherit
              --tjs-folder-summary-font-weight: bold
              --tjs-folder-summary-font-family: inherit
              --tjs-folder-summary-gap: 0.125em
              --tjs-folder-summary-padding: 0.25em
              --tjs-folder-summary-transition: background 0.1s
              --tjs-folder-summary-width: fit-content; wraps content initially, set to 100% or other width measurement

              Summary element (focus visible):
              --tjs-folder-summary-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
              --tjs-folder-summary-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
              --tjs-folder-summary-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

              A keyboard focus indicator is defined by the following CSS variables:
              --tjs-folder-summary-focus-indicator-align-self - fallback: --tjs-default-focus-indicator-align-self; default: stretch
              --tjs-folder-summary-focus-indicator-background - fallback: --tjs-default-focus-indicator-background; default: white
              --tjs-folder-summary-focus-indicator-border - fallback: --tjs-default-focus-indicator-border; default: undefined
              --tjs-folder-summary-focus-indicator-border-radius - fallback: --tjs-default-focus-indicator-border-radius; default: 0.1em
              --tjs-folder-summary-focus-indicator-height - fallback: --tjs-default-focus-indicator-height; default: undefined
              --tjs-folder-summary-focus-indicator-transition - fallback: --tjs-default-focus-indicator-transition
              --tjs-folder-summary-focus-indicator-width - fallback: --tjs-default-focus-indicator-width; default: 0.25em

              Summary SVG / chevron element (attributes follow `--tjs-folder-summary-chevron-`):

              The width and height use multiple fallback variables before setting a default of 1.25em. You can provide
              `--tjs-folder-summary-chevron-size`. If not provided then the chevron dimensions are set by
              `--tjs-folder-summary-font-size`; default: 1.25em.

              --tjs-folder-summary-chevron-border-radius: 0
              --tjs-folder-summary-chevron-color: currentColor
              --tjs-folder-summary-chevron-opacity: 0.2; Opacity when not hovering.
              --tjs-folder-summary-chevron-opacity-focus-visible: 1; When summary focus-visible.
              --tjs-folder-summary-chevron-opacity-hover: 1; Opacity when hovering.
              --tjs-folder-summary-chevron-margin: 0;
              --tjs-folder-summary-chevron-transition: opacity 0.2s, transform 0.1s
              --tjs-folder-summary-chevron-rotate-closed: -90deg; rotation angle when closed.
              --tjs-folder-summary-chevron-rotate-open: 0; rotation angle when open.

              Summary label element (attributes follow `--tjs-folder-summary-label-):

              By default, the label element does not wrap and uses ellipsis for text overflow.

              --tjs-folder-summary-label-overflow: hidden
              --tjs-folder-summary-label-text-overflow: ellipsis
              --tjs-folder-summary-label-white-space: nowrap
              --tjs-folder-summary-label-width: fit-content

              Default label (focus visible):
              --tjs-folder-summary-label-text-shadow-focus-visible - fallback: --tjs-default-text-shadow-focus-hover; default: revert

              Contents element (attributes follow `--tjs-folder-contents-`):
              --tjs-folder-contents-background-blend-mode: initial
              --tjs-folder-contents-background: none
              --tjs-folder-contents-border: none
              --tjs-folder-contents-margin: 0 0 0 -0.4em

              Padding is set directly by `--tjs-folder-contents-padding` or follows the following calculation:
              `0 0 0 calc(var(--tjs-folder-summary-font-size, 1em) * 0.8)`

              If neither `--tjs-folder-contents-padding` or `--tjs-folder-summary-font-size` is defined the default is
              `1em * 0.8`.
 
              
-

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          Exported propsEventsCSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSTinyMCE.html b/docs/classes/_standard_component.TJSTinyMCE.html index 83012c31..12e8567d 100644 --- a/docs/classes/_standard_component.TJSTinyMCE.html +++ b/docs/classes/_standard_component.TJSTinyMCE.html @@ -1,42 +1,62 @@ -TJSTinyMCE | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSTinyMCE

          Provides a reactive wrapper for Foundry TinyMCE editor support. Allows editing Foundry document data or +TJSTinyMCE | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSTinyMCE

          Provides a reactive wrapper for Foundry TinyMCE editor support. Allows editing Foundry document data or directly from content prop. Automatic HTML enrichment occurs for the content when saved.

          -

          Props

          There are no required props, but the following are available to set:

          +

          Props

          There are no required props, but the following are available to set:

            -

          • content - Provides an initial content string; you can bind to content from a parent component to get - reactive updates when content changes. Two-way binding.

            +
          • +

            content - Provides an initial content string; you can bind to content from a parent component to get +reactive updates when content changes. Two-way binding.

            • -

          • enrichedContent - Provides the enriched content via TextEditor.enrichHTML when content changes. - You can bind to enrichedContent from a parent component to get reactive updates though it is not recommended - to change enrichedContent externally. One-way binding.

            +
          • +

            enrichedContent - Provides the enriched content via TextEditor.enrichHTML when content changes. +You can bind to enrichedContent from a parent component to get reactive updates though it is not recommended +to change enrichedContent externally. One-way binding.

            • -

          • options - Defines the options object for this component and passed on to the Foundry TinyMCE support. - Please review all the options defined below TJSTinyMCEOptions.

            +
          • +

            options - Defines the options object for this component and passed on to the Foundry TinyMCE support. +Please review all the options defined below TJSTinyMCEOptions.

          Notable options passed onto TinyMCE instance:

          • options.mceConfig - [object] TinyMCE configuration object.
          -

          Events

          There are five events fired when the editor is canceled, saved, and started.

          +

          Events

          There are five events fired when the editor is canceled, saved, and started.

            -

          • editor:cancel - Fired when editing is canceled by a user action or reactive response to document changes.

            +
          • +

            editor:cancel - Fired when editing is canceled by a user action or reactive response to document changes.

            • -

          • editor:document:deleted - Fired when the edited document is deleted. Access the document from - event.detail.document.

            +
          • +

            editor:document:deleted - Fired when the edited document is deleted. Access the document from +event.detail.document.

            • -

          • editor:enrichedContent - Fired when content is enriched. Access enriched content from - event.detail.enrichedContent.

            +
          • +

            editor:enrichedContent - Fired when content is enriched. Access enriched content from +event.detail.enrichedContent.

            • -

          • editor:save - Fired when editing is saved. Access the content from event.detail.content.

            +
          • +

            editor:save - Fired when editing is saved. Access the content from event.detail.content.

            • -

          • editor:start - Fired when editing is started.

            +
          • +

            editor:start - Fired when editing is started.

          -

          CSS Variables

          The following CSS variables control the associated styles with the default values:

          -
          `.editor` HTMLDivElement:
          ---------------------------------
          --tjs-editor-background - none
          --tjs-editor-border - none
          --tjs-editor-border-radius - 0
          --tjs-editor-height - 100%
          --tjs-editor-margin - 0
          --tjs-editor-transition
          --tjs-editor-width - 100%

          `.editor` HTMLDivElement; properties available when activated:
          ---------------------------------
          --tjs-editor-active-box-shadow, unset; Foundry default: 0 0 5px var(--color-shadow-primary)
          --tjs-editor-active-outline - unset
          --tjs-editor-active-overflow - unset; When inactive the editor overflow is auto; when active overflow is unset.

          `.editor` HTMLDivElement; properties available when inactive, but manually focused:
          ---------------------------------
          --tjs-editor-inactive-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
          --tjs-editor-inactive-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
          --tjs-editor-inactive-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

          `.editor` HTMLDivElement; properties available when inactive, but hovered:
          ---------------------------------
          --tjs-editor-inactive-cursor-hover - text
          --tjs-editor-inactive-box-shadow-hover - unset
          --tjs-editor-inactive-outline-hover - unset
          --tjs-editor-inactive-user-select-hover - text

          `.editor-content` HTMLDivElement; when editing - the content overflow is set to auto:
          ---------------------------------
          --tjs-editor-content-color - #000
          --tjs-editor-content-font-family - "Signika"
          --tjs-editor-content-font-size - 10.5pt
          --tjs-editor-content-line-height - 1.2
          --tjs-editor-content-overflow - auto
          --tjs-editor-content-padding - 0

          `.editor-container` HTMLDivElement; when editing - removes default margins.
          ---------------------------------
          --tjs-editor-container-margin - 0

          .editor-edit; Defines the position of the edit button from top / right absolute positioning:
          ---------------------------------
          --tjs-editor-edit-button-right - 5px
          --tjs-editor-edit-button-top - 0

          Various TinyMCE `tox` toolbar elements; Defines the toolbar / menu.
          ---------------------------------
          --tjs-editor-menu-item-active-background - #dee0e2 - This targets the auxiliary TMCE menus.
          --tjs-editor-toolbar-background - rgba(0, 0, 0, 0.1)
          --tjs-editor-toolbar-border-radius - 6px
          --tjs-editor-toolbar-button-background - none
          --tjs-editor-toolbar-button-background-hover - var(--color-hover-bg, #f0f0e0))
          --tjs-editor-toolbar-button-color - var(--color-text-dark-primary, #191813)
          --tjs-editor-toolbar-button-disabled-color - rgba(34, 47, 62, .5)
          --tjs-editor-toolbar-box-shadow - 0 2px 2px -2px rgb(34 47 62 / 10%), 0 8px 8px -4px rgb(34 47 62 / 7%)
          --tjs-editor-toolbar-chevron-active-color - var(--color-text-dark-primary, #191813))
          --tjs-editor-toolbar-chevron-inactive-color - var(--color-text-light-7, #888))
          --tjs-editor-toolbar-padding - 0 2px
          --tjs-editor-toolbar-separator-border - 1px solid var(--color-text-light-3, #ccc)
          --tjs-editor-toolbar-select-background - var(--color-control-bg, #d9d8c8)
          --tjs-editor-toolbar-width - 100%
+
          CSS Variables
          The following CSS variables control the associated styles with the default values:
          
+
          `.editor` HTMLDivElement:
          ---------------------------------
          --tjs-editor-background - none
          --tjs-editor-border - none
          --tjs-editor-border-radius - 0
          --tjs-editor-height - 100%
          --tjs-editor-margin - 0
          --tjs-editor-transition
          --tjs-editor-width - 100%

          `.editor` HTMLDivElement; properties available when activated:
          ---------------------------------
          --tjs-editor-active-box-shadow, unset; Foundry default: 0 0 5px var(--color-shadow-primary)
          --tjs-editor-active-outline - unset
          --tjs-editor-active-overflow - unset; When inactive the editor overflow is auto; when active overflow is unset.

          `.editor` HTMLDivElement; properties available when inactive, but manually focused:
          ---------------------------------
          --tjs-editor-inactive-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
          --tjs-editor-inactive-outline-focus-visible - fallback: --tjs-default-outline-focus-visible; default: revert
          --tjs-editor-inactive-transition-focus-visible - fallback: --tjs-default-transition-focus-visible

          `.editor` HTMLDivElement; properties available when inactive, but hovered:
          ---------------------------------
          --tjs-editor-inactive-cursor-hover - text
          --tjs-editor-inactive-box-shadow-hover - unset
          --tjs-editor-inactive-outline-hover - unset
          --tjs-editor-inactive-user-select-hover - text

          `.editor-content` HTMLDivElement; when editing - the content overflow is set to auto:
          ---------------------------------
          --tjs-editor-content-color - #000
          --tjs-editor-content-font-family - "Signika"
          --tjs-editor-content-font-size - 10.5pt
          --tjs-editor-content-line-height - 1.2
          --tjs-editor-content-overflow - auto
          --tjs-editor-content-padding - 0

          `.editor-container` HTMLDivElement; when editing - removes default margins.
          ---------------------------------
          --tjs-editor-container-margin - 0

          .editor-edit; Defines the position of the edit button from top / right absolute positioning:
          ---------------------------------
          --tjs-editor-edit-button-right - 5px
          --tjs-editor-edit-button-top - 0

          Various TinyMCE `tox` toolbar elements; Defines the toolbar / menu.
          ---------------------------------
          --tjs-editor-menu-item-active-background - #dee0e2 - This targets the auxiliary TMCE menus.
          --tjs-editor-toolbar-background - rgba(0, 0, 0, 0.1)
          --tjs-editor-toolbar-border-radius - 6px
          --tjs-editor-toolbar-button-background - none
          --tjs-editor-toolbar-button-background-hover - var(--color-hover-bg, #f0f0e0))
          --tjs-editor-toolbar-button-color - var(--color-text-dark-primary, #191813)
          --tjs-editor-toolbar-button-disabled-color - rgba(34, 47, 62, .5)
          --tjs-editor-toolbar-box-shadow - 0 2px 2px -2px rgb(34 47 62 / 10%), 0 8px 8px -4px rgb(34 47 62 / 7%)
          --tjs-editor-toolbar-chevron-active-color - var(--color-text-dark-primary, #191813))
          --tjs-editor-toolbar-chevron-inactive-color - var(--color-text-light-7, #888))
          --tjs-editor-toolbar-padding - 0 2px
          --tjs-editor-toolbar-separator-border - 1px solid var(--color-text-light-3, #ccc)
          --tjs-editor-toolbar-select-background - var(--color-control-bg, #d9d8c8)
          --tjs-editor-toolbar-width - 100%
 
          
-

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          PropsEventsCSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSToggleIconButton.html b/docs/classes/_standard_component.TJSToggleIconButton.html index 85f71c23..02f11547 100644 --- a/docs/classes/_standard_component.TJSToggleIconButton.html +++ b/docs/classes/_standard_component.TJSToggleIconButton.html @@ -1,7 +1,19 @@ -TJSToggleIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSToggleIconButton

          CSS Variables

          --tjs-default-text-shadow-focus-hover: system default
          --tjs-default-outline-focus-visible: undefined; global replacement for focus-visible outline.

          --tjs-button-background
          --tjs-button-background-focus
          --tjs-button-background-focus-visible
          --tjs-button-background-hover
          --tjs-button-background-selected
          --tjs-button-border
          --tjs-button-border-radius
          --tjs-button-border-width
          --tjs-button-box-shadow-focus-visible
          --tjs-button-clip-path
          --tjs-button-clip-path-focus
          --tjs-button-clip-path-hover
          --tjs-button-cursor
          --tjs-button-cursor-disabled
          --tjs-button-diameter
          --tjs-button-outline-focus-visible
          --tjs-button-text-shadow-focus: undefined
          --tjs-button-text-shadow-hover: undefined
          --tjs-button-transition
          --tjs-button-transition-focus-visible

          --tjs-icon-button-background
          --tjs-icon-button-background-focus
          --tjs-icon-button-background-focus-visible
          --tjs-icon-button-background-hover
          --tjs-icon-button-background-selected
          --tjs-icon-button-border
          --tjs-icon-button-border-radius
          --tjs-icon-button-border-width
          --tjs-icon-button-box-shadow-focus-visible
          --tjs-icon-button-clip-path
          --tjs-icon-button-clip-path-focus
          --tjs-icon-button-clip-path-hover
          --tjs-icon-button-cursor
          --tjs-icon-button-cursor-disabled
          --tjs-icon-button-diameter
          --tjs-icon-button-outline-focus-visible
          --tjs-icon-button-text-shadow-focus: undefined
          --tjs-icon-button-text-shadow-hover: undefined
          --tjs-icon-button-transition
          --tjs-icon-button-transition-focus-visible
+TJSToggleIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          
+
          Class TJSToggleIconButton
          CSS Variables
          --tjs-default-text-shadow-focus-hover: system default
          --tjs-default-outline-focus-visible: undefined; global replacement for focus-visible outline.

          --tjs-button-background
          --tjs-button-background-focus
          --tjs-button-background-focus-visible
          --tjs-button-background-hover
          --tjs-button-background-selected
          --tjs-button-border
          --tjs-button-border-radius
          --tjs-button-border-width
          --tjs-button-box-shadow-focus-visible
          --tjs-button-clip-path
          --tjs-button-clip-path-focus
          --tjs-button-clip-path-hover
          --tjs-button-cursor
          --tjs-button-cursor-disabled
          --tjs-button-diameter
          --tjs-button-outline-focus-visible
          --tjs-button-text-shadow-focus: undefined
          --tjs-button-text-shadow-hover: undefined
          --tjs-button-transition
          --tjs-button-transition-focus-visible

          --tjs-icon-button-background
          --tjs-icon-button-background-focus
          --tjs-icon-button-background-focus-visible
          --tjs-icon-button-background-hover
          --tjs-icon-button-background-selected
          --tjs-icon-button-border
          --tjs-icon-button-border-radius
          --tjs-icon-button-border-width
          --tjs-icon-button-box-shadow-focus-visible
          --tjs-icon-button-clip-path
          --tjs-icon-button-clip-path-focus
          --tjs-icon-button-clip-path-hover
          --tjs-icon-button-cursor
          --tjs-icon-button-cursor-disabled
          --tjs-icon-button-diameter
          --tjs-icon-button-outline-focus-visible
          --tjs-icon-button-text-shadow-focus: undefined
          --tjs-icon-button-text-shadow-hover: undefined
          --tjs-icon-button-transition
          --tjs-icon-button-transition-focus-visible
 
          
-
          Hierarchy (view full)
          Constructors
          constructor
+
+
          
+            
          
+              
+                 
          
+                    
+                  Hierarchy
          
+                        
+              
          
+              
          
+           
          
+         
          Constructors
          constructor
 
          Methods
          $destroy
 $on
 $set
-
          Constructors
          constructor
          Methods
          $destroy
          $on
          • $on<K>(type, callback): (() => void)
          • Type Parameters
            • K extends string
            Parameters
            Returns (() => void)
              • (): void
              • Returns void
          $set
          Settings
          Member Visibility
          Theme
          On This Page
          constructor$destroy$on$set
          
\ No newline at end of file
+

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TJSToggleLabel.html b/docs/classes/_standard_component.TJSToggleLabel.html index 585ffa6e..ebb062e9 100644 --- a/docs/classes/_standard_component.TJSToggleLabel.html +++ b/docs/classes/_standard_component.TJSToggleLabel.html @@ -1,7 +1,19 @@ -TJSToggleLabel | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSToggleLabel

          CSS Variables

          --tjs-toggle-label-background
          --tjs-toggle-label-background-focus-visible
          --tjs-toggle-label-background-hover
          --tjs-toggle-label-background-selected
          --tjs-toggle-label-border
          --tjs-toggle-label-border-radius
          --tjs-toggle-label-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
          --tjs-toggle-label-font-size - inherit
          --tjs-toggle-label-font-weight - inherit
          --tjs-toggle-label-font-family - inherit
          --tjs-toggle-label-overflow - hidden
          --tjs-toggle-label-padding - 0
          --tjs-toggle-label-text-shadow-focus - undefined; default: --tjs-default-text-shadow-focus-hover
          --tjs-toggle-label-text-shadow-hover - undefined; default: --tjs-default-text-shadow-focus-hover
          --tjs-toggle-label-text-shadow-selected - undefined; default: --tjs-default-text-shadow-focus-hover
          --tjs-toggle-label-transition - global default: 'background 0.2s ease-in-out'
          --tjs-toggle-label-transition-focus-visible - fallback: --tjs-default-transition-focus-visible
+TJSToggleLabel | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          
+
          Class TJSToggleLabel
          CSS Variables
          --tjs-toggle-label-background
          --tjs-toggle-label-background-focus-visible
          --tjs-toggle-label-background-hover
          --tjs-toggle-label-background-selected
          --tjs-toggle-label-border
          --tjs-toggle-label-border-radius
          --tjs-toggle-label-box-shadow-focus-visible - fallback: --tjs-default-box-shadow-focus-visible
          --tjs-toggle-label-font-size - inherit
          --tjs-toggle-label-font-weight - inherit
          --tjs-toggle-label-font-family - inherit
          --tjs-toggle-label-overflow - hidden
          --tjs-toggle-label-padding - 0
          --tjs-toggle-label-text-shadow-focus - undefined; default: --tjs-default-text-shadow-focus-hover
          --tjs-toggle-label-text-shadow-hover - undefined; default: --tjs-default-text-shadow-focus-hover
          --tjs-toggle-label-text-shadow-selected - undefined; default: --tjs-default-text-shadow-focus-hover
          --tjs-toggle-label-transition - global default: 'background 0.2s ease-in-out'
          --tjs-toggle-label-transition-focus-visible - fallback: --tjs-default-transition-focus-visible
 
          
-
          Hierarchy (view full)
          Constructors
          constructor
+
+
          
+            
          
+              
+                 
          
+                    
+                  Hierarchy
          
+                        
+              
          
+              
          
+           
          
+         
          Constructors
          constructor
 
          Methods
          $destroy
 $on
 $set
-
          Constructors
          constructor
          Methods
          $destroy
          $on
          • $on<K>(type, callback): (() => void)
          • Type Parameters
            • K extends string
            Parameters
            Returns (() => void)
              • (): void
              • Returns void
          $set
          Settings
          Member Visibility
          Theme
          On This Page
          constructor$destroy$on$set
          
\ No newline at end of file
+

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          CSS Variables
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component.TinyMCEHelper.html b/docs/classes/_standard_component.TinyMCEHelper.html index 5749f042..b47842c0 100644 --- a/docs/classes/_standard_component.TinyMCEHelper.html +++ b/docs/classes/_standard_component.TinyMCEHelper.html @@ -1,64 +1,65 @@ -TinyMCEHelper | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TinyMCEHelper

          Provides custom options for TinyMCE.

          +TinyMCEHelper | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TinyMCEHelper

          Provides custom options for TinyMCE.

          Please see CONFIG.TinyMCE for the default Foundry options.

          -

          Constructors

          constructor +

          Constructors

          constructor

          Methods

          configBasic configStandard configTJS optionsSingleLine -

          Constructors

          constructor

          Methods

          Static configBasic

          • configBasic(opts?): object

          • Provides a very basic / limited TinyMCE config that limits the ability to apply many styles from the toolbar +

          Constructors

          constructor

          Methods

          StaticconfigBasic

          • configBasic(opts?): object

          • Provides a very basic / limited TinyMCE config that limits the ability to apply many styles from the toolbar or with key commands.

            -

            Parameters

            • Optional opts: {
                  basicFormats?: boolean;
                  contentCSS?: string[];
                  contentStyle?: string;
                  fontFormat?: boolean;
                  fontSize?: boolean;
                  help?: boolean;
                  stripStyleFormat?: boolean;
                  styleFormat?: boolean;
                  tjsStyles?: boolean;
                  toolbar?: boolean;
              }

              Optional parameters.

              -
              • Optional basicFormats?: boolean

                When true, only basic style formats are allowed.

                -
              • Optional contentCSS?: string[]

                An array of CSS paths to load. getRoute will be applied to them.

                -
              • Optional contentStyle?: string

                The same content style string for TinyMCE options.

                -
              • Optional fontFormat?: boolean

                Includes font select box.

                -
              • Optional fontSize?: boolean

                Includes font size select box.

                -
              • Optional help?: boolean

                When true include help plugin / toolbar button.

                -
              • Optional stripStyleFormat?: boolean

                Strips any additional style formats added by other modules.

                -
              • Optional styleFormat?: boolean

                Includes style format select box.

                -
              • Optional tjsStyles?: boolean

                Includes extensive TJS styling options.

                -
              • Optional toolbar?: boolean

                Includes the editor toolbar.

                +

                Parameters

                • Optionalopts: {
                      basicFormats?: boolean;
                      contentCSS?: string[];
                      contentStyle?: string;
                      fontFormat?: boolean;
                      fontSize?: boolean;
                      help?: boolean;
                      stripStyleFormat?: boolean;
                      styleFormat?: boolean;
                      tjsStyles?: boolean;
                      toolbar?: boolean;
                  }

                  Optional parameters.

                  +
                  • OptionalbasicFormats?: boolean

                    When true, only basic style formats are allowed.

                    +
                  • OptionalcontentCSS?: string[]

                    An array of CSS paths to load. getRoute will be applied to them.

                    +
                  • OptionalcontentStyle?: string

                    The same content style string for TinyMCE options.

                    +
                  • OptionalfontFormat?: boolean

                    Includes font select box.

                    +
                  • OptionalfontSize?: boolean

                    Includes font size select box.

                    +
                  • Optionalhelp?: boolean

                    When true include help plugin / toolbar button.

                    +
                  • OptionalstripStyleFormat?: boolean

                    Strips any additional style formats added by other modules.

                    +
                  • OptionalstyleFormat?: boolean

                    Includes style format select box.

                    +
                  • OptionaltjsStyles?: boolean

                    Includes extensive TJS styling options.

                    +
                  • Optionaltoolbar?: boolean

                    Includes the editor toolbar.

                Returns object

                TinyMCE options

                -

          Static configStandard

          • configStandard(opts?): object

          • Provides the standard TinyMCE configuration options. This is similar to standard core configuration and the +

          StaticconfigStandard

          • configStandard(opts?): object

          • Provides the standard TinyMCE configuration options. This is similar to standard core configuration and the ProseMirror editor.

            -

            Parameters

            • Optional opts: {
                  basicFormats?: boolean;
                  code?: boolean;
                  contentCSS?: string[];
                  contentStyle?: string;
                  fontFormat?: boolean;
                  fontSize?: boolean;
                  help?: boolean;
                  stripStyleFormat?: boolean;
                  styleFormat?: boolean;
                  tjsOembed?: boolean;
                  tjsStyles?: boolean;
                  toolbar?: boolean;
              }

              Optional parameters.

              -
              • Optional basicFormats?: boolean

                When true, only basic style formats are allowed.

                -
              • Optional code?: boolean

                When true include source code editing option.

                -
              • Optional contentCSS?: string[]

                An array of CSS paths to load. getRoute will be applied to them.

                -
              • Optional contentStyle?: string

                The same content style string for TinyMCE options.

                -
              • Optional fontFormat?: boolean

                Includes font select box.

                -
              • Optional fontSize?: boolean

                Includes font size select box.

                -
              • Optional help?: boolean

                When true include help plugin / toolbar button.

                -
              • Optional stripStyleFormat?: boolean

                Strips any additional style formats added by other modules.

                -
              • Optional styleFormat?: boolean

                Includes style format select box.

                -
              • Optional tjsOembed?: boolean

                Includes custom oEmbed plugin to include video from YouTube / Vimeo.

                -
              • Optional tjsStyles?: boolean

                Includes extensive TJS styling options.

                -
              • Optional toolbar?: boolean

                Includes the editor toolbar.

                +

                Parameters

                • Optionalopts: {
                      basicFormats?: boolean;
                      code?: boolean;
                      contentCSS?: string[];
                      contentStyle?: string;
                      fontFormat?: boolean;
                      fontSize?: boolean;
                      help?: boolean;
                      stripStyleFormat?: boolean;
                      styleFormat?: boolean;
                      tjsOembed?: boolean;
                      tjsStyles?: boolean;
                      toolbar?: boolean;
                  }

                  Optional parameters.

                  +
                  • OptionalbasicFormats?: boolean

                    When true, only basic style formats are allowed.

                    +
                  • Optionalcode?: boolean

                    When true include source code editing option.

                    +
                  • OptionalcontentCSS?: string[]

                    An array of CSS paths to load. getRoute will be applied to them.

                    +
                  • OptionalcontentStyle?: string

                    The same content style string for TinyMCE options.

                    +
                  • OptionalfontFormat?: boolean

                    Includes font select box.

                    +
                  • OptionalfontSize?: boolean

                    Includes font size select box.

                    +
                  • Optionalhelp?: boolean

                    When true include help plugin / toolbar button.

                    +
                  • OptionalstripStyleFormat?: boolean

                    Strips any additional style formats added by other modules.

                    +
                  • OptionalstyleFormat?: boolean

                    Includes style format select box.

                    +
                  • OptionaltjsOembed?: boolean

                    Includes custom oEmbed plugin to include video from YouTube / Vimeo.

                    +
                  • OptionaltjsStyles?: boolean

                    Includes extensive TJS styling options.

                    +
                  • Optionaltoolbar?: boolean

                    Includes the editor toolbar.

                Returns object

                TinyMCE options

                -

          Static configTJS

          • configTJS(opts?): object

          • Provides the TJS super cool TinyMCE configuration options. These options are selected for increased media +

          StaticconfigTJS

          • configTJS(opts?): object

          • Provides the TJS super cool TinyMCE configuration options. These options are selected for increased media embedding and styling flexibility.

            -

            Parameters

            • Optional opts: {
                  basicFormats?: boolean;
                  code?: boolean;
                  contentCSS?: string[];
                  contentStyle?: string;
                  fontFormat?: boolean;
                  fontSize?: boolean;
                  help?: boolean;
                  stripStyleFormat?: boolean;
                  styleFormat?: boolean;
                  tjsOembed?: boolean;
                  tjsStyles?: boolean;
                  toolbar?: boolean;
              }

              Optional parameters.

              -
              • Optional basicFormats?: boolean

                When true, only basic style formats are allowed.

                -
              • Optional code?: boolean

                When true include source code editing option.

                -
              • Optional contentCSS?: string[]

                An array of CSS paths to load. getRoute will be applied to them.

                -
              • Optional contentStyle?: string

                The same content style string for TinyMCE options.

                -
              • Optional fontFormat?: boolean

                Includes font formats, size, line spacing and color options.

                -
              • Optional fontSize?: boolean

                Includes font size options.

                -
              • Optional help?: boolean

                When true include help plugin / toolbar button.

                -
              • Optional stripStyleFormat?: boolean

                Strips any additional style formats added by other modules.

                -
              • Optional styleFormat?: boolean

                Includes style format select box.

                -
              • Optional tjsOembed?: boolean

                Includes custom oEmbed plugin to include video from YouTube / Vimeo.

                -
              • Optional tjsStyles?: boolean

                Includes extensive TJS styling options.

                -
              • Optional toolbar?: boolean

                Includes the editor toolbar.

                +

                Parameters

                • Optionalopts: {
                      basicFormats?: boolean;
                      code?: boolean;
                      contentCSS?: string[];
                      contentStyle?: string;
                      fontFormat?: boolean;
                      fontSize?: boolean;
                      help?: boolean;
                      stripStyleFormat?: boolean;
                      styleFormat?: boolean;
                      tjsOembed?: boolean;
                      tjsStyles?: boolean;
                      toolbar?: boolean;
                  }

                  Optional parameters.

                  +
                  • OptionalbasicFormats?: boolean

                    When true, only basic style formats are allowed.

                    +
                  • Optionalcode?: boolean

                    When true include source code editing option.

                    +
                  • OptionalcontentCSS?: string[]

                    An array of CSS paths to load. getRoute will be applied to them.

                    +
                  • OptionalcontentStyle?: string

                    The same content style string for TinyMCE options.

                    +
                  • OptionalfontFormat?: boolean

                    Includes font formats, size, line spacing and color options.

                    +
                  • OptionalfontSize?: boolean

                    Includes font size options.

                    +
                  • Optionalhelp?: boolean

                    When true include help plugin / toolbar button.

                    +
                  • OptionalstripStyleFormat?: boolean

                    Strips any additional style formats added by other modules.

                    +
                  • OptionalstyleFormat?: boolean

                    Includes style format select box.

                    +
                  • OptionaltjsOembed?: boolean

                    Includes custom oEmbed plugin to include video from YouTube / Vimeo.

                    +
                  • OptionaltjsStyles?: boolean

                    Includes extensive TJS styling options.

                    +
                  • Optionaltoolbar?: boolean

                    Includes the editor toolbar.

                Returns object

                TinyMCE options

                -

          Static optionsSingleLine

          • optionsSingleLine(opts?): object

          • Provides a combined mceConfig and other default options to create a single line editor that prevents pasting, +

          StaticoptionsSingleLine

          • optionsSingleLine(opts?): object

          • Provides a combined mceConfig and other default options to create a single line editor that prevents pasting, prevents enter key / new lines, saves on editor blur, and doesn't show the toolbar. This is useful as a shortcut to enable TJSTinyMCE to act as a content editable text entry for a single line text field.

            Note: Since this function returns an object w/ mceConfig and other options you must use it like in TJSTinyMCE options; where font-size in contentStyleBody and any other styles match the editor CSS variables:

            ...TinyMCEHelper.configSingleLine({ contentStyleBody: { 'font-size': '22pt' }})

            -

            Parameters

            • Optional opts: {
                  contentCSS?: string[];
                  contentStyle?: string;
              }

              Optional parameters.

              -
              • Optional contentCSS?: string[]

                An array of CSS paths to load. getRoute will be applied to them.

                -
              • Optional contentStyle?: string

                The same content style string for TinyMCE options.

                +

                Parameters

                • Optionalopts: {
                      contentCSS?: string[];
                      contentStyle?: string;
                  }

                  Optional parameters.

                  +
                  • OptionalcontentCSS?: string[]

                    An array of CSS paths to load. getRoute will be applied to them.

                    +
                  • OptionalcontentStyle?: string

                    The same content style string for TinyMCE options.

                Returns object

                TinyMCE options

                -

          Settings

          Member Visibility

          Theme

          On This Page

          constructorconfigBasicconfigStandardconfigTJSoptionsSingleLine
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component_fvtt.TJSFileButton.html b/docs/classes/_standard_component_fvtt.TJSFileButton.html index d11cb7cd..6bc1f075 100644 --- a/docs/classes/_standard_component_fvtt.TJSFileButton.html +++ b/docs/classes/_standard_component_fvtt.TJSFileButton.html @@ -1,10 +1,21 @@ -TJSFileButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSFileButton

          Provides a pre-configured icon button interfacing w/ the Foundry file picker.

          +TJSFileButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSFileButton

          Provides a pre-configured icon button interfacing w/ the Foundry file picker.

          Please see FVTTFilePickerBrowseOptions for the pickerOptions prop. Please see TJSButton for the button component / CSS variable support.

          This component provides one way binding by default. You may explicitly bind to the filepath prop to create a two-way binding.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component_fvtt.TJSFileIconButton.html b/docs/classes/_standard_component_fvtt.TJSFileIconButton.html index b274ba63..db02407f 100644 --- a/docs/classes/_standard_component_fvtt.TJSFileIconButton.html +++ b/docs/classes/_standard_component_fvtt.TJSFileIconButton.html @@ -1,10 +1,21 @@ -TJSFileIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSFileIconButton

          Provides a pre-configured icon button interfacing w/ the Foundry file picker.

          +TJSFileIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSFileIconButton

          Provides a pre-configured icon button interfacing w/ the Foundry file picker.

          Please see FVTTFilePickerBrowseOptions for the pickerOptions prop. Please see TJSIconButton for the button component / CSS variable support.

          This component provides one way binding by default. You may explicitly bind to the filepath prop to create a two-way binding.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component_fvtt.TJSFileSlotButton.html b/docs/classes/_standard_component_fvtt.TJSFileSlotButton.html index 76485597..7fc056b7 100644 --- a/docs/classes/_standard_component_fvtt.TJSFileSlotButton.html +++ b/docs/classes/_standard_component_fvtt.TJSFileSlotButton.html @@ -1,11 +1,22 @@ -TJSFileSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSFileSlotButton

          Provides a pre-configured slotted button interfacing w/ the Foundry file picker. You may assign a child component +TJSFileSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSFileSlotButton

          Provides a pre-configured slotted button interfacing w/ the Foundry file picker. You may assign a child component that obtains the filepath store.

          Please see FVTTFilePickerBrowseOptions for the pickerOptions prop. Please see TJSSlotButton for the button component / CSS variable support.

          This component provides one way binding by default. You may explicitly bind to the filepath prop to create a two-way binding.

          -

          Hierarchy (view full)

          Constructors

          constructor +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_component_fvtt.TJSMediaContent.html b/docs/classes/_standard_component_fvtt.TJSMediaContent.html index c2fb2158..59312509 100644 --- a/docs/classes/_standard_component_fvtt.TJSMediaContent.html +++ b/docs/classes/_standard_component_fvtt.TJSMediaContent.html @@ -1,4 +1,5 @@ -TJSMediaContent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSMediaContent

          Provides an initial implementation to display image or video content from a given file path.

          +TJSMediaContent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSMediaContent

          Provides an initial implementation to display image or video content from a given file path.

          Note: currently this component is available in the standard/component/fvtt sub-path export and after it is revisited to add in more comprehensive support for URLs it will be moved to standard/component.

          You can either set the filepath prop or use TJSFileSlotButton and embed TJSMediaContent as a child. @@ -6,8 +7,19 @@

          The following CSS variables control the associated styles with the default values:

          --tjs-media-content-background - transparent
          --tjs-media-content-border - none
          --tjs-media-content-border-radius - 0
          --tjs-media-content-diameter - When defined used for height / width.
          --tjs-media-content-height - 100px
          --tjs-media-content-object-fit - contain
          --tjs-media-content-width - 100px
          -

          Hierarchy (view full)

          Constructors

          constructor + +
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_fvtt.FVTTVersion.html b/docs/classes/_standard_fvtt.FVTTVersion.html index 39bfee9b..8302e021 100644 --- a/docs/classes/_standard_fvtt.FVTTVersion.html +++ b/docs/classes/_standard_fvtt.FVTTVersion.html @@ -1,13 +1,14 @@ -FVTTVersion | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class FVTTVersion

          Provides a helper class to determine the version of the Foundry platform starting a version 9.

          +FVTTVersion | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class FVTTVersion

          Provides a helper class to determine the version of the Foundry platform starting a version 9.

          Note: You must use any of these utility methods after the Foundry init hook.

          -

          Constructors

          constructor +

          Constructors

          constructor

          Methods

          isAtLeast isBetween -

          Constructors

          constructor

          Methods

          Static isAtLeast

          • isAtLeast(version): boolean

          • Returns true when Foundry is at least the specific major version number provided.

            +

          Constructors

          constructor

          Methods

          StaticisAtLeast

          • isAtLeast(version): boolean

          • Returns true when Foundry is at least the specific major version number provided.

            Parameters

            • version: number

              Major version to check against.

            Returns boolean

            Foundry version is at least the major version specified.

            -

          Static isBetween

          • isBetween(min, max): boolean

          • Returns true when Foundry is between the min / max major version numbers provided.

            +

          StaticisBetween

          • isBetween(min, max): boolean

          • Returns true when Foundry is between the min / max major version numbers provided.

            Parameters

            • min: number

              Major minimum version to check against.

            • max: number

              Major maximum version to check against.

            Returns boolean

            Foundry version is at least the major version specified.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructorisAtLeastisBetween
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_fvtt.FontManager.html b/docs/classes/_standard_fvtt.FontManager.html index dd46f61c..9706d250 100644 --- a/docs/classes/_standard_fvtt.FontManager.html +++ b/docs/classes/_standard_fvtt.FontManager.html @@ -1,23 +1,24 @@ -FontManager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class FontManager

          Loads FVTT core fonts supporting FontConfig on Foundry v10+.

          +FontManager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class FontManager

          Loads FVTT core fonts supporting FontConfig on Foundry v10+.

          Note: This class contains code modified from Foundry VTT core client code. There are only so many ways to process core Foundry data structures correctly.

          -

          Constructors

          constructor +

          Constructors

          constructor

          Methods

          getCoreDefinitions loadFonts removeDuplicateDefinitions -

          Constructors

          constructor

          Methods

          Static getCoreDefinitions

          Constructors

          constructor

          Methods

          StaticgetCoreDefinitions

          Static loadFonts

          • loadFonts(opts?): Promise<void>

          • Ensure that fonts have loaded and are ready for use. +

          StaticloadFonts

          • loadFonts(opts?): Promise<void>

          • Ensure that fonts have loaded and are ready for use. Enforce a maximum timeout in milliseconds. Proceed after that point even if fonts are not yet available.

            -

            Parameters

            • Optional opts: {
                  document?: Document;
                  editor?: boolean;
                  fonts?: {
                      [key: string]: globalThis.FontFamilyDefinition;
                  } | {
                      [key: string]: globalThis.FontFamilyDefinition;
                  }[];
                  ms?: number;
              }

              Optional parameters.

              -
              • Optional document?: Document

                The target document to load the fonts into.

                -
              • Optional editor?: boolean

                When true verifies the editor field of FontFamilyDefinition.

                -
              • Optional fonts?: {
                    [key: string]: globalThis.FontFamilyDefinition;
                } | {
                    [key: string]: globalThis.FontFamilyDefinition;
                }[]

                A custom set of font family definitions to load. If not defined the core font family definitions - are loaded.

                -
              • Optional ms?: number

                The maximum time to spend loading fonts before proceeding.

                -

            Returns Promise<void>

          Static removeDuplicateDefinitions

          • removeDuplicateDefinitions(fonts): {
                [key: string]: globalThis.FontFamilyDefinition;
            }[]

          • Removes duplicate font definitions.

            +

            Parameters

            • Optionalopts: {
                  document?: Document;
                  editor?: boolean;
                  fonts?: {
                      [key: string]: globalThis.FontFamilyDefinition;
                  } | {
                      [key: string]: globalThis.FontFamilyDefinition;
                  }[];
                  ms?: number;
              }

              Optional parameters.

              +
              • Optionaldocument?: Document

                The target document to load the fonts into.

                +
              • Optionaleditor?: boolean

                When true verifies the editor field of FontFamilyDefinition.

                +
              • Optionalfonts?: {
                    [key: string]: globalThis.FontFamilyDefinition;
                } | {
                    [key: string]: globalThis.FontFamilyDefinition;
                }[]

                A custom set of font family definitions to load. If not defined the core font family definitions +are loaded.

                +
              • Optionalms?: number

                The maximum time to spend loading fonts before proceeding.

                +

            Returns Promise<void>

          StaticremoveDuplicateDefinitions

          Settings

          Member Visibility

          Theme

          On This Page

          constructorgetCoreDefinitionsloadFontsremoveDuplicateDefinitions
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_fvtt.FoundryStyles.html b/docs/classes/_standard_fvtt.FoundryStyles.html index 4054e099..32bf60fa 100644 --- a/docs/classes/_standard_fvtt.FoundryStyles.html +++ b/docs/classes/_standard_fvtt.FoundryStyles.html @@ -1,14 +1,15 @@ -FoundryStyles | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class FoundryStyles

          Parses the core Foundry style sheet creating an indexed object of properties by selector.

          -

          Constructors

          constructor +FoundryStyles | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class FoundryStyles

          Parses the core Foundry style sheet creating an indexed object of properties by selector.

          +

          Constructors

          constructor

          Methods

          getProperties getProperty -

          Constructors

          constructor

          Methods

          Static getProperties

          • getProperties(selector): {
                [key: string]: string;
            }

          • Gets the properties object associated with the selector. Try and use a direct match otherwise all keys +

          Constructors

          constructor

          Methods

          StaticgetProperties

          • getProperties(selector): {
                [key: string]: string;
            }

          • Gets the properties object associated with the selector. Try and use a direct match otherwise all keys are iterated to find a selector string that includes the selector.

            Parameters

            • selector: string

              Selector to find.

            Returns {
                [key: string]: string;
            }

            Properties object.

            -
            • [key: string]: string

          Static getProperty

          • getProperty(selector, property): string

          • Gets a specific property value from the given selector and property key. Try and use a direct selector +

            • [key: string]: string

          StaticgetProperty

          • getProperty(selector, property): string

          • Gets a specific property value from the given selector and property key. Try and use a direct selector match otherwise all keys are iterated to find a selector string that includes selector.

            Parameters

            • selector: string

              Selector to find.

            • property: string

              Specific property to locate.

            Returns string

            Property value.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructorgetPropertiesgetProperty
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_prosemirror.PMImpl.html b/docs/classes/_standard_prosemirror.PMImpl.html index ecd50704..e5b00eed 100644 --- a/docs/classes/_standard_prosemirror.PMImpl.html +++ b/docs/classes/_standard_prosemirror.PMImpl.html @@ -1,8 +1,9 @@ -PMImpl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class PMImpl

          Provides helper utilities to manipulate the PM editor view for various options from TJSProseMirror component.

          -

          Constructors

          constructor +PMImpl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class PMImpl

          Provides helper utilities to manipulate the PM editor view for various options from TJSProseMirror component.

          +

          Constructors

          constructor

          Methods

          setInitialSelection -

          Constructors

          constructor

          Methods

          Static setInitialSelection

          • setInitialSelection(view, options): void

          • Handles options.initialSelection: Sets the initial cursor / selection range to the start, end, or selects +

          Constructors

          constructor

          Methods

          StaticsetInitialSelection

          • setInitialSelection(view, options): void

          • Handles options.initialSelection: Sets the initial cursor / selection range to the start, end, or selects all text.

            Parameters

            • view: object

              PM editor view.

            • options: object

              TJSProseMirror options.

              -

            Returns void

          Settings

          Member Visibility

          Theme

          On This Page

          constructorsetInitialSelection
          \ No newline at end of file +

          Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_prosemirror_plugins.TJSKeyMaps.html b/docs/classes/_standard_prosemirror_plugins.TJSKeyMaps.html index 0b6913c1..1d5cc6f7 100644 --- a/docs/classes/_standard_prosemirror_plugins.TJSKeyMaps.html +++ b/docs/classes/_standard_prosemirror_plugins.TJSKeyMaps.html @@ -1,10 +1,21 @@ -TJSKeyMaps | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSKeyMaps

          Provides an additional key mapping to Escape to destroy / cancel the active editor.

          -

          Hierarchy

          • TJSKeyMaps_base
            • TJSKeyMaps

          Indexable

          [x: string]: any

          Constructors

          constructor +TJSKeyMaps | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class TJSKeyMaps

          Provides an additional key mapping to Escape to destroy / cancel the active editor.

          +
          +
          + +
          + + Hierarchy
          +           +
          +
          • TJSKeyMaps_base
            • TJSKeyMaps ()
          +
          +

          Indexable

          • [x: string]: any

          Constructors

          constructor

          Methods

          buildMapping -

          Constructors

          constructor

          • new TJSKeyMaps(schema, options?): TJSKeyMaps

          • Parameters

            • schema: object

              The ProseMirror schema to build keymaps for.

              -
            • Optional options: {
                  onQuit?: Function;
                  onSave?: Function;
              }

              Additional options to configure the plugin's behaviour.

              -
              • Optional onQuit?: Function

                A function to call when Ctrl+Q is pressed.

                -
              • Optional onSave?: Function

                A function to call when Ctrl+S is pressed.

                -

            Returns TJSKeyMaps

          Methods

          buildMapping

          • buildMapping(): {
                [key: string]: globalThis.ProseMirrorCommand;
            }

          • Swaps the Foundry default Escape / selectParentNode to Mod-p and enables onQuit function for Escape.

            +

          Constructors

          constructor

          • new TJSKeyMaps(schema, options?): TJSKeyMaps

          • Parameters

            • schema: object

              The ProseMirror schema to build keymaps for.

              +
            • Optionaloptions: {
                  onQuit?: Function;
                  onSave?: Function;
              }

              Additional options to configure the plugin's behaviour.

              +
              • OptionalonQuit?: Function

                A function to call when Ctrl+Q is pressed.

                +
              • OptionalonSave?: Function

                A function to call when Ctrl+S is pressed.

                +

            Returns TJSKeyMaps

          Methods

          buildMapping

          • buildMapping(): {
                [key: string]: globalThis.ProseMirrorCommand;
            }

          • Swaps the Foundry default Escape / selectParentNode to Mod-p and enables onQuit function for Escape.

            Returns {
                [key: string]: globalThis.ProseMirrorCommand;
            }

            ProseMirror keymap data.

            -
            • [key: string]: globalThis.ProseMirrorCommand

          Settings

          Member Visibility

          Theme

          On This Page

          constructorbuildMapping
          \ No newline at end of file +
          • [key: string]: globalThis.ProseMirrorCommand

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_prosemirror_plugins.TJSPasteUUID.html b/docs/classes/_standard_prosemirror_plugins.TJSPasteUUID.html index 06061535..228930ba 100644 --- a/docs/classes/_standard_prosemirror_plugins.TJSPasteUUID.html +++ b/docs/classes/_standard_prosemirror_plugins.TJSPasteUUID.html @@ -1,6 +1,7 @@ -TJSPasteUUID | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSPasteUUID

          A ProseMirror plugin to transform pasted text that is a raw document UUID into a document link suitable for +TJSPasteUUID | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSPasteUUID

          A ProseMirror plugin to transform pasted text that is a raw document UUID into a document link suitable for TextEditor.enrichHTML.

          -

          Constructors

          constructor +

          Constructors

          constructor

          Methods

          build -

          Constructors

          constructor

          Methods

          Static build

          • build(): any

          • Returns any

            PM Plugin.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructorbuild
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          Staticbuild

          • build(): any

          • Returns any

            PM Plugin.

            +

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_store.TJSThemeStore.html b/docs/classes/_standard_store.TJSThemeStore.html index 9d46dab9..30813dce 100644 --- a/docs/classes/_standard_store.TJSThemeStore.html +++ b/docs/classes/_standard_store.TJSThemeStore.html @@ -1,14 +1,15 @@ -TJSThemeStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class TJSThemeStore

          Must be constructed from a TJSGameSettings instance init / initialize method called from the ready Foundry VTT +TJSThemeStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Class TJSThemeStore

          Must be constructed from a TJSGameSettings instance init / initialize method called from the ready Foundry VTT hook.

          -

          Constructors

          constructor +

          Constructors

          constructor

          Accessors

          stores

          Methods

          set subscribe -

          Constructors

          constructor

          Accessors

          stores

          • get stores(): {
                [key: string]: Writable<string>;
            }

          • Returns {
                [key: string]: Writable<string>;
            }

            All stores.

            -

          Methods

          set

          • set(themeData): TJSThemeStore

          • Sets the theme store with new data.

            +

          Constructors

          constructor

          Accessors

          stores

          • get stores(): {
                [key: string]: Writable<string>;
            }

          • Returns {
                [key: string]: Writable<string>;
            }

            All stores.

            +

          Methods

          set

          • set(themeData): TJSThemeStore

          • Sets the theme store with new data.

            Parameters

            • themeData: object

            Returns TJSThemeStore

            This theme store instance.

          subscribe

          • subscribe(handler): Unsubscriber

          • Parameters

            • handler: Subscriber<Record<string, object>>

              Callback function that is invoked on update / changes. Receives copy of the theme data.

            Returns Unsubscriber

            Unsubscribe function.

            -

          Settings

          Member Visibility

          Theme

          On This Page

          constructorstoressetsubscribe
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/_standard_store.WorldSettingArrayStore.html b/docs/classes/_standard_store.WorldSettingArrayStore.html index 9d05f7bd..1fdcebe0 100644 --- a/docs/classes/_standard_store.WorldSettingArrayStore.html +++ b/docs/classes/_standard_store.WorldSettingArrayStore.html @@ -1,4 +1,15 @@ -WorldSettingArrayStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class WorldSettingArrayStore<T>

          Type Parameters

          Hierarchy (view full)

          Constructors

          constructor +WorldSettingArrayStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class WorldSettingArrayStore<T>

          Type Parameters

          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Accessors

          _data dataReducer key @@ -16,23 +27,23 @@ subscribe toJSON updateSubscribers -

          Constructors

          constructor

          Accessors

          Protected _data

          • get _data(): T[]
          • Protected

            Returns T[]

            The internal data array tracked allowing child classes direct access.

            +

          Constructors

          constructor

          Accessors

          Protected_data

          • get _data(): T[]
          • Protected

            Returns T[]

            The internal data array tracked allowing child classes direct access.

          dataReducer

          key

          • get key(): string

          • Returns string

            The Foundry game setting key.

          length

          • get length(): number

          • Returns number

            The length of all data.

          namespace

          • get namespace(): string

          • Returns string

            The Foundry game setting namespace.

            -

          Static EntryStore

          Methods

          [iterator]

          clearEntries

          • clearEntries(): void

          • Removes all child store entries.

            +

          StaticEntryStore

          Methods

          [iterator]

          clearEntries

          createEntry

          • createEntry(entryData?): T

          • Creates a new store from given data.

            -

            Parameters

            • Optional entryData: object

            Returns T

            The store

            +

          Parameters

          • OptionalentryData: object

          Returns T

          The store

          deleteEntry

          • deleteEntry(id): boolean

          • Deletes a given entry store by ID from this world setting array store instance.

            Parameters

            • id: string

              ID of entry to delete.

            Returns boolean

            Delete operation successful.

            @@ -40,7 +51,7 @@

          Parameters

          • id: string

            UUIDv4 string.

          Returns any

          Instance of StoreClass.

          findEntry

          • findEntry(predicate): void | T

          • Find an entry in the backing child store array.

            -

            Parameters

            • predicate: ((arg0) => void | T)

              A predicate function

              +

              Parameters

              • predicate: ((arg0: T) => void | T)

                A predicate function

                  • (arg0): void | T

                  • Parameters

                    • arg0: T

                    Returns void | T

              Returns void | T

              Found entry in array or undefined.

          getEntry

          • getEntry(id): void | T

          • Finds an entry store instance by 'id' / UUIDv4.

            Parameters

            • id: string

              A UUIDv4 string.

              @@ -50,4 +61,4 @@

              Parameters

              • updateList: T[]

              Returns void

          subscribe

          toJSON

          updateSubscribers

          Settings

          Member Visibility

          Theme

          On This Page

          constructor_datadataReducerkeylengthnamespaceEntryStore[iterator]clearEntriescreateEntrydeleteEntryduplicateEntryfindEntrygetEntrysetsubscribetoJSONupdateSubscribers
          \ No newline at end of file +

          Parameters

          Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Accessors
          Methods
          \ No newline at end of file diff --git a/docs/classes/svelte.SvelteComponent.html b/docs/classes/svelte.SvelteComponent.html index 0423f496..a70554da 100644 --- a/docs/classes/svelte.SvelteComponent.html +++ b/docs/classes/svelte.SvelteComponent.html @@ -1,17 +1,31 @@ -SvelteComponent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class SvelteComponent<Props, Events, Slots>

          Base class for Svelte components with some minor dev-enhancements. Used when dev=true.

          +SvelteComponent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class SvelteComponent<Props, Events, Slots>

          Base class for Svelte components with some minor dev-enhancements. Used when dev=true.

          Can be used to create strongly typed Svelte components.

          -

          Example:

          You have component library on npm called component-library, from which +

          Example:

          You have component library on npm called component-library, from which you export a component called MyComponent. For Svelte+TypeScript users, you want to provide typings. Therefore you create a index.d.ts:

          -
          import { SvelteComponent } from "svelte";
          export class MyComponent extends SvelteComponent<{foo: string}> {}
-
          +
          import { SvelteComponent } from "svelte";
          export class MyComponent extends SvelteComponent<{foo: string}> {}
+
          +

          Typing this makes it possible for IDEs like VS Code with the Svelte extension to provide intellisense and to use the component like this in a Svelte file with TypeScript:

          -
          <script lang="ts">
              import { MyComponent } from "component-library";
          </script>
          <MyComponent foo={'bar'} />
-
          -

          Type Parameters

          • Props extends Record<string, any> = any
          • Events extends Record<string, any> = any
          • Slots extends Record<string, any> = any

          Hierarchy (view full)

          Indexable

          [prop: string]: any

          Constructors

          constructor +
          
+
+
          + +

          Type Parameters

          • Props extends Record<string, any> = any
          • Events extends Record<string, any> = any
          • Slots extends Record<string, any> = any
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Indexable

          • [prop: string]: any

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)
                • (e): void

                • Parameters

                  Returns void

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e: Events[K]) => void)
                • (e): void

                • Parameters

                  Returns void

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          Example:
          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/svelte.SvelteComponentTyped.html b/docs/classes/svelte.SvelteComponentTyped.html index 72531786..514f7371 100644 --- a/docs/classes/svelte.SvelteComponentTyped.html +++ b/docs/classes/svelte.SvelteComponentTyped.html @@ -1,6 +1,17 @@ -SvelteComponentTyped | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class SvelteComponentTyped<Props, Events, Slots>

          Deprecated

          Use SvelteComponent instead. See PR for more information: https://github.com/sveltejs/svelte/pull/8512

          -

          Type Parameters

          • Props extends Record<string, any> = any
          • Events extends Record<string, any> = any
          • Slots extends Record<string, any> = any

          Hierarchy (view full)

          Constructors

          constructor +SvelteComponentTyped | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class SvelteComponentTyped<Props, Events, Slots>

          Deprecated

          Use SvelteComponent instead. See PR for more information: https://github.com/sveltejs/svelte/pull/8512

          +

          Type Parameters

          • Props extends Record<string, any> = any
          • Events extends Record<string, any> = any
          • Slots extends Record<string, any> = any
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)
                • (e): void

                • Parameters

                  Returns void

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e: Events[K]) => void)
                • (e): void

                • Parameters

                  Returns void

            Returns (() => void)

              • (): void

              • Returns void

          $set

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/classes/svelte.SvelteComponent_1.html b/docs/classes/svelte.SvelteComponent_1.html index f9ac7604..26a97c10 100644 --- a/docs/classes/svelte.SvelteComponent_1.html +++ b/docs/classes/svelte.SvelteComponent_1.html @@ -1,6 +1,17 @@ -SvelteComponent_1 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class SvelteComponent_1<Props, Events>

          Base class for Svelte components. Used when dev=false.

          -

          Type Parameters

          • Props extends Record<string, any> = any
          • Events extends Record<string, any> = any

          Hierarchy (view full)

          Constructors

          constructor +SvelteComponent_1 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Class SvelteComponent_1<Props, Events>

          Base class for Svelte components. Used when dev=false.

          +

          Type Parameters

          • Props extends Record<string, any> = any
          • Events extends Record<string, any> = any
          +
          + +
          + + Hierarchy
          +           +
          +
          +
          +

          Constructors

          constructor

          Methods

          $destroy $on $set -

          Constructors

          constructor

          Methods

          $destroy

          • $destroy(): void

          • Returns void

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e) => void)
                • (e): void

                • Parameters

                  Returns void

            Returns (() => void)

              • (): void

              • Returns void

          $set

          • $set(props): void

          • Parameters

            Returns void

          Settings

          Member Visibility

          Theme

          On This Page

          constructor$destroy$on$set
          \ No newline at end of file +

          Constructors

          constructor

          Methods

          $destroy

          • $destroy(): void

          • Returns void

          $on

          • $on<K>(type, callback): (() => void)

          • Type Parameters

            • K extends string

            Parameters

            • type: K
            • callback: ((e: Events[K]) => void)
                • (e): void

                • Parameters

                  Returns void

            Returns (() => void)

              • (): void

              • Returns void

          $set

          • $set(props): void

          • Parameters

            Returns void

          Settings

          Member Visibility

          On This Page

          Constructors
          Methods
          \ No newline at end of file diff --git a/docs/enums/_runtime_data_format_msgpack.FLOAT32_OPTIONS.html b/docs/enums/_runtime_data_format_msgpack.FLOAT32_OPTIONS.html index b626dc21..bc84db75 100644 --- a/docs/enums/_runtime_data_format_msgpack.FLOAT32_OPTIONS.html +++ b/docs/enums/_runtime_data_format_msgpack.FLOAT32_OPTIONS.html @@ -1,5 +1,6 @@ -FLOAT32_OPTIONS | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Enumeration FLOAT32_OPTIONS

          Enumeration Members

          ALWAYS +FLOAT32_OPTIONS | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Enumeration FLOAT32_OPTIONS

          Enumeration Members

          ALWAYS DECIMAL_FIT DECIMAL_ROUND NEVER -

          Enumeration Members

          ALWAYS

          ALWAYS: 1

          DECIMAL_FIT

          DECIMAL_FIT: 4

          DECIMAL_ROUND

          DECIMAL_ROUND: 3

          NEVER

          NEVER: 0

          Settings

          Member Visibility

          Theme

          On This Page

          ALWAYSDECIMAL_FITDECIMAL_ROUNDNEVER
          \ No newline at end of file +

          Enumeration Members

          ALWAYS

          ALWAYS: 1

          DECIMAL_FIT

          DECIMAL_FIT: 4

          DECIMAL_ROUND

          DECIMAL_ROUND: 3

          NEVER

          NEVER: 0

          Settings

          Member Visibility

          On This Page

          Enumeration Members
          \ No newline at end of file diff --git a/docs/functions/_runtime_color_colord.colord-1.html b/docs/functions/_runtime_color_colord.colord-1.html index 965de7d9..bd5d0e47 100644 --- a/docs/functions/_runtime_color_colord.colord-1.html +++ b/docs/functions/_runtime_color_colord.colord-1.html @@ -1,3 +1,4 @@ -colord | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function colord

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +colord | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function colord

          Parses the given input color and creates a new Colord instance. +See accepted input formats: https://github.com/omgovich/colord#color-parsing

          +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_color_colord.extend.html b/docs/functions/_runtime_color_colord.extend.html index 210e4d65..e48166a6 100644 --- a/docs/functions/_runtime_color_colord.extend.html +++ b/docs/functions/_runtime_color_colord.extend.html @@ -1 +1,2 @@ -extend | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function extend

          • extend(plugins): void

          • Parameters

            Returns void

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +extend | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function extend

          • extend(plugins): void

          • Parameters

            Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_color_colord.getFormat.html b/docs/functions/_runtime_color_colord.getFormat.html index 9019fb57..b332bfed 100644 --- a/docs/functions/_runtime_color_colord.getFormat.html +++ b/docs/functions/_runtime_color_colord.getFormat.html @@ -1,2 +1,3 @@ -getFormat | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function getFormat

          • getFormat(input): Format

          • Returns a color model name for the input passed to the function.

            -

            Parameters

            • input: Input

            Returns Format

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +getFormat | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function getFormat

          Returns a color model name for the input passed to the function.

          +
          • getFormat(input): Format

          • Parameters

            • input: Input

            Returns Format

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_color_colord.random.html b/docs/functions/_runtime_color_colord.random.html index edc9b9ae..2c6ec5d2 100644 --- a/docs/functions/_runtime_color_colord.random.html +++ b/docs/functions/_runtime_color_colord.random.html @@ -1 +1,2 @@ -random | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function random

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +random | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function random

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.compress-1.html b/docs/functions/_runtime_data_compress.compress-1.html index fcc5e113..2d4251eb 100644 --- a/docs/functions/_runtime_data_compress.compress-1.html +++ b/docs/functions/_runtime_data_compress.compress-1.html @@ -1,4 +1,5 @@ -compress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function compress

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.compressSync.html b/docs/functions/_runtime_data_compress.compressSync.html index 35905540..ff01adb2 100644 --- a/docs/functions/_runtime_data_compress.compressSync.html +++ b/docs/functions/_runtime_data_compress.compressSync.html @@ -1,5 +1,6 @@ -compressSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function compressSync

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.decompress-1.html b/docs/functions/_runtime_data_compress.decompress-1.html index 26979361..c96e5168 100644 --- a/docs/functions/_runtime_data_compress.decompress-1.html +++ b/docs/functions/_runtime_data_compress.decompress-1.html @@ -1,4 +1,5 @@ -decompress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function decompress

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.decompressSync.html b/docs/functions/_runtime_data_compress.decompressSync.html index 70e6dc70..0c495ee0 100644 --- a/docs/functions/_runtime_data_compress.decompressSync.html +++ b/docs/functions/_runtime_data_compress.decompressSync.html @@ -1,5 +1,6 @@ -decompressSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function decompressSync

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.deflate-1.html b/docs/functions/_runtime_data_compress.deflate-1.html index 60e59a4a..48901cd5 100644 --- a/docs/functions/_runtime_data_compress.deflate-1.html +++ b/docs/functions/_runtime_data_compress.deflate-1.html @@ -1,4 +1,5 @@ -deflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function deflate

          Returns AsyncTerminable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.deflateSync.html b/docs/functions/_runtime_data_compress.deflateSync.html index a3347972..a3e9ff4e 100644 --- a/docs/functions/_runtime_data_compress.deflateSync.html +++ b/docs/functions/_runtime_data_compress.deflateSync.html @@ -1,5 +1,6 @@ -deflateSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function deflateSync

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.gunzip-1.html b/docs/functions/_runtime_data_compress.gunzip-1.html index b532ad1c..ae252ac8 100644 --- a/docs/functions/_runtime_data_compress.gunzip-1.html +++ b/docs/functions/_runtime_data_compress.gunzip-1.html @@ -1,4 +1,5 @@ -gunzip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function gunzip

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.gunzipSync.html b/docs/functions/_runtime_data_compress.gunzipSync.html index dce9a403..f90b68ff 100644 --- a/docs/functions/_runtime_data_compress.gunzipSync.html +++ b/docs/functions/_runtime_data_compress.gunzipSync.html @@ -1,5 +1,6 @@ -gunzipSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function gunzipSync

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.inflate-1.html b/docs/functions/_runtime_data_compress.inflate-1.html index dac739ff..17ae4978 100644 --- a/docs/functions/_runtime_data_compress.inflate-1.html +++ b/docs/functions/_runtime_data_compress.inflate-1.html @@ -1,4 +1,5 @@ -inflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function inflate

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.inflateSync.html b/docs/functions/_runtime_data_compress.inflateSync.html index ed4f1c8a..5610b50f 100644 --- a/docs/functions/_runtime_data_compress.inflateSync.html +++ b/docs/functions/_runtime_data_compress.inflateSync.html @@ -1,5 +1,6 @@ -inflateSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function inflateSync

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.strFromU8.html b/docs/functions/_runtime_data_compress.strFromU8.html index 8391fbfb..6dd01cee 100644 --- a/docs/functions/_runtime_data_compress.strFromU8.html +++ b/docs/functions/_runtime_data_compress.strFromU8.html @@ -1,6 +1,7 @@ -strFromU8 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function strFromU8

          • strFromU8(dat, latin1?): string

          • Converts a Uint8Array to a string

            +strFromU8 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function strFromU8

            • strFromU8(dat, latin1?): string

            • Converts a Uint8Array to a string

              Parameters

              • dat: Uint8Array

                The data to decode to string

                -
              • Optional latin1: boolean

                Whether or not to interpret the data as Latin-1. This should - not need to be true unless encoding to binary string.

                +
              • Optionallatin1: boolean

                Whether or not to interpret the data as Latin-1. This should +not need to be true unless encoding to binary string.

              Returns string

              The original UTF-8/Latin-1 string

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.strToU8.html b/docs/functions/_runtime_data_compress.strToU8.html index 37fdd6e9..f467ef3f 100644 --- a/docs/functions/_runtime_data_compress.strToU8.html +++ b/docs/functions/_runtime_data_compress.strToU8.html @@ -1,6 +1,7 @@ -strToU8 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function strToU8

          • strToU8(str, latin1?): Uint8Array

          • Converts a string into a Uint8Array for use with compression/decompression methods

            +strToU8 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function strToU8

            • strToU8(str, latin1?): Uint8Array

            • Converts a string into a Uint8Array for use with compression/decompression methods

              Parameters

              • str: string

                The string to encode

                -
              • Optional latin1: boolean

                Whether or not to interpret the data as Latin-1. This should - not need to be true unless decoding a binary string.

                +
              • Optionallatin1: boolean

                Whether or not to interpret the data as Latin-1. This should +not need to be true unless decoding a binary string.

              Returns Uint8Array

              The string encoded in UTF-8/Latin-1 binary

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.unzip-1.html b/docs/functions/_runtime_data_compress.unzip-1.html index b19bd90c..410aeda8 100644 --- a/docs/functions/_runtime_data_compress.unzip-1.html +++ b/docs/functions/_runtime_data_compress.unzip-1.html @@ -1,4 +1,5 @@ -unzip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function unzip

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.unzipSync.html b/docs/functions/_runtime_data_compress.unzipSync.html index a75fce21..340372c7 100644 --- a/docs/functions/_runtime_data_compress.unzipSync.html +++ b/docs/functions/_runtime_data_compress.unzipSync.html @@ -1,6 +1,7 @@ -unzipSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function unzipSync

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.unzlib-1.html b/docs/functions/_runtime_data_compress.unzlib-1.html index 15c10fb3..e85bc7c1 100644 --- a/docs/functions/_runtime_data_compress.unzlib-1.html +++ b/docs/functions/_runtime_data_compress.unzlib-1.html @@ -1,4 +1,5 @@ -unzlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function unzlib

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.unzlibSync.html b/docs/functions/_runtime_data_compress.unzlibSync.html index ae4db300..ffb14ab3 100644 --- a/docs/functions/_runtime_data_compress.unzlibSync.html +++ b/docs/functions/_runtime_data_compress.unzlibSync.html @@ -1,5 +1,6 @@ -unzlibSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function unzlibSync

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.zip-1.html b/docs/functions/_runtime_data_compress.zip-1.html index 372ccece..2bc4993c 100644 --- a/docs/functions/_runtime_data_compress.zip-1.html +++ b/docs/functions/_runtime_data_compress.zip-1.html @@ -1,4 +1,5 @@ -zip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function zip

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.zipSync.html b/docs/functions/_runtime_data_compress.zipSync.html index 22defa9e..65ed9c62 100644 --- a/docs/functions/_runtime_data_compress.zipSync.html +++ b/docs/functions/_runtime_data_compress.zipSync.html @@ -1,6 +1,7 @@ -zipSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function zipSync

          • zipSync(data, opts?): Uint8Array

          • Synchronously creates a ZIP file. Prefer using zip for better performance +zipSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function zipSync

            • zipSync(data, opts?): Uint8Array

            • Synchronously creates a ZIP file. Prefer using zip for better performance with more than one file.

              Parameters

              • data: Zippable

                The directory structure for the ZIP archive

                -
              • Optional opts: ZipOptions

                The main options, merged with per-file options

                +
              • Optionalopts: ZipOptions

                The main options, merged with per-file options

              Returns Uint8Array

              The generated ZIP archive

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.zlib-1.html b/docs/functions/_runtime_data_compress.zlib-1.html index 4b836d1f..028f5860 100644 --- a/docs/functions/_runtime_data_compress.zlib-1.html +++ b/docs/functions/_runtime_data_compress.zlib-1.html @@ -1,4 +1,5 @@ -zlib | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function zlib

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_compress.zlibSync.html b/docs/functions/_runtime_data_compress.zlibSync.html index cbb74362..db03f38e 100644 --- a/docs/functions/_runtime_data_compress.zlibSync.html +++ b/docs/functions/_runtime_data_compress.zlibSync.html @@ -1,5 +1,6 @@ -zlibSync | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function zlibSync

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.atob.html b/docs/functions/_runtime_data_format_base64.atob.html index d7f6c785..ab016ebc 100644 --- a/docs/functions/_runtime_data_format_base64.atob.html +++ b/docs/functions/_runtime_data_format_base64.atob.html @@ -1,4 +1,5 @@ -atob | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function atob

          • atob(asc): string

          • does what window.atob of web browsers do.

            -

            Parameters

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.atobPolyfill.html b/docs/functions/_runtime_data_format_base64.atobPolyfill.html index b5e51905..e9f67c03 100644 --- a/docs/functions/_runtime_data_format_base64.atobPolyfill.html +++ b/docs/functions/_runtime_data_format_base64.atobPolyfill.html @@ -1,2 +1,3 @@ -atobPolyfill | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function atobPolyfill

          • atobPolyfill(asc): string

          • polyfill version of atob

            -

            Parameters

            • asc: string

            Returns string

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +atobPolyfill | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function atobPolyfill

          polyfill version of atob

          +
          • atobPolyfill(asc): string

          • Parameters

            • asc: string

            Returns string

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.btoa.html b/docs/functions/_runtime_data_format_base64.btoa.html index 7cf6b651..3a0b98b6 100644 --- a/docs/functions/_runtime_data_format_base64.btoa.html +++ b/docs/functions/_runtime_data_format_base64.btoa.html @@ -1,4 +1,5 @@ -btoa | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function btoa

          • btoa(bin): string

          • does what window.btoa of web browsers do.

            -

            Parameters

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.btoaPolyfill.html b/docs/functions/_runtime_data_format_base64.btoaPolyfill.html index d6119321..407e7e53 100644 --- a/docs/functions/_runtime_data_format_base64.btoaPolyfill.html +++ b/docs/functions/_runtime_data_format_base64.btoaPolyfill.html @@ -1,2 +1,3 @@ -btoaPolyfill | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function btoaPolyfill

          • btoaPolyfill(bin): string

          • polyfill version of btoa

            -

            Parameters

            • bin: string

            Returns string

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +btoaPolyfill | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function btoaPolyfill

          polyfill version of btoa

          +
          • btoaPolyfill(bin): string

          • Parameters

            • bin: string

            Returns string

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.btou.html b/docs/functions/_runtime_data_format_base64.btou.html index ebd2e1ac..b4bd2f75 100644 --- a/docs/functions/_runtime_data_format_base64.btou.html +++ b/docs/functions/_runtime_data_format_base64.btou.html @@ -1,3 +1,4 @@ -btou | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function btou

          • btou(b): string

          • Parameters

            • b: string

            Returns string

            UTF-8 string

            -

            Deprecated

            should have been internal use only.

            -

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +btou | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function btou

          Deprecated

          should have been internal use only.

          +
          • btou(b): string

          • Parameters

            • b: string

            Returns string

            UTF-8 string

            +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.decode.html b/docs/functions/_runtime_data_format_base64.decode.html index 0717f666..cc6c7eb1 100644 --- a/docs/functions/_runtime_data_format_base64.decode.html +++ b/docs/functions/_runtime_data_format_base64.decode.html @@ -1,4 +1,5 @@ -decode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function decode

          • decode(src): string

          • converts a Base64 string to a UTF-8 string.

            -

            Parameters

            • src: string

              Base64 string. Both normal and URL-safe are supported

              +decode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
              +

              Function decode

              converts a Base64 string to a UTF-8 string.

              +
              • decode(src): string

              • Parameters

                • src: string

                  Base64 string. Both normal and URL-safe are supported

                Returns string

                UTF-8 string

                -

              Settings

              Member Visibility

              Theme

              \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.encode.html b/docs/functions/_runtime_data_format_base64.encode.html index 15d3b662..a947ce5c 100644 --- a/docs/functions/_runtime_data_format_base64.encode.html +++ b/docs/functions/_runtime_data_format_base64.encode.html @@ -1,4 +1,5 @@ -encode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function encode

          • encode(src, urlsafe?): string

          • converts a UTF-8-encoded string to a Base64 string.

            -

            Parameters

            • src: string
            • Optional urlsafe: boolean

              if true make the result URL-safe

              +encode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
              +

              Function encode

              converts a UTF-8-encoded string to a Base64 string.

              +
              • encode(src, urlsafe?): string

              • Parameters

                • src: string
                • Optionalurlsafe: boolean

                  if true make the result URL-safe

                Returns string

                Base64 string

                -

              Settings

              Member Visibility

              Theme

              \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.encodeURI.html b/docs/functions/_runtime_data_format_base64.encodeURI.html index 724dec5b..5c64f825 100644 --- a/docs/functions/_runtime_data_format_base64.encodeURI.html +++ b/docs/functions/_runtime_data_format_base64.encodeURI.html @@ -1,3 +1,4 @@ -encodeURI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function encodeURI

          • encodeURI(src): string

          • converts a UTF-8-encoded string to URL-safe Base64 RFC4648 §5.

            -

            Parameters

            • src: string

            Returns string

            Base64 string

            -

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +encodeURI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function encodeURI

          converts a UTF-8-encoded string to URL-safe Base64 RFC4648 §5.

          +
          • encodeURI(src): string

          • Parameters

            • src: string

            Returns string

            Base64 string

            +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.extendBuiltins.html b/docs/functions/_runtime_data_format_base64.extendBuiltins.html index c97ad365..3a1339fe 100644 --- a/docs/functions/_runtime_data_format_base64.extendBuiltins.html +++ b/docs/functions/_runtime_data_format_base64.extendBuiltins.html @@ -1,2 +1,3 @@ -extendBuiltins | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function extendBuiltins

          • extendBuiltins(): void

          • extend Builtin prototypes with relevant methods

            -

            Returns void

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +extendBuiltins | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function extendBuiltins

          extend Builtin prototypes with relevant methods

          +
          • extendBuiltins(): void

          • Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.extendString.html b/docs/functions/_runtime_data_format_base64.extendString.html index 6ec88cde..b1c17be4 100644 --- a/docs/functions/_runtime_data_format_base64.extendString.html +++ b/docs/functions/_runtime_data_format_base64.extendString.html @@ -1,2 +1,3 @@ -extendString | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function extendString

          • extendString(): void

          • extend String.prototype with relevant methods

            -

            Returns void

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +extendString | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function extendString

          extend String.prototype with relevant methods

          +
          • extendString(): void

          • Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.extendUint8Array.html b/docs/functions/_runtime_data_format_base64.extendUint8Array.html index 7d74fb70..a65a6f3e 100644 --- a/docs/functions/_runtime_data_format_base64.extendUint8Array.html +++ b/docs/functions/_runtime_data_format_base64.extendUint8Array.html @@ -1,2 +1,3 @@ -extendUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function extendUint8Array

          • extendUint8Array(): void

          • extend Uint8Array.prototype with relevant methods

            -

            Returns void

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +extendUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function extendUint8Array

          extend Uint8Array.prototype with relevant methods

          +
          • extendUint8Array(): void

          • Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.fromUint8Array.html b/docs/functions/_runtime_data_format_base64.fromUint8Array.html index bfd18d37..5fd9a348 100644 --- a/docs/functions/_runtime_data_format_base64.fromUint8Array.html +++ b/docs/functions/_runtime_data_format_base64.fromUint8Array.html @@ -1,4 +1,5 @@ -fromUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function fromUint8Array

          • fromUint8Array(u8a, urlsafe?): string

          • converts a Uint8Array to a Base64 string.

            -

            Parameters

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.isValid.html b/docs/functions/_runtime_data_format_base64.isValid.html index 0af2f027..99e2533e 100644 --- a/docs/functions/_runtime_data_format_base64.isValid.html +++ b/docs/functions/_runtime_data_format_base64.isValid.html @@ -1,3 +1,4 @@ -isValid | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isValid

          • isValid(src): boolean

          • check if a value is a valid Base64 string

            -

            Parameters

            • src: any

              a value to check

              -

            Returns boolean

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +isValid | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function isValid

          check if a value is a valid Base64 string

          +
          • isValid(src): boolean

          • Parameters

            • src: any

              a value to check

              +

            Returns boolean

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.toUint8Array.html b/docs/functions/_runtime_data_format_base64.toUint8Array.html index ca537cd8..61ba09c3 100644 --- a/docs/functions/_runtime_data_format_base64.toUint8Array.html +++ b/docs/functions/_runtime_data_format_base64.toUint8Array.html @@ -1,2 +1,3 @@ -toUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function toUint8Array

          • toUint8Array(a): Uint8Array

          • converts a Base64 string to a Uint8Array.

            -

            Parameters

            • a: string

            Returns Uint8Array

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +toUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function toUint8Array

          converts a Base64 string to a Uint8Array.

          +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_base64.utob.html b/docs/functions/_runtime_data_format_base64.utob.html index 4a61c41a..22f75249 100644 --- a/docs/functions/_runtime_data_format_base64.utob.html +++ b/docs/functions/_runtime_data_format_base64.utob.html @@ -1,3 +1,4 @@ -utob | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function utob

          • utob(u): string

          • Parameters

            • u: string

            Returns string

            UTF-16 string

            -

            Deprecated

            should have been internal use only.

            -

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +utob | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function utob

          Deprecated

          should have been internal use only.

          +
          • utob(u): string

          • Parameters

            • u: string

            Returns string

            UTF-16 string

            +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack.addExtension.html b/docs/functions/_runtime_data_format_msgpack.addExtension.html index b3576fa2..20cce2c4 100644 --- a/docs/functions/_runtime_data_format_msgpack.addExtension.html +++ b/docs/functions/_runtime_data_format_msgpack.addExtension.html @@ -1 +1,2 @@ -addExtension | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function addExtension

          • addExtension(extension): void

          • Parameters

            • extension: Extension

            Returns void

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +addExtension | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function addExtension

          • addExtension(extension): void

          • Parameters

            • extension: Extension

            Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack.clearSource.html b/docs/functions/_runtime_data_format_msgpack.clearSource.html index 57ee5e01..389802e5 100644 --- a/docs/functions/_runtime_data_format_msgpack.clearSource.html +++ b/docs/functions/_runtime_data_format_msgpack.clearSource.html @@ -1 +1,2 @@ -clearSource | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function clearSource

          • clearSource(): void

          • Returns void

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +clearSource | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function clearSource

          • clearSource(): void

          • Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack.decode.html b/docs/functions/_runtime_data_format_msgpack.decode.html index 449cad22..00fbb400 100644 --- a/docs/functions/_runtime_data_format_msgpack.decode.html +++ b/docs/functions/_runtime_data_format_msgpack.decode.html @@ -1 +1,2 @@ -decode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function decode

          • decode(messagePack): any

          • Parameters

            Returns any

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +decode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function decode

          • decode(messagePack): any

          • Parameters

            Returns any

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack.encode.html b/docs/functions/_runtime_data_format_msgpack.encode.html index 476cbc1f..beb08d15 100644 --- a/docs/functions/_runtime_data_format_msgpack.encode.html +++ b/docs/functions/_runtime_data_format_msgpack.encode.html @@ -1 +1,2 @@ -encode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function encode

          • encode(value): Buffer

          • Parameters

            • value: any

            Returns Buffer

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +encode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function encode

          • encode(value): Buffer

          • Parameters

            • value: any

            Returns Buffer

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack.pack.html b/docs/functions/_runtime_data_format_msgpack.pack.html index d30566d2..9e43df4f 100644 --- a/docs/functions/_runtime_data_format_msgpack.pack.html +++ b/docs/functions/_runtime_data_format_msgpack.pack.html @@ -1 +1,2 @@ -pack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function pack

          • pack(value): Buffer

          • Parameters

            • value: any

            Returns Buffer

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +pack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function pack

          • pack(value): Buffer

          • Parameters

            • value: any

            Returns Buffer

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack.roundFloat32.html b/docs/functions/_runtime_data_format_msgpack.roundFloat32.html index 4ffcda1b..f157fa54 100644 --- a/docs/functions/_runtime_data_format_msgpack.roundFloat32.html +++ b/docs/functions/_runtime_data_format_msgpack.roundFloat32.html @@ -1 +1,2 @@ -roundFloat32 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function roundFloat32

          • roundFloat32(float32Number): number

          • Parameters

            • float32Number: number

            Returns number

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +roundFloat32 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function roundFloat32

          • roundFloat32(float32Number): number

          • Parameters

            • float32Number: number

            Returns number

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack.unpack.html b/docs/functions/_runtime_data_format_msgpack.unpack.html index b13b4734..6738b724 100644 --- a/docs/functions/_runtime_data_format_msgpack.unpack.html +++ b/docs/functions/_runtime_data_format_msgpack.unpack.html @@ -1 +1,2 @@ -unpack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function unpack

          • unpack(messagePack): any

          • Parameters

            Returns any

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +unpack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function unpack

          • unpack(messagePack): any

          • Parameters

            Returns any

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack.unpackMultiple.html b/docs/functions/_runtime_data_format_msgpack.unpackMultiple.html index 917f3693..2cceb1b6 100644 --- a/docs/functions/_runtime_data_format_msgpack.unpackMultiple.html +++ b/docs/functions/_runtime_data_format_msgpack.unpackMultiple.html @@ -1 +1,2 @@ -unpackMultiple | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function unpackMultiple

          • unpackMultiple(messagePack): any[]

          • Parameters

            Returns any[]

          • unpackMultiple(messagePack, forEach): void

          • Parameters

            • messagePack: Uint8Array | Buffer
            • forEach: ((value, start?, end?) => any)
                • (value, start?, end?): any

                • Parameters

                  • value: any
                  • Optional start: number
                  • Optional end: number

                  Returns any

            Returns void

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +unpackMultiple | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function unpackMultiple

          • unpackMultiple(messagePack): any[]

          • Parameters

            Returns any[]

          • unpackMultiple(messagePack, forEach): void

          • Parameters

            • messagePack: Uint8Array | Buffer
            • forEach: ((value: any, start?: number, end?: number) => any)
                • (value, start?, end?): any

                • Parameters

                  • value: any
                  • Optionalstart: number
                  • Optionalend: number

                  Returns any

            Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpack.html b/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpack.html index 7901706f..71b83429 100644 --- a/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpack.html +++ b/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpack.html @@ -1,6 +1,7 @@ -inflateAndUnpack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function inflateAndUnpack

          • inflateAndUnpack(data, opts?): any

          • Inflates given data then unpacks with MessagePack. This function is the inverse of packAndDeflate.

            +inflateAndUnpack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function inflateAndUnpack

            • inflateAndUnpack(data, opts?): any

            • Inflates given data then unpacks with MessagePack. This function is the inverse of packAndDeflate.

              Parameters

              Returns any

              Inflated and unpacked data.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpackB64.html b/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpackB64.html index ac55f74a..64ea4b25 100644 --- a/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpackB64.html +++ b/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpackB64.html @@ -1,7 +1,8 @@ -inflateAndUnpackB64 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function inflateAndUnpackB64

          • inflateAndUnpackB64(data, opts?): any

          • Converts Base64 string to Uint8Array / inflates then unpacks with MessagePack. This function is the inverse of +inflateAndUnpackB64 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function inflateAndUnpackB64

            • inflateAndUnpackB64(data, opts?): any

            • Converts Base64 string to Uint8Array / inflates then unpacks with MessagePack. This function is the inverse of packAndDeflateB64.

              Parameters

              • data: string

                Any Base64 data that has been compressed with

                -
              • Optional opts: {
                    inflateOptions?: InflateOptions;
                }

                Optional parameters.

                -

              Returns any

              Inflated and unpacked data.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflate.html b/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflate.html index 1f0efeab..49930524 100644 --- a/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflate.html +++ b/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflate.html @@ -1,7 +1,8 @@ -packAndDeflate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function packAndDeflate

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflateB64.html b/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflateB64.html index f5ad6b8f..8b54c140 100644 --- a/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflateB64.html +++ b/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflateB64.html @@ -1,8 +1,9 @@ -packAndDeflateB64 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function packAndDeflateB64

          • packAndDeflateB64(data, opts?): string

          • Packs given data with MessagePack then deflates / compresses with Zlib then converts the Uint8Array to a Base64 +packAndDeflateB64 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function packAndDeflateB64

            • packAndDeflateB64(data, opts?): string

            • Packs given data with MessagePack then deflates / compresses with Zlib then converts the Uint8Array to a Base64 string. The inverse function to inflate is inflateAndUnpackB64.

              Parameters

              • data: any

                Any data.

                -
              • Optional opts: {
                    deflateOptions?: DeflateOptions;
                    urlsafe?: boolean;
                }

                Optional parameters.

                -
                • Optional deflateOptions?: DeflateOptions

                  Deflate options.

                  -
                • Optional urlsafe?: boolean

                  Base64 string is URL-and-filename-safe a la RFC4648 §5.

                  +
                • Optionalopts: {
                      deflateOptions?: DeflateOptions;
                      urlsafe?: boolean;
                  }

                  Optional parameters.

                  +
                  • OptionaldeflateOptions?: DeflateOptions

                    Deflate options.

                    +
                  • Optionalurlsafe?: boolean

                    Base64 string is URL-and-filename-safe a la RFC4648 §5.

              Returns string

              Packed / compressed / Base64 string.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_unicode.graphemeIterator.html b/docs/functions/_runtime_data_format_unicode.graphemeIterator.html index a3c683d0..9db4fbf1 100644 --- a/docs/functions/_runtime_data_format_unicode.graphemeIterator.html +++ b/docs/functions/_runtime_data_format_unicode.graphemeIterator.html @@ -1,7 +1,8 @@ -graphemeIterator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function graphemeIterator

          • graphemeIterator(str): IterableIterator<string>

          • Provides an iterator for tokenizing a string by grapheme clusters.

            +graphemeIterator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function graphemeIterator

            • graphemeIterator(str): IterableIterator<string>

            • Provides an iterator for tokenizing a string by grapheme clusters.

              Note: This is a naive implementation that fully parses the string then returns the iterator over parsed clusters. A future implementation will implement an immediate mode parser returning cluster by cluster as the string is parsed.

              Parameters

              • str: string

                String to split.

              Returns IterableIterator<string>

              An iterator returning grapheme clusters.

              -

              Yields

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Yields

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_unicode.graphemeSplit.html b/docs/functions/_runtime_data_format_unicode.graphemeSplit.html index 9c48667e..ddb74b94 100644 --- a/docs/functions/_runtime_data_format_unicode.graphemeSplit.html +++ b/docs/functions/_runtime_data_format_unicode.graphemeSplit.html @@ -1,4 +1,5 @@ -graphemeSplit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function graphemeSplit

          • graphemeSplit(str): string[]

          • Splits the given string into an array of Unicode grapheme clusters.

            +graphemeSplit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function graphemeSplit

            • graphemeSplit(str): string[]

            • Splits the given string into an array of Unicode grapheme clusters.

              Parameters

              • str: string

                String to split.

              Returns string[]

              The string split by Unicode grapheme clusters.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_data_struct_hash_array.getValueFromKey.html b/docs/functions/_runtime_data_struct_hash_array.getValueFromKey.html index 14b18360..77863582 100644 --- a/docs/functions/_runtime_data_struct_hash_array.getValueFromKey.html +++ b/docs/functions/_runtime_data_struct_hash_array.getValueFromKey.html @@ -1,5 +1,6 @@ -getValueFromKey | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function getValueFromKey

          • getValueFromKey(item, key): any

          • Returns the value for a Key in the given item / object.

            +getValueFromKey | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function getValueFromKey

            • getValueFromKey(item, key): any

            • Returns the value for a Key in the given item / object.

              Parameters

              • item: object

                The target item or partial item.

              • key: Key

                The Key to lookup in item.

              Returns any

              Value for key in item.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_math_gl_matrix.EnableSwizzles.html b/docs/functions/_runtime_math_gl_matrix.EnableSwizzles.html deleted file mode 100644 index 851d24a1..00000000 --- a/docs/functions/_runtime_math_gl_matrix.EnableSwizzles.html +++ /dev/null @@ -1,7 +0,0 @@ -EnableSwizzles | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function EnableSwizzles

          • EnableSwizzles(): void

          • Enables Swizzle operations on Vec2, Vec3, and Vec4 types.

            -

            Swizzle operations are performed by using the . operator in conjunction with any combination -of between two to four component names, either from the set xyzw or rgbw (though not intermixed). -They return a new vector with the same number of components as specified in the swizzle attribute.

            -

            Returns void

            Example

            import { Vec3, EnableSwizzles } from 'gl-matrix';

            EnableSwizzles();

            let v = new Vec3(0, 1, 2);

            v.yx // returns new Vec2(1, 0);
            v.xzy // returns new Vec3(0, 2, 1);
            v.zyxz // returns new Vec4(2, 1, 0, 2);

            v.rgb // returns new Vec3(0, 1, 2);
            v.rbg // returns new Vec3(0, 2, 1);
            v.gg // returns new Vec2(1, 1);
-
            -

          Settings

          Member Visibility

          Theme

          \ No newline at end of file diff --git a/docs/functions/_runtime_math_interpolate.lerp.html b/docs/functions/_runtime_math_interpolate.lerp.html index 28ff86fd..76f26169 100644 --- a/docs/functions/_runtime_math_interpolate.lerp.html +++ b/docs/functions/_runtime_math_interpolate.lerp.html @@ -1,6 +1,7 @@ -lerp | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function lerp

          • lerp(start, end, amount): number

          • Performs linear interpolation between a start & end value by given amount between 0 - 1 inclusive.

            +lerp | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function lerp

            • lerp(start, end, amount): number

            • Performs linear interpolation between a start & end value by given amount between 0 - 1 inclusive.

              Parameters

              • start: number

                Start value.

              • end: number

                End value.

              • amount: number

                Current amount between 0 - 1 inclusive.

              Returns number

              Linear interpolated value between start & end.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_math_util.clamp.html b/docs/functions/_runtime_math_util.clamp.html index e50e068e..e8631a8a 100644 --- a/docs/functions/_runtime_math_util.clamp.html +++ b/docs/functions/_runtime_math_util.clamp.html @@ -1,6 +1,7 @@ -clamp | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function clamp

          • clamp(value?, min?, max?): number

          • Clamps a value between min / max values.

            -

            Parameters

            • Optional value: number

              Value to clamp.

              -
            • Optional min: number

              Minimum value.

              -
            • Optional max: number

              Maximum value.

              +clamp | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
              +

              Function clamp

              • clamp(value?, min?, max?): number

              • Clamps a value between min / max values.

                +

                Parameters

                • Optionalvalue: number

                  Value to clamp.

                  +
                • Optionalmin: number

                  Minimum value.

                  +
                • Optionalmax: number

                  Maximum value.

                Returns number

                Clamped value.

                -

              Settings

              Member Visibility

              Theme

              \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_math_util.degToRad.html b/docs/functions/_runtime_math_util.degToRad.html index 11e815f6..49d6f067 100644 --- a/docs/functions/_runtime_math_util.degToRad.html +++ b/docs/functions/_runtime_math_util.degToRad.html @@ -1,4 +1,5 @@ -degToRad | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function degToRad

          • degToRad(deg): number

          • Converts the given number from degrees to radians.

            +degToRad | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function degToRad

            • degToRad(deg): number

            • Converts the given number from degrees to radians.

              Parameters

              • deg: number

                Degree number to convert

              Returns number

              Degree as radians.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_math_util.radToDeg.html b/docs/functions/_runtime_math_util.radToDeg.html index d8e62c8a..1592b850 100644 --- a/docs/functions/_runtime_math_util.radToDeg.html +++ b/docs/functions/_runtime_math_util.radToDeg.html @@ -1,4 +1,5 @@ -radToDeg | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function radToDeg

          • radToDeg(rad): number

          • Converts the given number from radians to degrees.

            +radToDeg | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function radToDeg

            • radToDeg(rad): number

            • Converts the given number from radians to degrees.

              Parameters

              • rad: number

                Radian number to convert.

              Returns number

              Degree as radians.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_plugin_manager.escapeTarget.html b/docs/functions/_runtime_plugin_manager.escapeTarget.html index 8a118ed4..7f40e152 100644 --- a/docs/functions/_runtime_plugin_manager.escapeTarget.html +++ b/docs/functions/_runtime_plugin_manager.escapeTarget.html @@ -1,6 +1,7 @@ -escapeTarget | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function escapeTarget

          • escapeTarget(target): string

          • Creates an escaped path which is suitable for use in RegExp construction.

            +escapeTarget | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function escapeTarget

            • escapeTarget(target): string

            • Creates an escaped path which is suitable for use in RegExp construction.

              Note: This function will throw if a malformed URL string is the target. In AbstractPluginManager this function is used after the module has been loaded / is a good target.

              Parameters

              • target: string | URL

                Target full / relative path or URL to escape.

              Returns string

              The escaped target.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_plugin_manager.isValidConfig.html b/docs/functions/_runtime_plugin_manager.isValidConfig.html index 660f7487..8a5cfc84 100644 --- a/docs/functions/_runtime_plugin_manager.isValidConfig.html +++ b/docs/functions/_runtime_plugin_manager.isValidConfig.html @@ -1,4 +1,5 @@ -isValidConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isValidConfig

          • isValidConfig(pluginConfig): boolean

          • Performs validation of a PluginConfig.

            +isValidConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function isValidConfig

            • isValidConfig(pluginConfig): boolean

            • Performs validation of a PluginConfig.

              Parameters

              Returns boolean

              True if the given PluginConfig is valid.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_security_client_dompurify.DOMPurify-1.sanitizeWithVideo.html b/docs/functions/_runtime_security_client_dompurify.DOMPurify-1.sanitizeWithVideo.html index 16cafe41..708d67a1 100644 --- a/docs/functions/_runtime_security_client_dompurify.DOMPurify-1.sanitizeWithVideo.html +++ b/docs/functions/_runtime_security_client_dompurify.DOMPurify-1.sanitizeWithVideo.html @@ -1,3 +1,4 @@ -sanitizeWithVideo | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function sanitizeWithVideo

          • sanitizeWithVideo(dirty): any

          • Provides a sanitize method that allows 'iframe' but only with sources from YouTube and Vimeo.

            +sanitizeWithVideo | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function sanitizeWithVideo

            • sanitizeWithVideo(dirty): any

            • Provides a sanitize method that allows 'iframe' but only with sources from YouTube and Vimeo.

              Parameters

              • dirty: string | Node

                The content to sanitize.

                -

              Returns any

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Returns any

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_security_client_dompurify.DOMPurify.html b/docs/functions/_runtime_security_client_dompurify.DOMPurify.html index 518ba49f..bcfce38a 100644 --- a/docs/functions/_runtime_security_client_dompurify.DOMPurify.html +++ b/docs/functions/_runtime_security_client_dompurify.DOMPurify.html @@ -1,4 +1,5 @@ -DOMPurify | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function DOMPurify

          • DOMPurify(root): {
                isSupported: boolean;
                removed: any[];
                version: string;
                addHook(entryPoint, hookFunction): void;
                clearConfig(): void;
                isValidAttribute(tag, attr, value): boolean;
                removeAllHooks(): void;
                removeHook(entryPoint): Function;
                removeHooks(entryPoint): void;
                sanitize(dirty, ...args): any;
                setConfig(...args): void;
                (root): any;
            }

          • Parameters

            • root: any

            Returns {
                isSupported: boolean;
                removed: any[];
                version: string;
                addHook(entryPoint, hookFunction): void;
                clearConfig(): void;
                isValidAttribute(tag, attr, value): boolean;
                removeAllHooks(): void;
                removeHook(entryPoint): Function;
                removeHooks(entryPoint): void;
                sanitize(dirty, ...args): any;
                setConfig(...args): void;
                (root): any;
            }

              • (root): any

              • Parameters

                • root: any

                Returns any

            • isSupported: boolean
            • removed: any[]

              Array of elements that DOMPurify removed during sanitation. +DOMPurify | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

              +

              Function DOMPurify

              • DOMPurify(root): {
                    isSupported: boolean;
                    removed: any[];
                    version: string;
                    addHook(entryPoint: string, hookFunction: Function): void;
                    clearConfig(): void;
                    isValidAttribute(tag: string, attr: string, value: string): boolean;
                    removeAllHooks(): void;
                    removeHook(entryPoint: string): Function;
                    removeHooks(entryPoint: string): void;
                    sanitize(dirty: string | Node, ...args: any[]): any;
                    setConfig(...args: any[]): void;
                    (root: any): any;
                }

              • Parameters

                • root: any

                Returns {
                    isSupported: boolean;
                    removed: any[];
                    version: string;
                    addHook(entryPoint: string, hookFunction: Function): void;
                    clearConfig(): void;
                    isValidAttribute(tag: string, attr: string, value: string): boolean;
                    removeAllHooks(): void;
                    removeHook(entryPoint: string): Function;
                    removeHooks(entryPoint: string): void;
                    sanitize(dirty: string | Node, ...args: any[]): any;
                    setConfig(...args: any[]): void;
                    (root: any): any;
                }

                  • (root): any

                  • Parameters

                    • root: any

                    Returns any

                • isSupported: boolean
                • removed: any[]

                  Array of elements that DOMPurify removed during sanitation. Empty if nothing was removed.

                • version: string

                  Version label, exposed for easier checks if DOMPurify is up to date or not

                  @@ -28,6 +29,6 @@

              Returns void

          • sanitize:function
            • sanitize(dirty, ...args): any

            • Sanitize Public method providing core sanitation functionality

              Parameters

              • dirty: string | Node

                string or DOM node

                -
              • Rest ...args: any[]

              Returns any

          • setConfig:function
            • setConfig(...args): void

            • Public method to set the configuration once +

            • Rest...args: any[]

          Returns any

        • setConfig:function
          • setConfig(...args): void

          • Public method to set the configuration once setConfig

            -

            Parameters

            • Rest ...args: any[]

            Returns void

          • Settings

          Member Visibility

          Theme

          \ No newline at end of file +

          Parameters

          • Rest...args: any[]

          Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_animate.animate.html b/docs/functions/_runtime_svelte_action_animate.animate.html index e2c993e1..b048c4bd 100644 --- a/docs/functions/_runtime_svelte_action_animate.animate.html +++ b/docs/functions/_runtime_svelte_action_animate.animate.html @@ -1,15 +1,16 @@ -animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function animate

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_animate.composable.html b/docs/functions/_runtime_svelte_action_animate.composable.html index 0c887a35..24fcf14a 100644 --- a/docs/functions/_runtime_svelte_action_animate.composable.html +++ b/docs/functions/_runtime_svelte_action_animate.composable.html @@ -1,5 +1,6 @@ -composable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function composable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_animate.ripple.html b/docs/functions/_runtime_svelte_action_animate.ripple.html index cd2e2ba7..41a60563 100644 --- a/docs/functions/_runtime_svelte_action_animate.ripple.html +++ b/docs/functions/_runtime_svelte_action_animate.ripple.html @@ -1,4 +1,5 @@ -ripple | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function ripple

          • ripple(opts?): Action

          • Defines the classic Material Design ripple effect as an action. ripple is a wrapper around the returned action. +ripple | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function ripple

            • ripple(opts?): Action

            • Defines the classic Material Design ripple effect as an action. ripple is a wrapper around the returned action. This allows it to be easily used as a prop.

              Note: A negative one translateZ transform is applied to the added spans allowing other content to be layered on top with a positive translateZ.

              @@ -7,13 +8,13 @@

              Note: A CustomEvent efx-trigger is handled in cases when explicit triggering is necessary. This event should have the actual source event as a property of detail.

              Styling: There is a single CSS variable --tjs-action-ripple-background that can be set to control the background.

              -

              Parameters

              • Optional opts: {
                    background?: string;
                    contextmenu?: boolean;
                    debounce?: number;
                    duration?: number;
                    events?: Iterable<string>;
                    keyCode?: string;
                }

                Optional parameters.

                -
                • Optional background?: string

                  A valid CSS background attribute.

                  -
                • Optional contextmenu?: boolean

                  Add triggering for context menu key and click.

                  -
                • Optional debounce?: number

                  Add a debounce to incoming events in milliseconds.

                  -
                • Optional duration?: number

                  Duration in milliseconds.

                  -
                • Optional events?: Iterable<string>

                  DOM event to bind element to respond with the ripple - effect.

                  -
                • Optional keyCode?: string

                  Key code to trigger for any applicable key events.

                  +

                  Parameters

                  • Optionalopts: {
                        background?: string;
                        contextmenu?: boolean;
                        debounce?: number;
                        duration?: number;
                        events?: Iterable<string>;
                        keyCode?: string;
                    }

                    Optional parameters.

                    +
                    • Optionalbackground?: string

                      A valid CSS background attribute.

                      +
                    • Optionalcontextmenu?: boolean

                      Add triggering for context menu key and click.

                      +
                    • Optionaldebounce?: number

                      Add a debounce to incoming events in milliseconds.

                      +
                    • Optionalduration?: number

                      Duration in milliseconds.

                      +
                    • Optionalevents?: Iterable<string>

                      DOM event to bind element to respond with the ripple +effect.

                      +
                    • OptionalkeyCode?: string

                      Key code to trigger for any applicable key events.

                  Returns Action

                  Actual action.

                  -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_animate.rippleFocus.html b/docs/functions/_runtime_svelte_action_animate.rippleFocus.html index bd03eb45..38af17c8 100644 --- a/docs/functions/_runtime_svelte_action_animate.rippleFocus.html +++ b/docs/functions/_runtime_svelte_action_animate.rippleFocus.html @@ -1,4 +1,5 @@ -rippleFocus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function rippleFocus

          • rippleFocus(opts?): Action

          • Defines the classic Material Design ripple effect as an action that is attached to an elements focus and blur events. +rippleFocus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function rippleFocus

            • rippleFocus(opts?): Action

            • Defines the classic Material Design ripple effect as an action that is attached to an elements focus and blur events. rippleFocus is a wrapper around the returned action. This allows it to be easily used as a prop.

              Note: A negative one translateZ transform is applied to the added spans allowing other content to be layered on top with a positive translateZ.

              @@ -8,9 +9,9 @@ first child is targeted with a final fallback of the element assigned to this action.

              Styling: There is a single CSS variable --tjs-action-ripple-background-focus that can be set to control the background with a fallback to --tjs-action-ripple-background.

              -

              Parameters

              • Optional opts: {
                    background?: string;
                    duration?: number;
                    selector?: string;
                }

                Optional parameters.

                -
                • Optional background?: string

                  A valid CSS background attribute.

                  -
                • Optional duration?: number

                  Duration in milliseconds.

                  -
                • Optional selector?: string

                  A valid CSS selector string.

                  +

                  Parameters

                  • Optionalopts: {
                        background?: string;
                        duration?: number;
                        selector?: string;
                    }

                    Optional parameters.

                    +
                    • Optionalbackground?: string

                      A valid CSS background attribute.

                      +
                    • Optionalduration?: number

                      Duration in milliseconds.

                      +
                    • Optionalselector?: string

                      A valid CSS selector string.

                  Returns Action

                  Actual action.

                  -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_animate.toggleDetails.html b/docs/functions/_runtime_svelte_action_animate.toggleDetails.html index 1f36e8b6..7b16abbf 100644 --- a/docs/functions/_runtime_svelte_action_animate.toggleDetails.html +++ b/docs/functions/_runtime_svelte_action_animate.toggleDetails.html @@ -1,11 +1,12 @@ -toggleDetails | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function toggleDetails

          • toggleDetails(details, opts?): ActionReturn

          • Provides a toggle action for details HTML elements. The boolean store provided controls animation.

            +toggleDetails | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function toggleDetails

            • toggleDetails(details, opts?): ActionReturn

            • Provides a toggle action for details HTML elements. The boolean store provided controls animation.

              It is not necessary to bind the store to the open attribute of the associated details element.

              When the action is triggered to close the details element a data attribute closing is set to true. This allows any associated closing transitions to start immediately.

              Parameters

              • details: HTMLDetailsElement

                The details element.

                -
              • Optional opts: {
                    animate?: boolean;
                    clickActive?: boolean;
                    store: Writable<boolean>;
                }

                Options parameters.

                -
                • Optional animate?: boolean

                  When true animate close / open state with WAAPI.

                  -
                • Optional clickActive?: boolean

                  When false click events are not handled.

                  +
                • Optionalopts: {
                      animate?: boolean;
                      clickActive?: boolean;
                      store: Writable<boolean>;
                  }

                  Options parameters.

                  +
                  • Optionalanimate?: boolean

                    When true animate close / open state with WAAPI.

                    +
                  • OptionalclickActive?: boolean

                    When false click events are not handled.

                  • store: Writable<boolean>

                    A boolean store.

              Returns ActionReturn

              Lifecycle functions.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom.alwaysBlur.html b/docs/functions/_runtime_svelte_action_dom.alwaysBlur.html index 44a44249..bd96543d 100644 --- a/docs/functions/_runtime_svelte_action_dom.alwaysBlur.html +++ b/docs/functions/_runtime_svelte_action_dom.alwaysBlur.html @@ -1,4 +1,5 @@ -alwaysBlur | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function alwaysBlur

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom.applyScrolltop.html b/docs/functions/_runtime_svelte_action_dom.applyScrolltop.html index 44da92a1..dc62f75a 100644 --- a/docs/functions/_runtime_svelte_action_dom.applyScrolltop.html +++ b/docs/functions/_runtime_svelte_action_dom.applyScrolltop.html @@ -1,8 +1,9 @@ -applyScrolltop | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function applyScrolltop

          • applyScrolltop(element, store): ActionReturn<Writable<number>>

          • Provides an action to save scrollTop of an element with a vertical scrollbar. This action should be used on the +applyScrolltop | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function applyScrolltop

            • applyScrolltop(element, store): ActionReturn<Writable<number>>

            • Provides an action to save scrollTop of an element with a vertical scrollbar. This action should be used on the scrollable element and must include a writable store that holds the active store for the current scrollTop value. You may switch the stores externally and this action will set the scrollTop based on the newly set store. This is useful for instance providing a select box that controls the scrollable container.

              Parameters

              • element: HTMLElement

                The target scrollable HTML element.

              • store: Writable<number>

                A writable store that stores the element scrollTop.

              Returns ActionReturn<Writable<number>>

              Lifecycle functions.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom.applyStyles.html b/docs/functions/_runtime_svelte_action_dom.applyStyles.html index 9fed8f4f..a7d76832 100644 --- a/docs/functions/_runtime_svelte_action_dom.applyStyles.html +++ b/docs/functions/_runtime_svelte_action_dom.applyStyles.html @@ -1,5 +1,6 @@ -applyStyles | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function applyStyles

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom.autoBlur.html b/docs/functions/_runtime_svelte_action_dom.autoBlur.html index 912439b2..ab44214e 100644 --- a/docs/functions/_runtime_svelte_action_dom.autoBlur.html +++ b/docs/functions/_runtime_svelte_action_dom.autoBlur.html @@ -1,5 +1,6 @@ -autoBlur | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function autoBlur

          • autoBlur(node): ActionReturn

          • Provides an action to blur the element when any pointer down event occurs outside the element. This can be useful +autoBlur | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function autoBlur

            • autoBlur(node): ActionReturn

            • Provides an action to blur the element when any pointer down event occurs outside the element. This can be useful for input elements including select to blur / unfocus the element when any pointer down occurs outside the element.

              Parameters

              • node: HTMLElement

                The node to handle automatic blur on focus loss.

              Returns ActionReturn

              Lifecycle functions.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom.isFocused.html b/docs/functions/_runtime_svelte_action_dom.isFocused.html index 6d8f6f63..75977f12 100644 --- a/docs/functions/_runtime_svelte_action_dom.isFocused.html +++ b/docs/functions/_runtime_svelte_action_dom.isFocused.html @@ -1,6 +1,7 @@ -isFocused | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isFocused

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom.resizeObserver-1.updateCache.html b/docs/functions/_runtime_svelte_action_dom.resizeObserver-1.updateCache.html index 09a46b5f..d674e241 100644 --- a/docs/functions/_runtime_svelte_action_dom.resizeObserver-1.updateCache.html +++ b/docs/functions/_runtime_svelte_action_dom.resizeObserver-1.updateCache.html @@ -1,5 +1,6 @@ -updateCache | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function updateCache

          • updateCache(el): void

          • Provides a function that when invoked with an element updates the cached styles for each subscriber of the element.

            +updateCache | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function updateCache

            • updateCache(el): void

            • Provides a function that when invoked with an element updates the cached styles for each subscriber of the element.

              The style attributes cached to calculate offset height / width include border & padding dimensions. You only need to update the cache if you change border or padding attributes of the element.

              Parameters

              Returns void

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom.resizeObserver.html b/docs/functions/_runtime_svelte_action_dom.resizeObserver.html index 8f0f897e..3f6c9c71 100644 --- a/docs/functions/_runtime_svelte_action_dom.resizeObserver.html +++ b/docs/functions/_runtime_svelte_action_dom.resizeObserver.html @@ -1,4 +1,5 @@ -resizeObserver | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function resizeObserver

          Returns ActionReturn<ResizeTarget>

          The +action lifecycle methods.

          +

          See

          https://github.com/sveltejs/svelte/issues/4233

          +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_util.dynamicAction.html b/docs/functions/_runtime_svelte_action_util.dynamicAction.html index c39aba24..2233db27 100644 --- a/docs/functions/_runtime_svelte_action_util.dynamicAction.html +++ b/docs/functions/_runtime_svelte_action_util.dynamicAction.html @@ -1,7 +1,8 @@ -dynamicAction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function dynamicAction

          Returns ActionReturn<DynamicActionOptions>

          The action lifecycle +methods.

          +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_animate.animateEvents.html b/docs/functions/_runtime_svelte_animate.animateEvents.html index c662042c..f73b74d7 100644 --- a/docs/functions/_runtime_svelte_animate.animateEvents.html +++ b/docs/functions/_runtime_svelte_animate.animateEvents.html @@ -1,4 +1,5 @@ -animateEvents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function animateEvents

          • animateEvents(fn, store?): ((node, data, ...rest) => AnimationConfig)

          • Svelte doesn't provide any events for the animate directive.

            +animateEvents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function animateEvents

            • animateEvents(fn, store?): ((node: Element, data: {
                  from: DOMRect;
                  to: DOMRect;
              }, ...rest: any) => AnimationConfig)

            • Svelte doesn't provide any events for the animate directive.

              The provided function below wraps a Svelte animate directive function generating bubbling events for start & end of animation.

              These events are animate:start and animate:end.

              @@ -6,12 +7,14 @@ needs to be set to none while animating such that the scrollbar is not activated by the animation.

              Optionally you may also provide a boolean writable store that will be set to true when animation is active. In some cases this leads to an easier implementation for gating on animation state.

              -

              Parameters

              Returns ((node, data, ...rest) => AnimationConfig)

              Wrapped animation function.

              -

              Example: With events

              const flipWithEvents = animateEvents(flip);
              </script>

              <main on:animate:start={() => console.log('animate:start')
                    on:animate:end={() => console.log('animate:end')}>
                 {#each someData as entry (entry.id)}
                    <section animate:flipWithEvents />
                 {/each}
-
              -

              Example: With optional store

              const isAnimating = writable(false);
              const flipWithEvents = animateEvents(flip, isAnimating);
              </script>

              <main class:no-scroll={$isAnimating}>
                 {#each someData as entry (entry.id)}
                    <section animate:flipWithEvents />
                 {/each}
-
              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Parameters

            Returns ((node: Element, data: {
                from: DOMRect;
                to: DOMRect;
            }, ...rest: any) => AnimationConfig)

            Wrapped animation function.

            +

            Example: With events

            const flipWithEvents = animateEvents(flip);
            </script>

            <main on:animate:start={() => console.log('animate:start')
                  on:animate:end={() => console.log('animate:end')}>
               {#each someData as entry (entry.id)}
                  <section animate:flipWithEvents />
               {/each}
+
            + +

            Example: With optional store

            const isAnimating = writable(false);
            const flipWithEvents = animateEvents(flip, isAnimating);
            </script>

            <main class:no-scroll={$isAnimating}>
               {#each someData as entry (entry.id)}
                  <section animate:flipWithEvents />
               {/each}
+
            + +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_easing.getEasingFunc.html b/docs/functions/_runtime_svelte_easing.getEasingFunc.html index e01e27a9..32bd3c92 100644 --- a/docs/functions/_runtime_svelte_easing.getEasingFunc.html +++ b/docs/functions/_runtime_svelte_easing.getEasingFunc.html @@ -1,10 +1,11 @@ -getEasingFunc | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function getEasingFunc

          • getEasingFunc(easingRef, options?): EasingFunction

          • Performs a lookup for standard Svelte easing functions by name. For convenience if passing in a function it is +getEasingFunc | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function getEasingFunc

            • getEasingFunc(easingRef, options?): EasingFunction

            • Performs a lookup for standard Svelte easing functions by name. For convenience if passing in a function it is returned verbatim.

              Parameters

              • easingRef: EasingReference

                The name of a standard Svelte easing function or a supplied - easing function.

                -
              • Optional options: {
                    default?: false | EasingFunctionName;
                }

                Optional parameters.

                -
                • Optional default?: false | EasingFunctionName

                  A default easing function by - name to return. When specified as false no default fallback easing function is selected. The default value - is linear.

                  +easing function.

                  +
                • Optionaloptions: {
                      default?: false | EasingFunctionName;
                  }

                  Optional parameters.

                  +
                  • Optionaldefault?: false | EasingFunctionName

                    A default easing function by +name to return. When specified as false no default fallback easing function is selected. The default value +is linear.

              Returns EasingFunction

              The requested easing function.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_gsap.draggableGsap-1.options.html b/docs/functions/_runtime_svelte_gsap.draggableGsap-1.options.html index bbe73c34..97ab88eb 100644 --- a/docs/functions/_runtime_svelte_gsap.draggableGsap-1.options.html +++ b/docs/functions/_runtime_svelte_gsap.draggableGsap-1.options.html @@ -1,4 +1,5 @@ -options | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function options

          Returns DraggableGsapOptionsStore

          A new options instance.

          +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_gsap.draggableGsap.html b/docs/functions/_runtime_svelte_gsap.draggableGsap.html index 2d2121f5..1d63e81a 100644 --- a/docs/functions/_runtime_svelte_gsap.draggableGsap.html +++ b/docs/functions/_runtime_svelte_gsap.draggableGsap.html @@ -1,4 +1,5 @@ -draggableGsap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function draggableGsap

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_gsap.getGsapEasingFunc.html b/docs/functions/_runtime_svelte_gsap.getGsapEasingFunc.html index df261a9b..c686c14c 100644 --- a/docs/functions/_runtime_svelte_gsap.getGsapEasingFunc.html +++ b/docs/functions/_runtime_svelte_gsap.getGsapEasingFunc.html @@ -1,9 +1,10 @@ -getGsapEasingFunc | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function getGsapEasingFunc

          • getGsapEasingFunc(easingRef, options?): EasingFunction

          • Performs a lookup for standard Gsap easing functions by name. All Svelte easing functions are also available by +getGsapEasingFunc | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function getGsapEasingFunc

            • getGsapEasingFunc(easingRef, options?): EasingFunction

            • Performs a lookup for standard Gsap easing functions by name. All Svelte easing functions are also available by prepending svelte-<EASE_NAME>. For convenience if passing in a function it is returned verbatim.

              Parameters

              • easingRef: GsapEasingReference

                The name of a standard GSAP easing function or an - existing supplied easing function.

                -
              • Optional options: {
                    default?: false | GsapEasingFunctionName;
                }

                Optional parameters.

                -
                • Optional default?: false | GsapEasingFunctionName

                  The default easing function - name to apply. When specified as false no default fallback easing function is selected.

                  +existing supplied easing function.

                  +
                • Optionaloptions: {
                      default?: false | GsapEasingFunctionName;
                  }

                  Optional parameters.

                  +
                  • Optionaldefault?: false | GsapEasingFunctionName

                    The default easing function +name to apply. When specified as false no default fallback easing function is selected.

              Returns EasingFunction

              The requested easing function.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_helper.localize.html b/docs/functions/_runtime_svelte_helper.localize.html index f067f71f..c02b6e74 100644 --- a/docs/functions/_runtime_svelte_helper.localize.html +++ b/docs/functions/_runtime_svelte_helper.localize.html @@ -1,7 +1,8 @@ -localize | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function localize

          • localize(stringId, data?): string

          • Localize a string including variable formatting for input arguments. Provide a string ID which defines the localized +localize | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function localize

            • localize(stringId, data?): string

            • Localize a string including variable formatting for input arguments. Provide a string ID which defines the localized template. Variables can be included in the template enclosed in braces and will be substituted using those named keys.

              Parameters

              • stringId: string

                The string ID to translate.

                -
              • Optional data: object

                Provided input data.

                +
              • Optionaldata: object

                Provided input data.

              Returns string

              The translated and formatted string

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_helper.radioBoxes.html b/docs/functions/_runtime_svelte_helper.radioBoxes.html index 1b12c9f1..559fd07c 100644 --- a/docs/functions/_runtime_svelte_helper.radioBoxes.html +++ b/docs/functions/_runtime_svelte_helper.radioBoxes.html @@ -1,4 +1,5 @@ -radioBoxes | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function radioBoxes

          • radioBoxes(name, choices, options): string

          • A helper to create a set of radio checkbox input elements in a named set. +radioBoxes | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function radioBoxes

            • radioBoxes(name, choices, options): string

            • A helper to create a set of radio checkbox input elements in a named set. The provided keys are the possible radio values while the provided values are human readable labels.

              Parameters

              • name: string

                The radio checkbox field name

              • choices: object

                A mapping of radio checkbox values to human readable labels

                @@ -6,8 +7,10 @@
                • checked: string

                  Which key is currently checked?

                • localize: boolean

                  Pass each label through string localization?

              Returns string

              HTML for radio boxes.

              -

              Example: The provided input data

              let groupName = "importantChoice";
              let choices = {a: "Choice A", b: "Choice B"};
              let chosen = "a";
-
              -

              Example: The template HTML structure

              <div class="form-group">
                <label>Radio Group Label</label>
                <div class="form-fields">
                  {@html radioBoxes(groupName, choices, { checked: chosen, localize: true})}
                </div>
              </div>
-
              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Example: The provided input data

            let groupName = "importantChoice";
            let choices = {a: "Choice A", b: "Choice B"};
            let chosen = "a";
+
            + +

            Example: The template HTML structure

            <div class="form-group">
              <label>Radio Group Label</label>
              <div class="form-fields">
                {@html radioBoxes(groupName, choices, { checked: chosen, localize: true})}
              </div>
            </div>
+
            + +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_helper.selectOptions.html b/docs/functions/_runtime_svelte_helper.selectOptions.html index 968ddee4..cfe07d8c 100644 --- a/docs/functions/_runtime_svelte_helper.selectOptions.html +++ b/docs/functions/_runtime_svelte_helper.selectOptions.html @@ -1,4 +1,5 @@ -selectOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function selectOptions

          • selectOptions(choices, options): string

          • Converts the selectOptions Handlebars helper to be Svelte compatible. This is useful when initially converting +selectOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function selectOptions

            • selectOptions(choices, options): string

            • Converts the selectOptions Handlebars helper to be Svelte compatible. This is useful when initially converting over an app to Svelte and for essential usage to several dialogs that mirror the core Foundry experience. For an example of usage see TJSDocumentOwnership.

              A helper to create a set of

            Theme

            \ No newline at end of file + +SettingsMember VisibilityInherited

          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_dom.keyforward.html b/docs/functions/_runtime_svelte_store_dom.keyforward.html index d72d231e..094639b7 100644 --- a/docs/functions/_runtime_svelte_store_dom.keyforward.html +++ b/docs/functions/_runtime_svelte_store_dom.keyforward.html @@ -1,6 +1,7 @@ -keyforward | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function keyforward

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_position.applyPosition.html b/docs/functions/_runtime_svelte_store_position.applyPosition.html index 76bd091f..8af35c02 100644 --- a/docs/functions/_runtime_svelte_store_position.applyPosition.html +++ b/docs/functions/_runtime_svelte_store_position.applyPosition.html @@ -1,6 +1,7 @@ -applyPosition | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function applyPosition

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_position.draggable-1.options.html b/docs/functions/_runtime_svelte_store_position.draggable-1.options.html index 9b3ed32e..07bcf4d0 100644 --- a/docs/functions/_runtime_svelte_store_position.draggable-1.options.html +++ b/docs/functions/_runtime_svelte_store_position.draggable-1.options.html @@ -1,4 +1,5 @@ -options | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function options

          Returns DraggableOptionsStore

          A new options instance.

          +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_position.draggable.html b/docs/functions/_runtime_svelte_store_position.draggable.html index 772b4aa8..934ca128 100644 --- a/docs/functions/_runtime_svelte_store_position.draggable.html +++ b/docs/functions/_runtime_svelte_store_position.draggable.html @@ -1,8 +1,9 @@ -draggable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function draggable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_web_storage.storeGenerator.html b/docs/functions/_runtime_svelte_store_web_storage.storeGenerator.html index 2836e9cf..26b3b65e 100644 --- a/docs/functions/_runtime_svelte_store_web_storage.storeGenerator.html +++ b/docs/functions/_runtime_svelte_store_web_storage.storeGenerator.html @@ -1,11 +1,12 @@ -storeGenerator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function storeGenerator

          • storeGenerator(opts): StorageStores

          • Generates derived, readable, writable helper functions wrapping the given Storage API provided with any additional +storeGenerator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function storeGenerator

            • storeGenerator(opts): StorageStores

            • Generates derived, readable, writable helper functions wrapping the given Storage API provided with any additional customization for data serialization. By default, JSON serialization is used.

              -

              Parameters

              • opts: {
                    deserialize?: ((value, ...rest) => any);
                    serialize?: ((value, ...rest) => string);
                    storage: Storage;
                }

                Generator options.

                -
                • Optional deserialize?: ((value, ...rest) => any)

                  Replace with custom deserialization; - default: JSON.parse.

                  -
                    • (value, ...rest): any

                    • Parameters

                      • value: string
                      • Rest ...rest: any[]

                      Returns any

                • Optional serialize?: ((value, ...rest) => string)

                  Replace with custom serialization; - default: JSON.stringify.

                  -
                    • (value, ...rest): string

                    • Parameters

                      • value: any
                      • Rest ...rest: any[]

                      Returns string

                • storage: Storage

                  The web storage source.

                  +

                  Parameters

                  • opts: {
                        deserialize?: ((value: string, ...rest: any[]) => any);
                        serialize?: ((value: any, ...rest: any[]) => string);
                        storage: Storage;
                    }

                    Generator options.

                    +
                    • Optionaldeserialize?: ((value: string, ...rest: any[]) => any)

                      Replace with custom deserialization; +default: JSON.parse.

                      +
                        • (value, ...rest): any

                        • Parameters

                          • value: string
                          • Rest...rest: any[]

                          Returns any

                    • Optionalserialize?: ((value: any, ...rest: any[]) => string)

                      Replace with custom serialization; +default: JSON.stringify.

                      +
                        • (value, ...rest): string

                        • Parameters

                          • value: any
                          • Rest...rest: any[]

                          Returns string

                    • storage: Storage

                      The web storage source.

                  Returns StorageStores

                  A complete set of store helper functions and associated storage API instance and - serialization strategy.

                  -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +serialization strategy.

            +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_writable_derived.propertyStore.html b/docs/functions/_runtime_svelte_store_writable_derived.propertyStore.html index ae1295d0..746d7f79 100644 --- a/docs/functions/_runtime_svelte_store_writable_derived.propertyStore.html +++ b/docs/functions/_runtime_svelte_store_writable_derived.propertyStore.html @@ -1,7 +1,8 @@ -propertyStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function propertyStore

          • propertyStore<O, K>(origin, propName): Writable<O[K]>

          • Create a store for a property value in an object contained in another store. -Read more...

            +propertyStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function propertyStore

            • propertyStore<O, K>(origin, propName): Writable<O[K]>

            • Create a store for a property value in an object contained in another store. +Read more...

              Type Parameters

              • O extends object
              • K extends string | number | symbol

              Parameters

              • origin: MinimalWritable<O>

                The store containing the object to get/set from.

              • propName: K | [K]

                The property to get/set, or a path of properties in nested objects.

              Returns Writable<O[K]>

              A writable store.

              -
            • propertyStore<O, K1, K2>(origin, propName): Writable<O[K1][K2]>

            • Type Parameters

              • O extends object
              • K1 extends string | number | symbol
              • K2 extends string | number | symbol

              Parameters

              Returns Writable<O[K1][K2]>

            • propertyStore<O, K1, K2, K3>(origin, propName): Writable<O[K1][K2][K3]>

            • Type Parameters

              • O extends object
              • K1 extends string | number | symbol
              • K2 extends string | number | symbol
              • K3 extends string | number | symbol

              Parameters

              Returns Writable<O[K1][K2][K3]>

            • propertyStore<O, K1, K2, K3, K4>(origin, propName): Writable<O[K1][K2][K3][K4]>

            • Type Parameters

              • O extends object
              • K1 extends string | number | symbol
              • K2 extends string | number | symbol
              • K3 extends string | number | symbol
              • K4 extends string | number | symbol

              Parameters

              Returns Writable<O[K1][K2][K3][K4]>

            • propertyStore(origin, propName): Writable<any>

            • Parameters

              • origin: MinimalWritable<object>
              • propName: string | number | symbol | (string | number | symbol)[]

              Returns Writable<any>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +
          • propertyStore<O, K1, K2>(origin, propName): Writable<O[K1][K2]>

          • Type Parameters

            • O extends object
            • K1 extends string | number | symbol
            • K2 extends string | number | symbol

            Parameters

            Returns Writable<O[K1][K2]>

          • propertyStore<O, K1, K2, K3>(origin, propName): Writable<O[K1][K2][K3]>

          • Type Parameters

            • O extends object
            • K1 extends string | number | symbol
            • K2 extends string | number | symbol
            • K3 extends string | number | symbol

            Parameters

            Returns Writable<O[K1][K2][K3]>

          • propertyStore<O, K1, K2, K3, K4>(origin, propName): Writable<O[K1][K2][K3][K4]>

          • Type Parameters

            • O extends object
            • K1 extends string | number | symbol
            • K2 extends string | number | symbol
            • K3 extends string | number | symbol
            • K4 extends string | number | symbol

            Parameters

            Returns Writable<O[K1][K2][K3][K4]>

          • propertyStore(origin, propName): Writable<any>

          • Parameters

            • origin: MinimalWritable<object>
            • propName:
                  | string
                  | number
                  | symbol
                  | (string | number | symbol)[]

            Returns Writable<any>

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_writable_derived.writableDerived.html b/docs/functions/_runtime_svelte_store_writable_derived.writableDerived.html index 059c1b71..e877dd25 100644 --- a/docs/functions/_runtime_svelte_store_writable_derived.writableDerived.html +++ b/docs/functions/_runtime_svelte_store_writable_derived.writableDerived.html @@ -1,14 +1,15 @@ -writableDerived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function writableDerived

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_transition.rotate.html b/docs/functions/_runtime_svelte_transition.rotate.html index 249f5f6a..f80f1b36 100644 --- a/docs/functions/_runtime_svelte_transition.rotate.html +++ b/docs/functions/_runtime_svelte_transition.rotate.html @@ -1,14 +1,15 @@ -rotate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function rotate

          • rotate(node, options?): TransitionConfig

          • Provides a rotate transition. For options easing is applied to the rotate transition. The default easing is +rotate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function rotate

            • rotate(node, options?): TransitionConfig

            • Provides a rotate transition. For options easing is applied to the rotate transition. The default easing is linear.

              Note: that when reversing the transition that time goes from 1 - 0, so if specific options are applied for rotating out transition then end and initial are swapped.

              Parameters

              • node: HTMLElement

                The transition node.

                -
              • Optional options: {
                    delay?: number;
                    duration?: number;
                    easing?: EasingReference;
                    end?: number;
                    initial?: number;
                }

                Optional parameters.

                -
                • Optional delay?: number

                  Delay in ms before start of transition.

                  -
                • Optional duration?: number

                  Total transition length in ms.

                  -
                • Optional easing?: EasingReference

                  Easing function name or - function to apply to the rotate transition.

                  -
                • Optional end?: number

                  End rotation in degrees.

                  -
                • Optional initial?: number

                  Initial rotation in degrees.

                  +
                • Optionaloptions: {
                      delay?: number;
                      duration?: number;
                      easing?: EasingReference;
                      end?: number;
                      initial?: number;
                  }

                  Optional parameters.

                  +
                  • Optionaldelay?: number

                    Delay in ms before start of transition.

                    +
                  • Optionalduration?: number

                    Total transition length in ms.

                    +
                  • Optionaleasing?: EasingReference

                    Easing function name or +function to apply to the rotate transition.

                    +
                  • Optionalend?: number

                    End rotation in degrees.

                    +
                  • Optionalinitial?: number

                    Initial rotation in degrees.

              Returns TransitionConfig

              Transition config.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_transition.rotateFade.html b/docs/functions/_runtime_svelte_transition.rotateFade.html index e2297b31..dea68482 100644 --- a/docs/functions/_runtime_svelte_transition.rotateFade.html +++ b/docs/functions/_runtime_svelte_transition.rotateFade.html @@ -1,19 +1,20 @@ -rotateFade | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function rotateFade

          • rotateFade(node, options?): TransitionConfig

          • Combines rotate & fade transitions into a single transition. For options easing this is applied to both +rotateFade | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function rotateFade

            • rotateFade(node, options?): TransitionConfig

            • Combines rotate & fade transitions into a single transition. For options easing this is applied to both transitions, however if provided easingRotate and / or easingFade will take precedence. The default easing is linear.

              Note: that when reversing the transition that time goes from 1 - 0, so if specific options are applied for rotating out transition then end and initial are swapped.

              Parameters

              • node: HTMLElement

                The transition node.

                -
              • Optional options: {
                    delay?: number;
                    duration?: number;
                    easing?: EasingReference;
                    easingFade?: EasingReference;
                    easingRotate?: EasingReference;
                    end?: number;
                    initial?: number;
                }

                Optional parameters.

                -
                • Optional delay?: number

                  Delay in ms before start of transition.

                  -
                • Optional duration?: number

                  Total transition length in ms.

                  -
                • Optional easing?: EasingReference

                  Easing function name or - function to apply to both slide & fade transitions.

                  -
                • Optional easingFade?: EasingReference

                  Easing function name or - function to apply to the fade transition.

                  -
                • Optional easingRotate?: EasingReference

                  Easing function name or - function to apply to the rotate transition.

                  -
                • Optional end?: number

                  End rotation in degrees.

                  -
                • Optional initial?: number

                  Initial rotation in degrees.

                  +
                • Optionaloptions: {
                      delay?: number;
                      duration?: number;
                      easing?: EasingReference;
                      easingFade?: EasingReference;
                      easingRotate?: EasingReference;
                      end?: number;
                      initial?: number;
                  }

                  Optional parameters.

                  +
                  • Optionaldelay?: number

                    Delay in ms before start of transition.

                    +
                  • Optionalduration?: number

                    Total transition length in ms.

                    +
                  • Optionaleasing?: EasingReference

                    Easing function name or +function to apply to both slide & fade transitions.

                    +
                  • OptionaleasingFade?: EasingReference

                    Easing function name or +function to apply to the fade transition.

                    +
                  • OptionaleasingRotate?: EasingReference

                    Easing function name or +function to apply to the rotate transition.

                    +
                  • Optionalend?: number

                    End rotation in degrees.

                    +
                  • Optionalinitial?: number

                    Initial rotation in degrees.

              Returns TransitionConfig

              Transition config.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_transition.slideFade.html b/docs/functions/_runtime_svelte_transition.slideFade.html index 03cccee2..6de77fe1 100644 --- a/docs/functions/_runtime_svelte_transition.slideFade.html +++ b/docs/functions/_runtime_svelte_transition.slideFade.html @@ -1,15 +1,16 @@ -slideFade | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function slideFade

          • slideFade(node, options?): TransitionConfig

          • Combines slide & fade transitions into a single transition. For options easing this is applied to both transitions, +slideFade | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function slideFade

            • slideFade(node, options?): TransitionConfig

            • Combines slide & fade transitions into a single transition. For options easing this is applied to both transitions, however if provided easingSlide and / or easingFade will take precedence. The default easing is linear.

              Parameters

              • node: HTMLElement

                The transition node.

                -
              • Optional options: {
                    axis?: "x" | "y";
                    delay?: number;
                    duration?: number;
                    easing?: EasingReference;
                    easingFade?: EasingReference;
                    easingSlide?: EasingReference;
                }

                Optional parameters.

                -
                • Optional axis?: "x" | "y"

                  The sliding axis.

                  -
                • Optional delay?: number

                  Delay in ms before start of transition.

                  -
                • Optional duration?: number

                  Total transition length in ms.

                  -
                • Optional easing?: EasingReference

                  Easing function name or - function to apply to both slide & fade transitions.

                  -
                • Optional easingFade?: EasingReference

                  Easing function name or - function to apply to the fade transition.

                  -
                • Optional easingSlide?: EasingReference

                  Easing function name or - function to apply to the slide transition.

                  +
                • Optionaloptions: {
                      axis?: "x" | "y";
                      delay?: number;
                      duration?: number;
                      easing?: EasingReference;
                      easingFade?: EasingReference;
                      easingSlide?: EasingReference;
                  }

                  Optional parameters.

                  +
                  • Optionalaxis?: "x" | "y"

                    The sliding axis.

                    +
                  • Optionaldelay?: number

                    Delay in ms before start of transition.

                    +
                  • Optionalduration?: number

                    Total transition length in ms.

                    +
                  • Optionaleasing?: EasingReference

                    Easing function name or +function to apply to both slide & fade transitions.

                    +
                  • OptionaleasingFade?: EasingReference

                    Easing function name or +function to apply to the fade transition.

                    +
                  • OptionaleasingSlide?: EasingReference

                    Easing function name or +function to apply to the slide transition.

              Returns TransitionConfig

              Transition config.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_transition.toAnimation.html b/docs/functions/_runtime_svelte_transition.toAnimation.html index d00da211..fbd0ce83 100644 --- a/docs/functions/_runtime_svelte_transition.toAnimation.html +++ b/docs/functions/_runtime_svelte_transition.toAnimation.html @@ -1,7 +1,8 @@ -toAnimation | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function toAnimation

          • toAnimation(fn): ((node, data, ...rest) => any)

          • Converts a Svelte transition to an animation. Both transitions & animations use the same CSS / styles solution and +toAnimation | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function toAnimation

            • toAnimation(fn): ((node: Element, data: {
                  from: DOMRect;
                  to: DOMRect;
              }, ...rest: any) => any)

            • Converts a Svelte transition to an animation. Both transitions & animations use the same CSS / styles solution and resulting data so wrap the transition function with the signature of an animation.

              -

              Parameters

              Returns ((node, data, ...rest) => any)

                +

            Parameters

            Returns ((node: Element, data: {
                from: DOMRect;
                to: DOMRect;
            }, ...rest: any) => any)

            • Transition function converted to an animation.
            -

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_animate.nextAnimationFrame.html b/docs/functions/_runtime_util_animate.nextAnimationFrame.html index 3f35f38b..b2722fcc 100644 --- a/docs/functions/_runtime_util_animate.nextAnimationFrame.html +++ b/docs/functions/_runtime_util_animate.nextAnimationFrame.html @@ -1,5 +1,6 @@ -nextAnimationFrame | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function nextAnimationFrame

          • nextAnimationFrame(cntr?): Promise<number>

          • Awaits requestAnimationFrame calls by the counter specified. This allows asynchronous applications for direct / +nextAnimationFrame | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function nextAnimationFrame

            • nextAnimationFrame(cntr?): Promise<number>

            • Awaits requestAnimationFrame calls by the counter specified. This allows asynchronous applications for direct / inline style modification amongst other direct animation techniques.

              -

              Parameters

              • Optional cntr: number

                A positive integer greater than 0 for amount of requestAnimationFrames to wait.

                +

                Parameters

                • Optionalcntr: number

                  A positive integer greater than 0 for amount of requestAnimationFrames to wait.

                Returns Promise<number>

                Returns time of last requestAnimationFrame callback.

                -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_browser.getStackingContext.html b/docs/functions/_runtime_util_browser.getStackingContext.html index aaad739a..cf87fac3 100644 --- a/docs/functions/_runtime_util_browser.getStackingContext.html +++ b/docs/functions/_runtime_util_browser.getStackingContext.html @@ -1,10 +1,11 @@ -getStackingContext | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function getStackingContext

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_browser.processHTML.html b/docs/functions/_runtime_util_browser.processHTML.html index 4404cc3b..cd291780 100644 --- a/docs/functions/_runtime_util_browser.processHTML.html +++ b/docs/functions/_runtime_util_browser.processHTML.html @@ -1,12 +1,13 @@ -processHTML | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function processHTML

          • processHTML(opts): string

          • Processes the given HTML by creating by running a CSS selector query with all matched elements being passed through +processHTML | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function processHTML

            • processHTML(opts): string

            • Processes the given HTML by creating by running a CSS selector query with all matched elements being passed through the provided process function.

              -

              Parameters

              • opts: {
                    containerElement?: string;
                    firstMatchOnly?: boolean;
                    html: string;
                    namespaceURI?: string;
                    process: ((HTMLElement) => void);
                    selector: string;
                }

                Options

                -
                • Optional containerElement?: string

                  Use a specific container element.

                  -
                • Optional firstMatchOnly?: boolean

                  When true querySelector is invoked to process the - first matching element only.

                  +

                  Parameters

                  • opts: {
                        containerElement?: string;
                        firstMatchOnly?: boolean;
                        html: string;
                        namespaceURI?: string;
                        process: ((HTMLElement: any) => void);
                        selector: string;
                    }

                    Options

                    +
                    • OptionalcontainerElement?: string

                      Use a specific container element.

                      +
                    • OptionalfirstMatchOnly?: boolean

                      When true querySelector is invoked to process the +first matching element only.

                    • html: string

                      The HTML to process.

                      -
                    • Optional namespaceURI?: string

                      The namespace URI of the elements to select.

                      -
                    • process: ((HTMLElement) => void)

                      The selected element processing function.

                      +
                    • OptionalnamespaceURI?: string

                      The namespace URI of the elements to select.

                      +
                    • process: ((HTMLElement: any) => void)

                      The selected element processing function.

                        • (HTMLElement): void

                        • Parameters

                          • HTMLElement: any

                          Returns void

                    • selector: string

                      The CSS selector query.

                  Returns string

                  The processed HTML.

                  -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_browser.striptags.html b/docs/functions/_runtime_util_browser.striptags.html index 0897571b..a24ec23b 100644 --- a/docs/functions/_runtime_util_browser.striptags.html +++ b/docs/functions/_runtime_util_browser.striptags.html @@ -1 +1,2 @@ -striptags | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function striptags

          • striptags(text, options?): string

          • Parameters

            • text: string
            • Optional options: Partial<StateMachineOptions>

            Returns string

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +striptags | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function striptags

          • striptags(text, options?): string

          • Parameters

            • text: string
            • Optionaloptions: Partial<StateMachineOptions>

            Returns string

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.deepFreeze.html b/docs/functions/_runtime_util_object.deepFreeze.html index 4dd7d550..f3e53850 100644 --- a/docs/functions/_runtime_util_object.deepFreeze.html +++ b/docs/functions/_runtime_util_object.deepFreeze.html @@ -1,5 +1,6 @@ -deepFreeze | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function deepFreeze

          • deepFreeze(data, skipFreezeKeys?): object | []

          • Freezes all entries traversed that are objects including entries in arrays.

            +deepFreeze | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function deepFreeze

            • deepFreeze(data, skipFreezeKeys?): object | []

            • Freezes all entries traversed that are objects including entries in arrays.

              Parameters

              • data: object | []

                An object or array.

                -
              • Optional skipFreezeKeys: Set<string>

                A Set of strings indicating keys of objects to not freeze.

                +
              • OptionalskipFreezeKeys: Set<string>

                A Set of strings indicating keys of objects to not freeze.

              Returns object | []

              The frozen object.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.deepMerge.html b/docs/functions/_runtime_util_object.deepMerge.html index 5768ae7d..e5dcbae3 100644 --- a/docs/functions/_runtime_util_object.deepMerge.html +++ b/docs/functions/_runtime_util_object.deepMerge.html @@ -1,7 +1,8 @@ -deepMerge | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function deepMerge

          • deepMerge(target?, ...sourceObj): object

          • Recursively deep merges all source objects into the target object in place. Like Object.assign if you provide {} +deepMerge | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function deepMerge

            • deepMerge(target?, ...sourceObj): object

            • Recursively deep merges all source objects into the target object in place. Like Object.assign if you provide {} as the target a copy is produced. If the target and source property are object literals they are merged. Deleting keys is supported by specifying a property starting with -=.

              -

              Parameters

              • Optional target: object

                Target object.

                -
              • Rest ...sourceObj: object[]

                One or more source objects.

                +

                Parameters

                • Optionaltarget: object

                  Target object.

                  +
                • Rest...sourceObj: object[]

                  One or more source objects.

                Returns object

                Target object.

                -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.depthTraverse.html b/docs/functions/_runtime_util_object.depthTraverse.html index 9fedf287..d9d8e7f3 100644 --- a/docs/functions/_runtime_util_object.depthTraverse.html +++ b/docs/functions/_runtime_util_object.depthTraverse.html @@ -1,8 +1,9 @@ -depthTraverse | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function depthTraverse

          • depthTraverse(data, func, modify?): object | []

          • Performs a naive depth traversal of an object / array. The data structure must not have circular references. +depthTraverse | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function depthTraverse

            • depthTraverse(data, func, modify?): object | []

            • Performs a naive depth traversal of an object / array. The data structure must not have circular references. The result of the callback function is used to modify in place the given data.

              Parameters

              • data: object | []

                An object or array.

              • func: Function

                A callback function to process leaf values in children arrays or object members.

                -
              • Optional modify: boolean

                If true then the result of the callback function is used to modify in place - the given data.

                +
              • Optionalmodify: boolean

                If true then the result of the callback function is used to modify in place +the given data.

              Returns object | []

              The data object.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.getAccessorList.html b/docs/functions/_runtime_util_object.getAccessorList.html index 0a34d98d..901ae2a8 100644 --- a/docs/functions/_runtime_util_object.getAccessorList.html +++ b/docs/functions/_runtime_util_object.getAccessorList.html @@ -1,4 +1,5 @@ -getAccessorList | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function getAccessorList

          • getAccessorList(data): string[]

          • Returns a list of accessor keys by traversing the given object.

            +getAccessorList | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function getAccessorList

            • getAccessorList(data): string[]

            • Returns a list of accessor keys by traversing the given object.

              Parameters

              • data: object

                An object to traverse for accessor keys.

              Returns string[]

              Accessor list.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.hasAccessor.html b/docs/functions/_runtime_util_object.hasAccessor.html index c18b2b53..16909bf3 100644 --- a/docs/functions/_runtime_util_object.hasAccessor.html +++ b/docs/functions/_runtime_util_object.hasAccessor.html @@ -1,5 +1,6 @@ -hasAccessor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function hasAccessor

          • hasAccessor(object, accessor): boolean

          • Provides a method to determine if the passed in Svelte component has a getter & setter accessor.

            +hasAccessor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function hasAccessor

            • hasAccessor(object, accessor): boolean

            • Provides a method to determine if the passed in Svelte component has a getter & setter accessor.

              Parameters

              • object: object

                An object.

              • accessor: string

                Accessor to test.

              Returns boolean

              Whether the component has the getter and setter for accessor.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.hasGetter.html b/docs/functions/_runtime_util_object.hasGetter.html index 35000a20..11f9751f 100644 --- a/docs/functions/_runtime_util_object.hasGetter.html +++ b/docs/functions/_runtime_util_object.hasGetter.html @@ -1,5 +1,6 @@ -hasGetter | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function hasGetter

          • hasGetter(object, accessor): boolean

          • Provides a method to determine if the passed in Svelte component has a getter accessor.

            +hasGetter | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function hasGetter

            • hasGetter(object, accessor): boolean

            • Provides a method to determine if the passed in Svelte component has a getter accessor.

              Parameters

              • object: object

                An object.

              • accessor: string

                Accessor to test.

              Returns boolean

              Whether the component has the getter for accessor.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.hasPrototype.html b/docs/functions/_runtime_util_object.hasPrototype.html index 09ec8ed1..10cf6ca6 100644 --- a/docs/functions/_runtime_util_object.hasPrototype.html +++ b/docs/functions/_runtime_util_object.hasPrototype.html @@ -1,5 +1,6 @@ -hasPrototype | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function hasPrototype

          • hasPrototype(target, Prototype): boolean

          • Returns whether the target is or has the given prototype walking up the prototype chain.

            +hasPrototype | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function hasPrototype

            • hasPrototype(target, Prototype): boolean

            • Returns whether the target is or has the given prototype walking up the prototype chain.

              Parameters

              • target: unknown

                Any target to test.

                -
              • Prototype: (new (...args) => any)

                Prototype function / class constructor to find.

                -
                  • new (...args): any

                  • Parameters

                    • Rest ...args: any[]

                    Returns any

              Returns boolean

              Target matches prototype.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +
          • Prototype: (new (...args: any[]) => any)

            Prototype function / class constructor to find.

            +
              • new (...args): any

              • Parameters

                • Rest...args: any[]

                Returns any

          Returns boolean

          Target matches prototype.

          +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.hasSetter.html b/docs/functions/_runtime_util_object.hasSetter.html index 3694a2b0..42cf4e95 100644 --- a/docs/functions/_runtime_util_object.hasSetter.html +++ b/docs/functions/_runtime_util_object.hasSetter.html @@ -1,5 +1,6 @@ -hasSetter | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function hasSetter

          • hasSetter(object, accessor): boolean

          • Provides a method to determine if the passed in Svelte component has a setter accessor.

            +hasSetter | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function hasSetter

            • hasSetter(object, accessor): boolean

            • Provides a method to determine if the passed in Svelte component has a setter accessor.

              Parameters

              • object: object

                An object.

              • accessor: string

                Accessor to test.

              Returns boolean

              Whether the component has the setter for accessor.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.isAsyncIterable.html b/docs/functions/_runtime_util_object.isAsyncIterable.html index 591e7d5f..1cc17830 100644 --- a/docs/functions/_runtime_util_object.isAsyncIterable.html +++ b/docs/functions/_runtime_util_object.isAsyncIterable.html @@ -1,4 +1,5 @@ -isAsyncIterable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isAsyncIterable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.isIterable.html b/docs/functions/_runtime_util_object.isIterable.html index 552b47e9..ab4a3412 100644 --- a/docs/functions/_runtime_util_object.isIterable.html +++ b/docs/functions/_runtime_util_object.isIterable.html @@ -1,4 +1,5 @@ -isIterable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isIterable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.isObject.html b/docs/functions/_runtime_util_object.isObject.html index 04fa2d50..153adbbe 100644 --- a/docs/functions/_runtime_util_object.isObject.html +++ b/docs/functions/_runtime_util_object.isObject.html @@ -1,4 +1,5 @@ -isObject | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isObject

          • isObject(value): value is Record<string, unknown>

          • Tests for whether object is not null, typeof object, and not an array.

            +isObject | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function isObject

            • isObject(value): value is Record<string, unknown>

            • Tests for whether object is not null, typeof object, and not an array.

              Parameters

              • value: unknown

                Any value.

              Returns value is Record<string, unknown>

              Is it an object.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.isPlainObject.html b/docs/functions/_runtime_util_object.isPlainObject.html index 2e4ea6d0..6551a594 100644 --- a/docs/functions/_runtime_util_object.isPlainObject.html +++ b/docs/functions/_runtime_util_object.isPlainObject.html @@ -1,5 +1,6 @@ -isPlainObject | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isPlainObject

          • isPlainObject(value): value is JSONObject

          • Tests for whether the given value is a plain object.

            +isPlainObject | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function isPlainObject

            • isPlainObject(value): value is JSONObject

            • Tests for whether the given value is a plain object.

              An object is plain if it is created by either: {}, new Object() or Object.create(null).

              Parameters

              • value: unknown

                Any value

              Returns value is JSONObject

              Is it a plain object.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.klona.html b/docs/functions/_runtime_util_object.klona.html index 54a88775..0a3f62ec 100644 --- a/docs/functions/_runtime_util_object.klona.html +++ b/docs/functions/_runtime_util_object.klona.html @@ -1 +1,2 @@ -klona | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function klona

          • klona<T>(input): T

          • Type Parameters

            • T

            Parameters

            • input: T

            Returns T

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +klona | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function klona

          • klona<T>(input): T

          • Type Parameters

            • T

            Parameters

            • input: T

            Returns T

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.objectKeys.html b/docs/functions/_runtime_util_object.objectKeys.html index 393a7eec..93ba9306 100644 --- a/docs/functions/_runtime_util_object.objectKeys.html +++ b/docs/functions/_runtime_util_object.objectKeys.html @@ -1,4 +1,5 @@ -objectKeys | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function objectKeys

          • objectKeys(object): string[]

          • Safely returns keys on an object or an empty array if not an object.

            +objectKeys | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function objectKeys

            • objectKeys(object): string[]

            • Safely returns keys on an object or an empty array if not an object.

              Parameters

              • object: object

                An object.

              Returns string[]

              Object keys or empty array.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.objectSize.html b/docs/functions/_runtime_util_object.objectSize.html index 018a75d3..a1c1d841 100644 --- a/docs/functions/_runtime_util_object.objectSize.html +++ b/docs/functions/_runtime_util_object.objectSize.html @@ -1,4 +1,5 @@ -objectSize | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function objectSize

          • objectSize(object): any

          • Safely returns an objects size. Note for String objects unicode is not taken into consideration.

            +objectSize | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function objectSize

            • objectSize(object): any

            • Safely returns an objects size. Note for String objects unicode is not taken into consideration.

              Parameters

              • object: any

                Any value, but size returned for object / Map / Set / arrays / strings.

              Returns any

              Size of object.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.safeAccess.html b/docs/functions/_runtime_util_object.safeAccess.html index 8684466f..eaae1d6c 100644 --- a/docs/functions/_runtime_util_object.safeAccess.html +++ b/docs/functions/_runtime_util_object.safeAccess.html @@ -1,8 +1,9 @@ -safeAccess | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function safeAccess

          • safeAccess(data, accessor, defaultValue?): any

          • Provides a way to safely access an objects data / entries given an accessor string which describes the +safeAccess | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function safeAccess

            • safeAccess(data, accessor, defaultValue?): any

            • Provides a way to safely access an objects data / entries given an accessor string which describes the entries to walk. To access deeper entries into the object format the accessor string with . between entries to walk.

              Parameters

              • data: object

                An object to access entry data.

              • accessor: string

                A string describing the entries to access with keys separated by ..

                -
              • Optional defaultValue: any

                (Optional) A default value to return if an entry for accessor is not found.

                +
              • OptionaldefaultValue: any

                (Optional) A default value to return if an entry for accessor is not found.

              Returns any

              The data object.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.safeBatchSet.html b/docs/functions/_runtime_util_object.safeBatchSet.html index 7426831c..dfbc9d60 100644 --- a/docs/functions/_runtime_util_object.safeBatchSet.html +++ b/docs/functions/_runtime_util_object.safeBatchSet.html @@ -1,4 +1,5 @@ -safeBatchSet | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function safeBatchSet

          • safeBatchSet(data, accessors, value, operation?, defaultAccessValue?, createMissing?): void

          • Provides a way to safely batch set an objects data / entries given an array of accessor strings which describe the +safeBatchSet | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function safeBatchSet

            • safeBatchSet(data, accessors, value, operation?, defaultAccessValue?, createMissing?): void

            • Provides a way to safely batch set an objects data / entries given an array of accessor strings which describe the entries to walk. To access deeper entries into the object format the accessor string with . between entries to walk. If value is an object the accessor will be used to access a target value from value which is subsequently set to data by the given operation. If value is not an object it will be used as the target @@ -6,8 +7,8 @@

              Parameters

              • data: object

                An object to access entry data.

              • accessors: string[]

                A string describing the entries to access.

              • value: any

                A new value to set if an entry for accessor is found.

                -
              • Optional operation: SafeSetOperation

                Operation to perform including: 'add', 'div', 'mult', 'set', - 'set-undefined', 'sub'.

                -
              • Optional defaultAccessValue: any

                A new value to set if an entry for accessor is found.

                -
              • Optional createMissing: boolean

                If true missing accessor entries will be created as objects automatically.

                -

              Returns void

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +
          • Optionaloperation: SafeSetOperation

            Operation to perform including: 'add', 'div', 'mult', 'set', +'set-undefined', 'sub'.

            +
          • OptionaldefaultAccessValue: any

            A new value to set if an entry for accessor is found.

            +
          • OptionalcreateMissing: boolean

            If true missing accessor entries will be created as objects automatically.

            +

          Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.safeEqual.html b/docs/functions/_runtime_util_object.safeEqual.html index 6396379f..e1ec3d09 100644 --- a/docs/functions/_runtime_util_object.safeEqual.html +++ b/docs/functions/_runtime_util_object.safeEqual.html @@ -1,7 +1,8 @@ -safeEqual | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function safeEqual

          • safeEqual(source, target): boolean

          • Compares a source object and values of entries against a target object. If the entries in the source object match +safeEqual | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function safeEqual

            • safeEqual(source, target): boolean

            • Compares a source object and values of entries against a target object. If the entries in the source object match the target object then true is returned otherwise false. If either object is undefined or null then false is returned.

              Parameters

              • source: object

                Source object.

              • target: object

                Target object.

              Returns boolean

              True if equal.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.safeSet.html b/docs/functions/_runtime_util_object.safeSet.html index 540b0cef..9df8e372 100644 --- a/docs/functions/_runtime_util_object.safeSet.html +++ b/docs/functions/_runtime_util_object.safeSet.html @@ -1,12 +1,13 @@ -safeSet | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function safeSet

          • safeSet(data, accessor, value, operation?, createMissing?): boolean

          • Provides a way to safely set an objects data / entries given an accessor string which describes the +safeSet | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function safeSet

            • safeSet(data, accessor, value, operation?, createMissing?): boolean

            • Provides a way to safely set an objects data / entries given an accessor string which describes the entries to walk. To access deeper entries into the object format the accessor string with . between entries to walk.

              Parameters

              • data: object

                An object to access entry data.

              • accessor: string

                A string describing the entries to access.

              • value: any

                A new value to set if an entry for accessor is found.

                -
              • Optional operation: SafeSetOperation

                Operation to perform including: 'add', 'div', 'mult', 'set', - 'set-undefined', 'sub'.

                -
              • Optional createMissing: boolean

                If true missing accessor entries will be created as objects - automatically.

                +
              • Optionaloperation: SafeSetOperation

                Operation to perform including: 'add', 'div', 'mult', 'set', +'set-undefined', 'sub'.

                +
              • OptionalcreateMissing: boolean

                If true missing accessor entries will be created as objects +automatically.

              Returns boolean

              True if successful.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.safeSetAll.html b/docs/functions/_runtime_util_object.safeSetAll.html index cc8298f0..7ada8cdd 100644 --- a/docs/functions/_runtime_util_object.safeSetAll.html +++ b/docs/functions/_runtime_util_object.safeSetAll.html @@ -1,8 +1,9 @@ -safeSetAll | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function safeSetAll

          • safeSetAll(data, accessorValues, operation?, createMissing?): void

          • Performs bulk setting of values to the given data object.

            +safeSetAll | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function safeSetAll

            • safeSetAll(data, accessorValues, operation?, createMissing?): void

            • Performs bulk setting of values to the given data object.

              Parameters

              • data: object

                The data object to set data.

              • accessorValues: Record<string, any>

                Object of accessor keys to values to set.

                -
              • Optional operation: SafeSetOperation

                Operation to perform including: 'add', 'div', 'mult', 'set', 'sub'; - default (set).

                -
              • Optional createMissing: boolean

                If true missing accessor entries will be created as objects - automatically.

                -

              Returns void

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +
          • Optionaloperation: SafeSetOperation

            Operation to perform including: 'add', 'div', 'mult', 'set', 'sub'; +default (set).

            +
          • OptionalcreateMissing: boolean

            If true missing accessor entries will be created as objects +automatically.

            +

          Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.validate.html b/docs/functions/_runtime_util_object.validate.html index de439d63..89a177a2 100644 --- a/docs/functions/_runtime_util_object.validate.html +++ b/docs/functions/_runtime_util_object.validate.html @@ -1,6 +1,7 @@ -validate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function validate

          • validate(data, validationData?, dataName?): any

          • Performs bulk validation of data given an object, validationData, which describes all entries to test.

            +validate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function validate

            • validate(data, validationData?, dataName?): any

            • Performs bulk validation of data given an object, validationData, which describes all entries to test.

              Parameters

              • data: object

                The data object to test.

                -
              • Optional validationData: Record<string, ValidationEntry>

                Key is the accessor / value is a validation entry.

                -
              • Optional dataName: string

                Optional name of data.

                +
              • OptionalvalidationData: Record<string, ValidationEntry>

                Key is the accessor / value is a validation entry.

                +
              • OptionaldataName: string

                Optional name of data.

              Returns any

              True if validation passes otherwise an exception is thrown.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.validateArray.html b/docs/functions/_runtime_util_object.validateArray.html index fc3551ed..d522c273 100644 --- a/docs/functions/_runtime_util_object.validateArray.html +++ b/docs/functions/_runtime_util_object.validateArray.html @@ -1,7 +1,8 @@ -validateArray | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function validateArray

          • validateArray(data, accessor, entry, dataName?): boolean

          • Validates all array entries against potential type and expected tests.

            +validateArray | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function validateArray

            • validateArray(data, accessor, entry, dataName?): boolean

            • Validates all array entries against potential type and expected tests.

              Parameters

              • data: object

                The data object to test.

              • accessor: string

                A string describing the entries to access.

              • entry: ValidationEntry

                Validation entry object

                -
              • Optional dataName: string

                Optional name of data.

                +
              • OptionaldataName: string

                Optional name of data.

              Returns boolean

              True if validation passes otherwise an exception is thrown.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.validateEntry.html b/docs/functions/_runtime_util_object.validateEntry.html index 5440dbe4..8468d8a1 100644 --- a/docs/functions/_runtime_util_object.validateEntry.html +++ b/docs/functions/_runtime_util_object.validateEntry.html @@ -1,7 +1,8 @@ -validateEntry | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function validateEntry

          • validateEntry(data, accessor, entry, dataName?): boolean

          • Validates data entry with a typeof check and potentially tests against the values in any given expected set.

            +validateEntry | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function validateEntry

            • validateEntry(data, accessor, entry, dataName?): boolean

            • Validates data entry with a typeof check and potentially tests against the values in any given expected set.

              Parameters

              • data: object

                The object data to validate.

              • accessor: string

                A string describing the entries to access.

              • entry: ValidationEntry

                Validation entry.

                -
              • Optional dataName: string

                Optional name of data.

                +
              • OptionaldataName: string

                Optional name of data.

              Returns boolean

              True if validation passes otherwise an exception is thrown.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_object.validateEntryOrArray.html b/docs/functions/_runtime_util_object.validateEntryOrArray.html index 972b06d0..a6581e39 100644 --- a/docs/functions/_runtime_util_object.validateEntryOrArray.html +++ b/docs/functions/_runtime_util_object.validateEntryOrArray.html @@ -1,7 +1,8 @@ -validateEntryOrArray | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function validateEntryOrArray

          • validateEntryOrArray(data, accessor, entry?, dataName?): any

          • Dispatches validation of data entry to string or array validation depending on data entry type.

            +validateEntryOrArray | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Function validateEntryOrArray

            • validateEntryOrArray(data, accessor, entry?, dataName?): any

            • Dispatches validation of data entry to string or array validation depending on data entry type.

              Parameters

              • data: object

                The data object to test.

              • accessor: string

                A string describing the entries to access.

                -
              • Optional entry: ValidationEntry

                A validation entry.

                -
              • Optional dataName: string

                Optional name of data.

                +
              • Optionalentry: ValidationEntry

                A validation entry.

                +
              • OptionaldataName: string

                Optional name of data.

              Returns any

              True if validation passes otherwise an exception is thrown.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_store.isReadableStore.html b/docs/functions/_runtime_util_store.isReadableStore.html index 56781119..f16e05f6 100644 --- a/docs/functions/_runtime_util_store.isReadableStore.html +++ b/docs/functions/_runtime_util_store.isReadableStore.html @@ -1,6 +1,7 @@ -isReadableStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isReadableStore

          • isReadableStore(store): boolean

          • Provides a basic test for a given variable to test if it has the shape of a readable store by having a subscribe +isReadableStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function isReadableStore

            • isReadableStore(store): boolean

            • Provides a basic test for a given variable to test if it has the shape of a readable store by having a subscribe function.

              Note: functions are also objects, so test that the variable might be a function w/ a subscribe function.

              Parameters

              • store: any

                variable to test that might be a store.

              Returns boolean

              Whether the variable tested has the shape of a store.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_store.isUpdatableStore.html b/docs/functions/_runtime_util_store.isUpdatableStore.html index 8922c7d4..03124e3c 100644 --- a/docs/functions/_runtime_util_store.isUpdatableStore.html +++ b/docs/functions/_runtime_util_store.isUpdatableStore.html @@ -1,6 +1,7 @@ -isUpdatableStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isUpdatableStore

          • isUpdatableStore(store): boolean

          • Provides a basic test for a given variable to test if it has the shape of a writable store by having a subscribe +isUpdatableStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function isUpdatableStore

            • isUpdatableStore(store): boolean

            • Provides a basic test for a given variable to test if it has the shape of a writable store by having a subscribe function and an update function.

              Note: functions are also objects, so test that the variable might be a function w/ a subscribe function.

              Parameters

              • store: any

                variable to test that might be a store.

              Returns boolean

              Whether the variable tested has the shape of a store.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_store.isWritableStore.html b/docs/functions/_runtime_util_store.isWritableStore.html index 4a488b8f..863577e0 100644 --- a/docs/functions/_runtime_util_store.isWritableStore.html +++ b/docs/functions/_runtime_util_store.isWritableStore.html @@ -1,6 +1,7 @@ -isWritableStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function isWritableStore

          • isWritableStore(store): boolean

          • Provides a basic test for a given variable to test if it has the shape of a writable store by having a subscribe +isWritableStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function isWritableStore

            • isWritableStore(store): boolean

            • Provides a basic test for a given variable to test if it has the shape of a writable store by having a subscribe set, and update functions.

              Note: functions are also objects, so test that the variable might be a function w/ subscribe & set functions.

              Parameters

              • store: any

                variable to test that might be a store.

              Returns boolean

              Whether the variable tested has the shape of a store.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_store.storeCallback.html b/docs/functions/_runtime_util_store.storeCallback.html index b42b4a3e..88d5f791 100644 --- a/docs/functions/_runtime_util_store.storeCallback.html +++ b/docs/functions/_runtime_util_store.storeCallback.html @@ -1,11 +1,12 @@ -storeCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function storeCallback

          • storeCallback<T>(store, setCallback): Writable<T>

          • Wraps a writable stores set method invoking a callback after the store is set. This allows hard coupled parent / +storeCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function storeCallback

            • storeCallback<T>(store, setCallback): Writable<T>

            • Wraps a writable stores set method invoking a callback after the store is set. This allows hard coupled parent / child relationships between stores to update directly without having to subscribe to the child store. This is a particular powerful pattern when the setCallback is a debounced function that syncs a parent store and / or serializes data.

              Note: Do consider carefully if this is an optimum solution; this is a quick implementation helper, but a better solution is properly managing store relationships through subscription.

              Type Parameters

              • T

              Parameters

              • store: Writable<T>

                A store to wrap.

                -
              • setCallback: ((store?, value?) => void)

                A callback to invoke after - store set.

                -
                  • (store?, value?): void

                  • Parameters

                    Returns void

              Returns Writable<T>

              Wrapped store.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +
          • setCallback: ((store?: Writable<T>, value?: T) => void)

            A callback to invoke after +store set.

            +
              • (store?, value?): void

              • Parameters

                Returns void

          Returns Writable<T>

          Wrapped store.

          +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_store.subscribeFirstRest.html b/docs/functions/_runtime_util_store.subscribeFirstRest.html index 58fe5baa..190d582e 100644 --- a/docs/functions/_runtime_util_store.subscribeFirstRest.html +++ b/docs/functions/_runtime_util_store.subscribeFirstRest.html @@ -1,7 +1,8 @@ -subscribeFirstRest | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function subscribeFirstRest

          • subscribeFirstRest(store, first, update): Unsubscriber

          • Subscribes to the given store with two update functions provided. The first function is invoked on the initial +subscribeFirstRest | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function subscribeFirstRest

            • subscribeFirstRest(store, first, update): Unsubscriber

            • Subscribes to the given store with two update functions provided. The first function is invoked on the initial subscription. All future updates are dispatched to the update function.

              Parameters

              • store: Readable<any> | Writable<any>

                Store to subscribe to...

              • first: any

                Function to receive first update.

              • update: any

                Function to receive future updates.

              Returns Unsubscriber

              Store unsubscribe function.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/_runtime_util_store.subscribeIgnoreFirst.html b/docs/functions/_runtime_util_store.subscribeIgnoreFirst.html index 56ba4a64..acbc9070 100644 --- a/docs/functions/_runtime_util_store.subscribeIgnoreFirst.html +++ b/docs/functions/_runtime_util_store.subscribeIgnoreFirst.html @@ -1,6 +1,7 @@ -subscribeIgnoreFirst | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function subscribeIgnoreFirst

          • subscribeIgnoreFirst(store, update): Unsubscriber

          • Subscribes to the given store with the update function provided and ignores the first automatic +subscribeIgnoreFirst | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function subscribeIgnoreFirst

            • subscribeIgnoreFirst(store, update): Unsubscriber

            • Subscribes to the given store with the update function provided and ignores the first automatic update. All future updates are dispatched to the update function.

              Parameters

              • store: Readable<any> | Writable<any>

                Store to subscribe to...

              • update: any

                function to receive future updates.

              Returns Unsubscriber

              Store unsubscribe function.

              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.afterUpdate.html b/docs/functions/svelte.afterUpdate.html index 2eb5abf1..1dfd0e50 100644 --- a/docs/functions/svelte.afterUpdate.html +++ b/docs/functions/svelte.afterUpdate.html @@ -1,4 +1,5 @@ -afterUpdate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function afterUpdate

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.beforeUpdate.html b/docs/functions/svelte.beforeUpdate.html index 7f729b63..791cf041 100644 --- a/docs/functions/svelte.beforeUpdate.html +++ b/docs/functions/svelte.beforeUpdate.html @@ -1,4 +1,5 @@ -beforeUpdate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function beforeUpdate

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.createEventDispatcher.html b/docs/functions/svelte.createEventDispatcher.html index 8319fdf6..5ad7ccde 100644 --- a/docs/functions/svelte.createEventDispatcher.html +++ b/docs/functions/svelte.createEventDispatcher.html @@ -1,12 +1,14 @@ -createEventDispatcher | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function createEventDispatcher

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.getAllContexts.html b/docs/functions/svelte.getAllContexts.html index 034435b7..7c6d6678 100644 --- a/docs/functions/svelte.getAllContexts.html +++ b/docs/functions/svelte.getAllContexts.html @@ -1,5 +1,6 @@ -getAllContexts | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function getAllContexts

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.getContext.html b/docs/functions/svelte.getContext.html index 8b4c5c94..3ee93a70 100644 --- a/docs/functions/svelte.getContext.html +++ b/docs/functions/svelte.getContext.html @@ -1,4 +1,5 @@ -getContext | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function getContext

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.hasContext.html b/docs/functions/svelte.hasContext.html index b5a8ce76..e2fa63fc 100644 --- a/docs/functions/svelte.hasContext.html +++ b/docs/functions/svelte.hasContext.html @@ -1,4 +1,5 @@ -hasContext | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function hasContext

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.onDestroy.html b/docs/functions/svelte.onDestroy.html index 568501a8..9f4aad97 100644 --- a/docs/functions/svelte.onDestroy.html +++ b/docs/functions/svelte.onDestroy.html @@ -1,5 +1,6 @@ -onDestroy | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function onDestroy

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.onMount.html b/docs/functions/svelte.onMount.html index ecbc80e6..fc8c4c84 100644 --- a/docs/functions/svelte.onMount.html +++ b/docs/functions/svelte.onMount.html @@ -1,7 +1,8 @@ -onMount | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function onMount

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.setContext.html b/docs/functions/svelte.setContext.html index b638c53c..214fb444 100644 --- a/docs/functions/svelte.setContext.html +++ b/docs/functions/svelte.setContext.html @@ -1,6 +1,7 @@ -setContext | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function setContext

          • setContext<T>(key, context): T

          • Associates an arbitrary context object with the current component and the specified key +setContext | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Function setContext

            • setContext<T>(key, context): T

            • Associates an arbitrary context object with the current component and the specified key and returns that object. The context is then available to children of the component (including slotted content) with getContext.

              Like lifecycle functions, this must be called during component initialisation.

              -

              https://svelte.dev/docs/svelte#setcontext

              -

              Type Parameters

              • T

              Parameters

              • key: any
              • context: T

              Returns T

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            https://svelte.dev/docs/svelte#setcontext

            +

            Type Parameters

            • T

            Parameters

            • key: any
            • context: T

            Returns T

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte.tick.html b/docs/functions/svelte.tick.html index d1a9b5f7..12c80835 100644 --- a/docs/functions/svelte.tick.html +++ b/docs/functions/svelte.tick.html @@ -1 +1,2 @@ -tick | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function tick

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +tick | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function tick

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_animate.flip.html b/docs/functions/svelte_animate.flip.html index 594db7a4..8a7d5816 100644 --- a/docs/functions/svelte_animate.flip.html +++ b/docs/functions/svelte_animate.flip.html @@ -1,4 +1,5 @@ -flip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function flip

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +flip | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function flip

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.backIn.html b/docs/functions/svelte_easing.backIn.html index 3a503671..0ae9f099 100644 --- a/docs/functions/svelte_easing.backIn.html +++ b/docs/functions/svelte_easing.backIn.html @@ -1,2 +1,3 @@ -backIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function backIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +backIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function backIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.backInOut.html b/docs/functions/svelte_easing.backInOut.html index 0a024ce0..091f955a 100644 --- a/docs/functions/svelte_easing.backInOut.html +++ b/docs/functions/svelte_easing.backInOut.html @@ -1,2 +1,3 @@ -backInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function backInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +backInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function backInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.backOut.html b/docs/functions/svelte_easing.backOut.html index a089ab4f..9b5151b9 100644 --- a/docs/functions/svelte_easing.backOut.html +++ b/docs/functions/svelte_easing.backOut.html @@ -1,2 +1,3 @@ -backOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function backOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +backOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function backOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.bounceIn.html b/docs/functions/svelte_easing.bounceIn.html index ac5eec91..7a2e900d 100644 --- a/docs/functions/svelte_easing.bounceIn.html +++ b/docs/functions/svelte_easing.bounceIn.html @@ -1,2 +1,3 @@ -bounceIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function bounceIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +bounceIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function bounceIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.bounceInOut.html b/docs/functions/svelte_easing.bounceInOut.html index 690d4321..3e92cdbf 100644 --- a/docs/functions/svelte_easing.bounceInOut.html +++ b/docs/functions/svelte_easing.bounceInOut.html @@ -1,2 +1,3 @@ -bounceInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function bounceInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +bounceInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function bounceInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.bounceOut.html b/docs/functions/svelte_easing.bounceOut.html index 2d5aefbb..e9e357a7 100644 --- a/docs/functions/svelte_easing.bounceOut.html +++ b/docs/functions/svelte_easing.bounceOut.html @@ -1,2 +1,3 @@ -bounceOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function bounceOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +bounceOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function bounceOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.circIn.html b/docs/functions/svelte_easing.circIn.html index ca54fa98..70c50105 100644 --- a/docs/functions/svelte_easing.circIn.html +++ b/docs/functions/svelte_easing.circIn.html @@ -1,2 +1,3 @@ -circIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function circIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +circIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function circIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.circInOut.html b/docs/functions/svelte_easing.circInOut.html index 919342b8..f4acec06 100644 --- a/docs/functions/svelte_easing.circInOut.html +++ b/docs/functions/svelte_easing.circInOut.html @@ -1,2 +1,3 @@ -circInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function circInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +circInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function circInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.circOut.html b/docs/functions/svelte_easing.circOut.html index c0a564ba..8fe8b922 100644 --- a/docs/functions/svelte_easing.circOut.html +++ b/docs/functions/svelte_easing.circOut.html @@ -1,2 +1,3 @@ -circOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function circOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +circOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function circOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.cubicIn.html b/docs/functions/svelte_easing.cubicIn.html index 03fc1ebf..836976e5 100644 --- a/docs/functions/svelte_easing.cubicIn.html +++ b/docs/functions/svelte_easing.cubicIn.html @@ -1,2 +1,3 @@ -cubicIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function cubicIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +cubicIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function cubicIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.cubicInOut.html b/docs/functions/svelte_easing.cubicInOut.html index 5c0cad9a..cdea2ef6 100644 --- a/docs/functions/svelte_easing.cubicInOut.html +++ b/docs/functions/svelte_easing.cubicInOut.html @@ -1,2 +1,3 @@ -cubicInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function cubicInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +cubicInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function cubicInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.cubicOut.html b/docs/functions/svelte_easing.cubicOut.html index 27c96ec8..e373e14b 100644 --- a/docs/functions/svelte_easing.cubicOut.html +++ b/docs/functions/svelte_easing.cubicOut.html @@ -1,2 +1,3 @@ -cubicOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function cubicOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +cubicOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function cubicOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.elasticIn.html b/docs/functions/svelte_easing.elasticIn.html index bce618c1..47e00839 100644 --- a/docs/functions/svelte_easing.elasticIn.html +++ b/docs/functions/svelte_easing.elasticIn.html @@ -1,2 +1,3 @@ -elasticIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function elasticIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +elasticIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function elasticIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.elasticInOut.html b/docs/functions/svelte_easing.elasticInOut.html index d67ee0ce..1a9833ca 100644 --- a/docs/functions/svelte_easing.elasticInOut.html +++ b/docs/functions/svelte_easing.elasticInOut.html @@ -1,2 +1,3 @@ -elasticInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function elasticInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +elasticInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function elasticInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.elasticOut.html b/docs/functions/svelte_easing.elasticOut.html index 1c248d48..458aac5b 100644 --- a/docs/functions/svelte_easing.elasticOut.html +++ b/docs/functions/svelte_easing.elasticOut.html @@ -1,2 +1,3 @@ -elasticOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function elasticOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +elasticOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function elasticOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.expoIn.html b/docs/functions/svelte_easing.expoIn.html index 653e37c6..4c3b5c17 100644 --- a/docs/functions/svelte_easing.expoIn.html +++ b/docs/functions/svelte_easing.expoIn.html @@ -1,2 +1,3 @@ -expoIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function expoIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +expoIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function expoIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.expoInOut.html b/docs/functions/svelte_easing.expoInOut.html index 86062906..1c72c490 100644 --- a/docs/functions/svelte_easing.expoInOut.html +++ b/docs/functions/svelte_easing.expoInOut.html @@ -1,2 +1,3 @@ -expoInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function expoInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +expoInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function expoInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.expoOut.html b/docs/functions/svelte_easing.expoOut.html index ada99ffb..1f888ebc 100644 --- a/docs/functions/svelte_easing.expoOut.html +++ b/docs/functions/svelte_easing.expoOut.html @@ -1,2 +1,3 @@ -expoOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function expoOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +expoOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function expoOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.linear.html b/docs/functions/svelte_easing.linear.html index 0513c6c3..408cc555 100644 --- a/docs/functions/svelte_easing.linear.html +++ b/docs/functions/svelte_easing.linear.html @@ -1 +1,2 @@ -linear | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function linear

          • linear(x): any

          • Parameters

            • x: any

            Returns any

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +linear | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function linear

          • linear(x): any

          • Parameters

            • x: any

            Returns any

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.quadIn.html b/docs/functions/svelte_easing.quadIn.html index f4c65d9d..acd03edd 100644 --- a/docs/functions/svelte_easing.quadIn.html +++ b/docs/functions/svelte_easing.quadIn.html @@ -1,2 +1,3 @@ -quadIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function quadIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +quadIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function quadIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.quadInOut.html b/docs/functions/svelte_easing.quadInOut.html index 21d903f4..aac37edb 100644 --- a/docs/functions/svelte_easing.quadInOut.html +++ b/docs/functions/svelte_easing.quadInOut.html @@ -1,2 +1,3 @@ -quadInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function quadInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +quadInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function quadInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.quadOut.html b/docs/functions/svelte_easing.quadOut.html index 86feba18..cb51a0e4 100644 --- a/docs/functions/svelte_easing.quadOut.html +++ b/docs/functions/svelte_easing.quadOut.html @@ -1,2 +1,3 @@ -quadOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function quadOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +quadOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function quadOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.quartIn.html b/docs/functions/svelte_easing.quartIn.html index 95843e65..873347dc 100644 --- a/docs/functions/svelte_easing.quartIn.html +++ b/docs/functions/svelte_easing.quartIn.html @@ -1,2 +1,3 @@ -quartIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function quartIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +quartIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function quartIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.quartInOut.html b/docs/functions/svelte_easing.quartInOut.html index 1f617ceb..26f4762f 100644 --- a/docs/functions/svelte_easing.quartInOut.html +++ b/docs/functions/svelte_easing.quartInOut.html @@ -1,2 +1,3 @@ -quartInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function quartInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +quartInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function quartInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.quartOut.html b/docs/functions/svelte_easing.quartOut.html index 84d8614f..5b7d903e 100644 --- a/docs/functions/svelte_easing.quartOut.html +++ b/docs/functions/svelte_easing.quartOut.html @@ -1,2 +1,3 @@ -quartOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function quartOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +quartOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function quartOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.quintIn.html b/docs/functions/svelte_easing.quintIn.html index 0b80f894..f1c53b39 100644 --- a/docs/functions/svelte_easing.quintIn.html +++ b/docs/functions/svelte_easing.quintIn.html @@ -1,2 +1,3 @@ -quintIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function quintIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +quintIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function quintIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.quintInOut.html b/docs/functions/svelte_easing.quintInOut.html index 77993f0a..465ef294 100644 --- a/docs/functions/svelte_easing.quintInOut.html +++ b/docs/functions/svelte_easing.quintInOut.html @@ -1,2 +1,3 @@ -quintInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function quintInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +quintInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function quintInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.quintOut.html b/docs/functions/svelte_easing.quintOut.html index d39507db..8b4628be 100644 --- a/docs/functions/svelte_easing.quintOut.html +++ b/docs/functions/svelte_easing.quintOut.html @@ -1,2 +1,3 @@ -quintOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function quintOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +quintOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function quintOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.sineIn.html b/docs/functions/svelte_easing.sineIn.html index 8906f24c..925eb78d 100644 --- a/docs/functions/svelte_easing.sineIn.html +++ b/docs/functions/svelte_easing.sineIn.html @@ -1,2 +1,3 @@ -sineIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function sineIn

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +sineIn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function sineIn

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.sineInOut.html b/docs/functions/svelte_easing.sineInOut.html index 44df4ab5..41e4ad7a 100644 --- a/docs/functions/svelte_easing.sineInOut.html +++ b/docs/functions/svelte_easing.sineInOut.html @@ -1,2 +1,3 @@ -sineInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function sineInOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +sineInOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function sineInOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_easing.sineOut.html b/docs/functions/svelte_easing.sineOut.html index 6481500f..33298857 100644 --- a/docs/functions/svelte_easing.sineOut.html +++ b/docs/functions/svelte_easing.sineOut.html @@ -1,2 +1,3 @@ -sineOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function sineOut

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +sineOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function sineOut

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_motion.spring.html b/docs/functions/svelte_motion.spring.html index 02d94a2a..da0ad0d1 100644 --- a/docs/functions/svelte_motion.spring.html +++ b/docs/functions/svelte_motion.spring.html @@ -1,3 +1,4 @@ -spring | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function spring

          • spring<T>(value?, opts?): Spring<T>

          • The spring function in Svelte creates a store whose value is animated, with a motion that simulates the behavior of a spring. This means when the value changes, instead of transitioning at a steady rate, it "bounces" like a spring would, depending on the physics parameters provided. This adds a level of realism to the transitions and can enhance the user experience.

            -

            https://svelte.dev/docs/svelte-motion#spring

            -

            Type Parameters

            • T = any

            Parameters

            Returns Spring<T>

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +spring | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function spring

          • spring<T>(value?, opts?): Spring<T>

          • The spring function in Svelte creates a store whose value is animated, with a motion that simulates the behavior of a spring. This means when the value changes, instead of transitioning at a steady rate, it "bounces" like a spring would, depending on the physics parameters provided. This adds a level of realism to the transitions and can enhance the user experience.

            +

            https://svelte.dev/docs/svelte-motion#spring

            +

            Type Parameters

            • T = any

            Parameters

            Returns Spring<T>

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_motion.tweened.html b/docs/functions/svelte_motion.tweened.html index e3735da2..91416432 100644 --- a/docs/functions/svelte_motion.tweened.html +++ b/docs/functions/svelte_motion.tweened.html @@ -1,3 +1,4 @@ -tweened | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function tweened

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +tweened | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function tweened

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_store.derived.html b/docs/functions/svelte_store.derived.html index 185a9fd7..59211c00 100644 --- a/docs/functions/svelte_store.derived.html +++ b/docs/functions/svelte_store.derived.html @@ -1,7 +1,8 @@ -derived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function derived

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_store.get.html b/docs/functions/svelte_store.get.html index a1b5f618..b7b2c7dd 100644 --- a/docs/functions/svelte_store.get.html +++ b/docs/functions/svelte_store.get.html @@ -1,3 +1,4 @@ -get | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function get

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +get | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function get

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_store.readable.html b/docs/functions/svelte_store.readable.html index 017e1a1a..514cf153 100644 --- a/docs/functions/svelte_store.readable.html +++ b/docs/functions/svelte_store.readable.html @@ -1,4 +1,5 @@ -readable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function readable

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +readable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function readable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_store.readonly.html b/docs/functions/svelte_store.readonly.html index 2b303cbf..9d2287d4 100644 --- a/docs/functions/svelte_store.readonly.html +++ b/docs/functions/svelte_store.readonly.html @@ -1,4 +1,5 @@ -readonly | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function readonly

          Returns Readable<T>

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_store.writable.html b/docs/functions/svelte_store.writable.html index 575f19f1..305787d9 100644 --- a/docs/functions/svelte_store.writable.html +++ b/docs/functions/svelte_store.writable.html @@ -1,4 +1,5 @@ -writable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function writable

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +writable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function writable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_transition.blur.html b/docs/functions/svelte_transition.blur.html index ff6a49b0..2e0617b4 100644 --- a/docs/functions/svelte_transition.blur.html +++ b/docs/functions/svelte_transition.blur.html @@ -1,3 +1,4 @@ -blur | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function blur

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +blur | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function blur

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_transition.crossfade.html b/docs/functions/svelte_transition.crossfade.html index baad2d8f..aa378694 100644 --- a/docs/functions/svelte_transition.crossfade.html +++ b/docs/functions/svelte_transition.crossfade.html @@ -1,3 +1,4 @@ -crossfade | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function crossfade

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +crossfade | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function crossfade

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_transition.draw.html b/docs/functions/svelte_transition.draw.html index d51cfee9..087dc626 100644 --- a/docs/functions/svelte_transition.draw.html +++ b/docs/functions/svelte_transition.draw.html @@ -1,3 +1,4 @@ -draw | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function draw

          • draw(node, __namedParameters?): TransitionConfig

          • Animates the stroke of an SVG element, like a snake in a tube. in transitions begin with the path invisible and draw the path to the screen over time. out transitions start in a visible state and gradually erase the path. draw only works with elements that have a getTotalLength method, like <path> and <polyline>.

            -

            https://svelte.dev/docs/svelte-transition#draw

            -

            Parameters

            Returns TransitionConfig

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +draw | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function draw

          • draw(node, __namedParameters?): TransitionConfig

          • Animates the stroke of an SVG element, like a snake in a tube. in transitions begin with the path invisible and draw the path to the screen over time. out transitions start in a visible state and gradually erase the path. draw only works with elements that have a getTotalLength method, like <path> and <polyline>.

            +

            https://svelte.dev/docs/svelte-transition#draw

            +

            Parameters

            Returns TransitionConfig

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_transition.fade.html b/docs/functions/svelte_transition.fade.html index eba5e7fa..2dc6c36c 100644 --- a/docs/functions/svelte_transition.fade.html +++ b/docs/functions/svelte_transition.fade.html @@ -1,3 +1,4 @@ -fade | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function fade

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +fade | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function fade

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_transition.fly.html b/docs/functions/svelte_transition.fly.html index 191fb98a..bd0c2c05 100644 --- a/docs/functions/svelte_transition.fly.html +++ b/docs/functions/svelte_transition.fly.html @@ -1,3 +1,4 @@ -fly | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function fly

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +fly | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function fly

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_transition.scale.html b/docs/functions/svelte_transition.scale.html index fca7fcc9..7fe9eadd 100644 --- a/docs/functions/svelte_transition.scale.html +++ b/docs/functions/svelte_transition.scale.html @@ -1,3 +1,4 @@ -scale | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function scale

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +scale | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function scale

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/functions/svelte_transition.slide.html b/docs/functions/svelte_transition.slide.html index 20f91518..1bfe1ac6 100644 --- a/docs/functions/svelte_transition.slide.html +++ b/docs/functions/svelte_transition.slide.html @@ -1,3 +1,4 @@ -slide | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Function slide

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +slide | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Function slide

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index a731f8c3..222b32f8 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1 +1,2 @@ -TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class Hierarchy

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Class Hierarchy

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 7fd4f7c4..fa8a03e9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,13 +1,14 @@ -TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          The TyphonJS Runtime Library (TRL) is an integrated library and framework for creating modern Svelte powered packages -for the Foundry VTT platform; a TTRPG (table top role playing game) virtual table top.

          -

          There are many useful libraries and original code that is bundled together to provide a cohesive modern runtime library -for advanced package development. Some of the highlights are an optimized desktop like GUI framework, but there is much +TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          The TyphonJS Runtime Library (TRL) is an integrated library and framework for creating modern Svelte powered packages +for the Foundry VTT platform; a TTRPG (table top role playing game) virtual table top.

          +

          There are many useful libraries and original code that is bundled together to provide a cohesive modern runtime library +for advanced package development. Some of the highlights are an optimized desktop like GUI framework, but there is much more to explore as well.

          In the near future TRL will be available for open web app development on top of SvelteKit and Svelte in general.

          -

          I will be adding many examples to the TRL API docs in the coming months along with a forthcoming developer guide / -tutorial. At this present stage the API docs cover the entire ESM code and packages available. Documentation for the +

          I will be adding many examples to the TRL API docs in the coming months along with a forthcoming developer guide / +tutorial. At this present stage the API docs cover the entire ESM code and packages available. Documentation for the Svelte components contained in TRL is forthcoming.

          -

          The API docs are available here: https://typhonjs-fvtt-lib.github.io/api-docs

          +

          The API docs are available here: https://typhonjs-fvtt-lib.github.io/api-docs

          A demo package (requires Foundry VTT) is available here: -https://github.com/typhonjs-fvtt-demo

          -

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +https://github.com/typhonjs-fvtt-demo

          +

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_color_colord.LabColor.html b/docs/interfaces/_runtime_color_colord.LabColor.html index e8247f53..f39dae20 100644 --- a/docs/interfaces/_runtime_color_colord.LabColor.html +++ b/docs/interfaces/_runtime_color_colord.LabColor.html @@ -1,4 +1,5 @@ -LabColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface LabColor

          interface LabColor {
              a: number;
              b: number;
              l: number;
          }

          Properties

          a +LabColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface LabColor

          interface LabColor {
              a: number;
              b: number;
              l: number;
          }

          Properties

          a b l -

          Properties

          a

          a: number

          b

          b: number

          l

          l: number

          Settings

          Member Visibility

          Theme

          On This Page

          abl
          \ No newline at end of file +

          Properties

          a

          a: number

          b

          b: number

          l

          l: number

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_color_colord.LchColor.html b/docs/interfaces/_runtime_color_colord.LchColor.html index 03d8552a..22b7f9d1 100644 --- a/docs/interfaces/_runtime_color_colord.LchColor.html +++ b/docs/interfaces/_runtime_color_colord.LchColor.html @@ -1,4 +1,5 @@ -LchColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface LchColor

          interface LchColor {
              c: number;
              h: number;
              l: number;
          }

          Properties

          c +LchColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface LchColor

          interface LchColor {
              c: number;
              h: number;
              l: number;
          }

          Properties

          c h l -

          Properties

          c

          c: number

          h

          h: number

          l

          l: number

          Settings

          Member Visibility

          Theme

          On This Page

          chl
          \ No newline at end of file +

          Properties

          c

          c: number

          h

          h: number

          l

          l: number

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_color_colord.XyzColor.html b/docs/interfaces/_runtime_color_colord.XyzColor.html index 2f7761d4..5be75371 100644 --- a/docs/interfaces/_runtime_color_colord.XyzColor.html +++ b/docs/interfaces/_runtime_color_colord.XyzColor.html @@ -1,4 +1,5 @@ -XyzColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface XyzColor

          interface XyzColor {
              x: number;
              y: number;
              z: number;
          }

          Properties

          x +XyzColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface XyzColor

          interface XyzColor {
              x: number;
              y: number;
              z: number;
          }

          Properties

          x y z -

          Properties

          x

          x: number

          y

          y: number

          z

          z: number

          Settings

          Member Visibility

          Theme

          On This Page

          xyz
          \ No newline at end of file +

          Properties

          x

          x: number

          y

          y: number

          z

          z: number

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncDeflateOptions.html b/docs/interfaces/_runtime_data_compress.AsyncDeflateOptions.html index 20e3e536..15abef5d 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncDeflateOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncDeflateOptions.html @@ -1,16 +1,17 @@ -AsyncDeflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncDeflateOptions

          Options for compressing data asynchronously into a DEFLATE format

          -
          interface AsyncDeflateOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
              mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
          }

          Hierarchy (view full)

          Properties

          consume? +AsyncDeflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncDeflateOptions

          Options for compressing data asynchronously into a DEFLATE format

          +
          interface AsyncDeflateOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              level?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
              mem?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12;
          }

          Hierarchy (view full)

          Properties

          consume? dictionary? level? mem? -

          Properties

          Optional consume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in +

          Properties

          Optionalconsume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in unusable but will increase performance and reduce memory usage.

          -

          Optional dictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          +

          Optionaldictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          Dictionaries should be 32kB or smaller and include strings or byte sequences likely to appear in the input. The decompressor must supply the same dictionary as the compressor to extract the original data.

          Dictionaries only improve aggregate compression ratio when reused across multiple small inputs. They should typically not be used otherwise.

          Avoid using dictionaries with GZIP and ZIP to maximize software compatibility.

          -

          Optional level

          level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

          The level of compression to use, ranging from 0-9.

          +

          Optionallevel

          level?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9

          The level of compression to use, ranging from 0-9.

          0 will store the data without compression. 1 is fastest but compresses the worst, 9 is slowest but compresses the best. The default level is 6.

          @@ -22,9 +23,9 @@
        • become 400 kB with level 1 in 10ms
        • become 320 kB with level 9 in 100ms
          • -

          Optional mem

          mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          +

          Optionalmem

          mem?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9
              | 10
              | 11
              | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB. It is recommended not to lower the value below 4, since that tends to hurt performance. In addition, values above 8 tend to help very little on most data and can even hurt performance.

          The default value is automatically determined based on the size of the input data.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          consumedictionarylevelmem
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncGunzipOptions.html b/docs/interfaces/_runtime_data_compress.AsyncGunzipOptions.html index 67420e24..3838a41b 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncGunzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncGunzipOptions.html @@ -1,8 +1,9 @@ -AsyncGunzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncGunzipOptions

          Options for decompressing GZIP data asynchronously

          -
          interface AsyncGunzipOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          consume? +AsyncGunzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncGunzipOptions

          Options for decompressing GZIP data asynchronously

          +
          interface AsyncGunzipOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          consume? dictionary? -

          Properties

          Optional consume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in +

          Properties

          Optionalconsume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in unusable but will increase performance and reduce memory usage.

          -

          Optional dictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          +

          Optionaldictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          consumedictionary
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncGzipOptions.html b/docs/interfaces/_runtime_data_compress.AsyncGzipOptions.html index 3ce3229c..910f4f76 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncGzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncGzipOptions.html @@ -1,20 +1,21 @@ -AsyncGzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncGzipOptions

          Options for compressing data asynchronously into a GZIP format

          -
          interface AsyncGzipOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              filename?: string;
              level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
              mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
              mtime?: string | number | Date;
          }

          Hierarchy (view full)

          Properties

          consume? +AsyncGzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncGzipOptions

          Options for compressing data asynchronously into a GZIP format

          +
          interface AsyncGzipOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              filename?: string;
              level?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
              mem?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12;
              mtime?: string | number | Date;
          }

          Hierarchy (view full)

          Properties

          consume? dictionary? filename? level? mem? mtime? -

          Properties

          Optional consume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in +

          Properties

          Optionalconsume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in unusable but will increase performance and reduce memory usage.

          -

          Optional dictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          +

          Optionaldictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          Dictionaries should be 32kB or smaller and include strings or byte sequences likely to appear in the input. The decompressor must supply the same dictionary as the compressor to extract the original data.

          Dictionaries only improve aggregate compression ratio when reused across multiple small inputs. They should typically not be used otherwise.

          Avoid using dictionaries with GZIP and ZIP to maximize software compatibility.

          -

          Optional filename

          filename?: string

          The filename of the data. If the gunzip command is used to decompress the data, it will output a file +

          Optionalfilename

          filename?: string

          The filename of the data. If the gunzip command is used to decompress the data, it will output a file with this name instead of the name of the compressed file.

          -

          Optional level

          level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

          The level of compression to use, ranging from 0-9.

          +

          Optionallevel

          level?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9

          The level of compression to use, ranging from 0-9.

          0 will store the data without compression. 1 is fastest but compresses the worst, 9 is slowest but compresses the best. The default level is 6.

          @@ -26,11 +27,11 @@
        • become 400 kB with level 1 in 10ms
        • become 320 kB with level 9 in 100ms
          • -

          Optional mem

          mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          +

          Optionalmem

          mem?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9
              | 10
              | 11
              | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB. It is recommended not to lower the value below 4, since that tends to hurt performance. In addition, values above 8 tend to help very little on most data and can even hurt performance.

          The default value is automatically determined based on the size of the input data.

          -

          Optional mtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time. +

          Optionalmtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time. Set this to 0 to avoid revealing a modification date entirely.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          consumedictionaryfilenamelevelmemmtime
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncInflateOptions.html b/docs/interfaces/_runtime_data_compress.AsyncInflateOptions.html index 26c5c4c2..4c530260 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncInflateOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncInflateOptions.html @@ -1,12 +1,13 @@ -AsyncInflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncInflateOptions

          Options for decompressing DEFLATE data asynchronously

          -
          interface AsyncInflateOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              size?: number;
          }

          Hierarchy (view full)

          Properties

          consume? +AsyncInflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncInflateOptions

          Options for decompressing DEFLATE data asynchronously

          +
          interface AsyncInflateOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              size?: number;
          }

          Hierarchy (view full)

          Properties

          consume? dictionary? size? -

          Properties

          Optional consume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in +

          Properties

          Optionalconsume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in unusable but will increase performance and reduce memory usage.

          -

          Optional dictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          +

          Optionaldictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

          -

          Optional size

          size?: number

          The original size of the data. Currently, the asynchronous API disallows +

          Optionalsize

          size?: number

          The original size of the data. Currently, the asynchronous API disallows writing into a buffer you provide; the best you can do is provide the size in bytes and be given back a new typed array.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          consumedictionarysize
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncTerminable.html b/docs/interfaces/_runtime_data_compress.AsyncTerminable.html index 60ba840f..fc26bccc 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncTerminable.html +++ b/docs/interfaces/_runtime_data_compress.AsyncTerminable.html @@ -1,3 +1,4 @@ -AsyncTerminable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncTerminable

          A terminable compression/decompression process

          -
          interface AsyncTerminable (() => void)
          • AsyncTerminable(): void

          • Terminates the worker thread immediately. The callback will not be called.

            -

            Returns void

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +AsyncTerminable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncTerminable

          A terminable compression/decompression process

          +
          • AsyncTerminable(): void

          • Terminates the worker thread immediately. The callback will not be called.

            +

            Returns void

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncUnzipOptions.html b/docs/interfaces/_runtime_data_compress.AsyncUnzipOptions.html index ff590e70..61a5fc25 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncUnzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncUnzipOptions.html @@ -1,4 +1,5 @@ -AsyncUnzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncUnzipOptions

          Options for asynchronously expanding a ZIP archive

          -
          interface AsyncUnzipOptions {
              filter?: UnzipFileFilter;
          }

          Hierarchy (view full)

          Properties

          filter? -

          Properties

          Optional filter

          filter?: UnzipFileFilter

          A filter function to extract only certain files from a ZIP archive

          -

          Settings

          Member Visibility

          Theme

          On This Page

          filter
          \ No newline at end of file +AsyncUnzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncUnzipOptions

          Options for asynchronously expanding a ZIP archive

          +
          interface AsyncUnzipOptions {
              filter?: UnzipFileFilter;
          }

          Hierarchy (view full)

          Properties

          filter? +

          Properties

          Optionalfilter

          filter?: UnzipFileFilter

          A filter function to extract only certain files from a ZIP archive

          +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncUnzlibOptions.html b/docs/interfaces/_runtime_data_compress.AsyncUnzlibOptions.html index 2e01d2ca..3c940ebc 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncUnzlibOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncUnzlibOptions.html @@ -1,12 +1,13 @@ -AsyncUnzlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncUnzlibOptions

          Options for decompressing Zlib data asynchronously

          -
          interface AsyncUnzlibOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              size?: number;
          }

          Hierarchy (view full)

          Properties

          consume? +AsyncUnzlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncUnzlibOptions

          Options for decompressing Zlib data asynchronously

          +
          interface AsyncUnzlibOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              size?: number;
          }

          Hierarchy (view full)

          Properties

          consume? dictionary? size? -

          Properties

          Optional consume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in +

          Properties

          Optionalconsume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in unusable but will increase performance and reduce memory usage.

          -

          Optional dictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          +

          Optionaldictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

          -

          Optional size

          size?: number

          The original size of the data. Currently, the asynchronous API disallows +

          Optionalsize

          size?: number

          The original size of the data. Currently, the asynchronous API disallows writing into a buffer you provide; the best you can do is provide the size in bytes and be given back a new typed array.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          consumedictionarysize
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncZipOptions.html b/docs/interfaces/_runtime_data_compress.AsyncZipOptions.html index e39482de..cdd0e50b 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncZipOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncZipOptions.html @@ -1,5 +1,6 @@ -AsyncZipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncZipOptions

          Options for asynchronously creating a ZIP archive

          -
          interface AsyncZipOptions {
              attrs?: number;
              comment?: string;
              consume?: boolean;
              dictionary?: Uint8Array;
              extra?: Record<number, Uint8Array>;
              level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
              mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
              mtime?: string | number | Date;
              os?: number;
          }

          Hierarchy (view full)

          Properties

          attrs? +AsyncZipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncZipOptions

          Options for asynchronously creating a ZIP archive

          +
          interface AsyncZipOptions {
              attrs?: number;
              comment?: string;
              consume?: boolean;
              dictionary?: Uint8Array;
              extra?: Record<number, Uint8Array>;
              level?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
              mem?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12;
              mtime?: string | number | Date;
              os?: number;
          }

          Hierarchy (view full)

          Properties

          attrs? comment? consume? dictionary? @@ -8,7 +9,7 @@ mem? mtime? os? -

          Properties

          Optional attrs

          attrs?: number

          The file's attributes. These are traditionally somewhat complicated +

          Properties

          Optionalattrs

          attrs?: number

          The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, here is a representation of what this is, bit by bit:

          TTTTugtrwxrwxrwx0000000000ADVSHR

          @@ -20,22 +21,22 @@

          If you want to set the Unix permissions, for instance, just bit shift by 16, e.g. 0o644 << 16. Note that attributes usually only work in conjunction with the os setting: you must use os = 3 (Unix) if you want to set Unix permissions

          -

          Optional comment

          comment?: string

          The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, +

          Optionalcomment

          comment?: string

          The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.26. The comment must be at most 65,535 bytes long UTF-8 encoded. This field is not read by consumer software.

          -

          Optional consume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in +

          Optionalconsume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in unusable but will increase performance and reduce memory usage.

          -

          Optional dictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          +

          Optionaldictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          Dictionaries should be 32kB or smaller and include strings or byte sequences likely to appear in the input. The decompressor must supply the same dictionary as the compressor to extract the original data.

          Dictionaries only improve aggregate compression ratio when reused across multiple small inputs. They should typically not be used otherwise.

          Avoid using dictionaries with GZIP and ZIP to maximize software compatibility.

          -

          Optional extra

          extra?: Record<number, Uint8Array>

          Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, +

          Optionalextra

          extra?: Record<number, Uint8Array>

          Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.28. At most 65,535 bytes may be used in each ID. The ID must be an integer between 0 and 65,535, inclusive.

          This field is incredibly rare and almost never needed except for compliance with proprietary standards and software.

          -

          Optional level

          level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

          The level of compression to use, ranging from 0-9.

          +

          Optionallevel

          level?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9

          The level of compression to use, ranging from 0-9.

          0 will store the data without compression. 1 is fastest but compresses the worst, 9 is slowest but compresses the best. The default level is 6.

          @@ -47,13 +48,13 @@
        • become 400 kB with level 1 in 10ms
        • become 320 kB with level 9 in 100ms
          • -

          Optional mem

          mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          +

          Optionalmem

          mem?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9
              | 10
              | 11
              | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB. It is recommended not to lower the value below 4, since that tends to hurt performance. In addition, values above 8 tend to help very little on most data and can even hurt performance.

          The default value is automatically determined based on the size of the input data.

          -

          Optional mtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time.

          -

          Optional os

          os?: number

          The operating system of origin for this file. The value is defined +

          Optionalmtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time.

          +

          Optionalos

          os?: number

          The operating system of origin for this file. The value is defined by PKZIP's APPNOTE.txt, section 4.4.2.2. For example, 0 (the default) is MS/DOS, 3 is Unix, 19 is macOS.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          attrscommentconsumedictionaryextralevelmemmtimeos
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncZippable.html b/docs/interfaces/_runtime_data_compress.AsyncZippable.html index 907b2a16..86aeccaa 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncZippable.html +++ b/docs/interfaces/_runtime_data_compress.AsyncZippable.html @@ -1,2 +1,3 @@ -AsyncZippable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncZippable

          The complete directory structure of an asynchronously ZIPpable archive

          -
          interface AsyncZippable {
              [path: string]: AsyncZippableFile;
          }

          Indexable

          [path: string]: AsyncZippableFile

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +AsyncZippable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncZippable

          The complete directory structure of an asynchronously ZIPpable archive

          +

          Indexable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.AsyncZlibOptions.html b/docs/interfaces/_runtime_data_compress.AsyncZlibOptions.html index 9d27439c..22aba745 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncZlibOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncZlibOptions.html @@ -1,16 +1,17 @@ -AsyncZlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface AsyncZlibOptions

          Options for compressing data asynchronously into a Zlib format

          -
          interface AsyncZlibOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
              mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
          }

          Hierarchy (view full)

          Properties

          consume? +AsyncZlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface AsyncZlibOptions

          Options for compressing data asynchronously into a Zlib format

          +
          interface AsyncZlibOptions {
              consume?: boolean;
              dictionary?: Uint8Array;
              level?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
              mem?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12;
          }

          Hierarchy (view full)

          Properties

          consume? dictionary? level? mem? -

          Properties

          Optional consume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in +

          Properties

          Optionalconsume

          consume?: boolean

          Whether or not to "consume" the source data. This will make the typed array/buffer you pass in unusable but will increase performance and reduce memory usage.

          -

          Optional dictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          +

          Optionaldictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          Dictionaries should be 32kB or smaller and include strings or byte sequences likely to appear in the input. The decompressor must supply the same dictionary as the compressor to extract the original data.

          Dictionaries only improve aggregate compression ratio when reused across multiple small inputs. They should typically not be used otherwise.

          Avoid using dictionaries with GZIP and ZIP to maximize software compatibility.

          -

          Optional level

          level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

          The level of compression to use, ranging from 0-9.

          +

          Optionallevel

          level?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9

          The level of compression to use, ranging from 0-9.

          0 will store the data without compression. 1 is fastest but compresses the worst, 9 is slowest but compresses the best. The default level is 6.

          @@ -22,9 +23,9 @@
        • become 400 kB with level 1 in 10ms
        • become 320 kB with level 9 in 100ms
          • -

          Optional mem

          mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          +

          Optionalmem

          mem?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9
              | 10
              | 11
              | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB. It is recommended not to lower the value below 4, since that tends to hurt performance. In addition, values above 8 tend to help very little on most data and can even hurt performance.

          The default value is automatically determined based on the size of the input data.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          consumedictionarylevelmem
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.DeflateOptions.html b/docs/interfaces/_runtime_data_compress.DeflateOptions.html index f48f26de..a830ff97 100644 --- a/docs/interfaces/_runtime_data_compress.DeflateOptions.html +++ b/docs/interfaces/_runtime_data_compress.DeflateOptions.html @@ -1,13 +1,14 @@ -DeflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface DeflateOptions

          Options for compressing data into a DEFLATE format

          -
          interface DeflateOptions {
              dictionary?: Uint8Array;
              level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
              mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
          }

          Hierarchy (view full)

          Properties

          dictionary? +DeflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface DeflateOptions

          Options for compressing data into a DEFLATE format

          +
          interface DeflateOptions {
              dictionary?: Uint8Array;
              level?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
              mem?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12;
          }

          Hierarchy (view full)

          Properties

          dictionary? level? mem? -

          Properties

          Optional dictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          +

          Properties

          Optionaldictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          Dictionaries should be 32kB or smaller and include strings or byte sequences likely to appear in the input. The decompressor must supply the same dictionary as the compressor to extract the original data.

          Dictionaries only improve aggregate compression ratio when reused across multiple small inputs. They should typically not be used otherwise.

          Avoid using dictionaries with GZIP and ZIP to maximize software compatibility.

          -

          Optional level

          level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

          The level of compression to use, ranging from 0-9.

          +

          Optionallevel

          level?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9

          The level of compression to use, ranging from 0-9.

          0 will store the data without compression. 1 is fastest but compresses the worst, 9 is slowest but compresses the best. The default level is 6.

          @@ -19,9 +20,9 @@
        • become 400 kB with level 1 in 10ms
        • become 320 kB with level 9 in 100ms
          • -

          Optional mem

          mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          +

          Optionalmem

          mem?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9
              | 10
              | 11
              | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB. It is recommended not to lower the value below 4, since that tends to hurt performance. In addition, values above 8 tend to help very little on most data and can even hurt performance.

          The default value is automatically determined based on the size of the input data.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          dictionarylevelmem
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.FlateError.html b/docs/interfaces/_runtime_data_compress.FlateError.html index 44f7c669..e2b95893 100644 --- a/docs/interfaces/_runtime_data_compress.FlateError.html +++ b/docs/interfaces/_runtime_data_compress.FlateError.html @@ -1,8 +1,9 @@ -FlateError | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface FlateError

          An error generated within this library

          -
          interface FlateError {
              cause?: unknown;
              code: number;
              message: string;
              name: string;
              stack?: string;
          }

          Hierarchy

          Properties

          cause? +FlateError | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface FlateError

          An error generated within this library

          +
          interface FlateError {
              cause?: unknown;
              code: number;
              message: string;
              name: string;
              stack?: string;
          }

          Hierarchy

          Properties

          cause? code message name stack? -

          Properties

          Optional cause

          cause?: unknown

          code

          code: number

          The code associated with this error

          -

          message

          message: string

          name

          name: string

          Optional stack

          stack?: string

          Settings

          Member Visibility

          Theme

          On This Page

          causecodemessagenamestack
          \ No newline at end of file +

          Properties

          Optionalcause

          cause?: unknown

          code

          code: number

          The code associated with this error

          +

          message

          message: string

          name

          name: string

          Optionalstack

          stack?: string

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.GunzipOptions.html b/docs/interfaces/_runtime_data_compress.GunzipOptions.html index 14c7ed8c..0fedfed3 100644 --- a/docs/interfaces/_runtime_data_compress.GunzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.GunzipOptions.html @@ -1,8 +1,9 @@ -GunzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface GunzipOptions

          Options for decompressing GZIP data

          -
          interface GunzipOptions {
              dictionary?: Uint8Array;
              out?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? +GunzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface GunzipOptions

          Options for decompressing GZIP data

          +
          interface GunzipOptions {
              dictionary?: Uint8Array;
              out?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? out? -

          Properties

          Optional dictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          +

          Properties

          Optionaldictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

          -

          Optional out

          out?: Uint8Array

          The buffer into which to write the decompressed data. GZIP already encodes the output size, so providing this doesn't save memory.

          +

          Optionalout

          out?: Uint8Array

          The buffer into which to write the decompressed data. GZIP already encodes the output size, so providing this doesn't save memory.

          Note that if the decompression result is larger than the size of this buffer, it will be truncated to fit.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          dictionaryout
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.GunzipStreamOptions.html b/docs/interfaces/_runtime_data_compress.GunzipStreamOptions.html index a38d6366..4672cf17 100644 --- a/docs/interfaces/_runtime_data_compress.GunzipStreamOptions.html +++ b/docs/interfaces/_runtime_data_compress.GunzipStreamOptions.html @@ -1,5 +1,6 @@ -GunzipStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface GunzipStreamOptions

          Options for decompressing a GZIP stream

          -
          interface GunzipStreamOptions {
              dictionary?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? -

          Properties

          Optional dictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          +GunzipStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface GunzipStreamOptions

          Options for decompressing a GZIP stream

          +
          interface GunzipStreamOptions {
              dictionary?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? +

          Properties

          Optionaldictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          dictionary
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.GzipOptions.html b/docs/interfaces/_runtime_data_compress.GzipOptions.html index 62895b9e..caaaf12e 100644 --- a/docs/interfaces/_runtime_data_compress.GzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.GzipOptions.html @@ -1,17 +1,18 @@ -GzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface GzipOptions

          Options for compressing data into a GZIP format

          -
          interface GzipOptions {
              dictionary?: Uint8Array;
              filename?: string;
              level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
              mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
              mtime?: string | number | Date;
          }

          Hierarchy (view full)

          Properties

          dictionary? +GzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface GzipOptions

          Options for compressing data into a GZIP format

          +
          interface GzipOptions {
              dictionary?: Uint8Array;
              filename?: string;
              level?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
              mem?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12;
              mtime?: string | number | Date;
          }

          Hierarchy (view full)

          Properties

          dictionary? filename? level? mem? mtime? -

          Properties

          Optional dictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          +

          Properties

          Optionaldictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          Dictionaries should be 32kB or smaller and include strings or byte sequences likely to appear in the input. The decompressor must supply the same dictionary as the compressor to extract the original data.

          Dictionaries only improve aggregate compression ratio when reused across multiple small inputs. They should typically not be used otherwise.

          Avoid using dictionaries with GZIP and ZIP to maximize software compatibility.

          -

          Optional filename

          filename?: string

          The filename of the data. If the gunzip command is used to decompress the data, it will output a file +

          Optionalfilename

          filename?: string

          The filename of the data. If the gunzip command is used to decompress the data, it will output a file with this name instead of the name of the compressed file.

          -

          Optional level

          level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

          The level of compression to use, ranging from 0-9.

          +

          Optionallevel

          level?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9

          The level of compression to use, ranging from 0-9.

          0 will store the data without compression. 1 is fastest but compresses the worst, 9 is slowest but compresses the best. The default level is 6.

          @@ -23,11 +24,11 @@
        • become 400 kB with level 1 in 10ms
        • become 320 kB with level 9 in 100ms
          • -

          Optional mem

          mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          +

          Optionalmem

          mem?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9
              | 10
              | 11
              | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB. It is recommended not to lower the value below 4, since that tends to hurt performance. In addition, values above 8 tend to help very little on most data and can even hurt performance.

          The default value is automatically determined based on the size of the input data.

          -

          Optional mtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time. +

          Optionalmtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time. Set this to 0 to avoid revealing a modification date entirely.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          dictionaryfilenamelevelmemmtime
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.InflateOptions.html b/docs/interfaces/_runtime_data_compress.InflateOptions.html index 1e7129fe..c3d1eea7 100644 --- a/docs/interfaces/_runtime_data_compress.InflateOptions.html +++ b/docs/interfaces/_runtime_data_compress.InflateOptions.html @@ -1,8 +1,9 @@ -InflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface InflateOptions

          Options for decompressing DEFLATE data

          -
          interface InflateOptions {
              dictionary?: Uint8Array;
              out?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? +InflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface InflateOptions

          Options for decompressing DEFLATE data

          +
          interface InflateOptions {
              dictionary?: Uint8Array;
              out?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? out? -

          Properties

          Optional dictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          +

          Properties

          Optionaldictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

          -

          Optional out

          out?: Uint8Array

          The buffer into which to write the decompressed data. Saves memory if you know the decompressed size in advance.

          +

          Optionalout

          out?: Uint8Array

          The buffer into which to write the decompressed data. Saves memory if you know the decompressed size in advance.

          Note that if the decompression result is larger than the size of this buffer, it will be truncated to fit.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          dictionaryout
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.InflateStreamOptions.html b/docs/interfaces/_runtime_data_compress.InflateStreamOptions.html index 8e108e76..26df88a0 100644 --- a/docs/interfaces/_runtime_data_compress.InflateStreamOptions.html +++ b/docs/interfaces/_runtime_data_compress.InflateStreamOptions.html @@ -1,5 +1,6 @@ -InflateStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface InflateStreamOptions

          Options for decompressing a DEFLATE stream

          -
          interface InflateStreamOptions {
              dictionary?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? -

          Properties

          Optional dictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          +InflateStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface InflateStreamOptions

          Options for decompressing a DEFLATE stream

          +
          interface InflateStreamOptions {
              dictionary?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? +

          Properties

          Optionaldictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          dictionary
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.UnzipDecoder.html b/docs/interfaces/_runtime_data_compress.UnzipDecoder.html index 2acbe5c4..16f239c3 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipDecoder.html +++ b/docs/interfaces/_runtime_data_compress.UnzipDecoder.html @@ -1,11 +1,12 @@ -UnzipDecoder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface UnzipDecoder

          A decoder for files in ZIP streams

          -
          interface UnzipDecoder {
              ondata: AsyncFlateStreamHandler;
              terminate?: AsyncTerminable;
              push(data, final): void;
          }

          Implemented by

          Methods

          push +UnzipDecoder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface UnzipDecoder

          A decoder for files in ZIP streams

          +
          interface UnzipDecoder {
              ondata: AsyncFlateStreamHandler;
              terminate?: AsyncTerminable;
              push(data: Uint8Array, final: boolean): void;
          }

          Implemented by

          Methods

          push

          Properties

          ondata terminate? -

          Methods

          push

          • push(data, final): void

          • Pushes a chunk to be decompressed

            +

          Methods

          push

          • push(data, final): void

          • Pushes a chunk to be decompressed

            Parameters

            • data: Uint8Array

              The data in this chunk. Do not consume (detach) this data.

            • final: boolean

              Whether this is the last chunk in the data stream

              -

            Returns void

          Properties

          ondata

          ondata: AsyncFlateStreamHandler

          The handler to call whenever data is available

          -

          Optional terminate

          terminate?: AsyncTerminable

          A method to terminate any internal workers used by the stream. Subsequent +

          Returns void

          Properties

          ondata

          ondata: AsyncFlateStreamHandler

          The handler to call whenever data is available

          +

          Optionalterminate

          terminate?: AsyncTerminable

          A method to terminate any internal workers used by the stream. Subsequent calls to push() should silently fail.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          pushondataterminate
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Methods
          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.UnzipDecoderConstructor.html b/docs/interfaces/_runtime_data_compress.UnzipDecoderConstructor.html index 563cd002..7e258f57 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipDecoderConstructor.html +++ b/docs/interfaces/_runtime_data_compress.UnzipDecoderConstructor.html @@ -1,11 +1,12 @@ -UnzipDecoderConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface UnzipDecoderConstructor

          A constructor for a decoder for unzip streams

          -
          interface UnzipDecoderConstructor {
              new UnzipDecoderConstructornew (filename, size?, originalSize?): UnzipDecoder;
              compression: number;
          }

          Constructors

          constructor +UnzipDecoderConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface UnzipDecoderConstructor

          A constructor for a decoder for unzip streams

          +
          interface UnzipDecoderConstructor {
              new UnzipDecoderConstructornew (filename: string, size?: number, originalSize?: number): UnzipDecoder;
              compression: number;
          }

          Constructors

          constructor

          Properties

          compression -

          Constructors

          constructor

          • new UnzipDecoderConstructor(filename, size?, originalSize?): UnzipDecoder

          • Creates an instance of the decoder

            +

          Constructors

          constructor

          • new UnzipDecoderConstructor(filename, size?, originalSize?): UnzipDecoder

          • Creates an instance of the decoder

            Parameters

            • filename: string

              The name of the file

              -
            • Optional size: number

              The compressed size of the file

              -
            • Optional originalSize: number

              The original size of the file

              -

            Returns UnzipDecoder

          Properties

          compression

          compression: number

          The compression format for the data stream. This number is determined by +

        • Optionalsize: number

          The compressed size of the file

          +
        • OptionaloriginalSize: number

          The original size of the file

          +

          • Returns UnzipDecoder

          Properties

          compression

          compression: number

          The compression format for the data stream. This number is determined by the spec in PKZIP's APPNOTE.txt, section 4.4.5. For example, 0 = no compression, 8 = deflate, 14 = LZMA

          -

          Settings

          Member Visibility

          Theme

          On This Page

          constructorcompression
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Constructors
          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.UnzipFile.html b/docs/interfaces/_runtime_data_compress.UnzipFile.html index 4bc0f28f..e4627383 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipFile.html +++ b/docs/interfaces/_runtime_data_compress.UnzipFile.html @@ -1,24 +1,25 @@ -UnzipFile | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface UnzipFile

          Streaming file extraction from ZIP archives

          -
          interface UnzipFile {
              compression: number;
              name: string;
              ondata: AsyncFlateStreamHandler;
              originalSize?: number;
              size?: number;
              terminate: AsyncTerminable;
              start(): void;
          }

          Methods

          start +UnzipFile | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface UnzipFile

          Streaming file extraction from ZIP archives

          +
          interface UnzipFile {
              compression: number;
              name: string;
              ondata: AsyncFlateStreamHandler;
              originalSize?: number;
              size?: number;
              terminate: AsyncTerminable;
              start(): void;
          }

          Methods

          start

          Properties

          compression name ondata originalSize? size? terminate -

          Methods

          start

          • start(): void

          • Starts reading from the stream. Calling this function will always enable +

          Methods

          start

          • start(): void

          • Starts reading from the stream. Calling this function will always enable this stream, but ocassionally the stream will be enabled even without this being called.

            -

            Returns void

          Properties

          compression

          compression: number

          The compression format for the data stream. This number is determined by +

          Returns void

          Properties

          compression

          compression: number

          The compression format for the data stream. This number is determined by the spec in PKZIP's APPNOTE.txt, section 4.4.5. For example, 0 = no compression, 8 = deflate, 14 = LZMA. If start() is called but there is no decompression stream available for this method, start() will throw.

          name

          name: string

          The name of the file

          ondata

          ondata: AsyncFlateStreamHandler

          The handler to call whenever data is available

          -

          Optional originalSize

          originalSize?: number

          The original size of the file. Will not be present for archives created +

          OptionaloriginalSize

          originalSize?: number

          The original size of the file. Will not be present for archives created in a streaming fashion.

          -

          Optional size

          size?: number

          The compressed size of the file. Will not be present for archives created +

          Optionalsize

          size?: number

          The compressed size of the file. Will not be present for archives created in a streaming fashion.

          terminate

          terminate: AsyncTerminable

          A method to terminate any internal workers used by the stream. ondata will not be called any further.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          startcompressionnameondataoriginalSizesizeterminate
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Methods
          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.UnzipFileInfo.html b/docs/interfaces/_runtime_data_compress.UnzipFileInfo.html index 66391974..f3fa41ed 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipFileInfo.html +++ b/docs/interfaces/_runtime_data_compress.UnzipFileInfo.html @@ -1,13 +1,14 @@ -UnzipFileInfo | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface UnzipFileInfo

          Information about a file to be extracted from a ZIP archive

          -
          interface UnzipFileInfo {
              compression: number;
              name: string;
              originalSize: number;
              size: number;
          }

          Properties

          compression +UnzipFileInfo | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface UnzipFileInfo

          Information about a file to be extracted from a ZIP archive

          +
          interface UnzipFileInfo {
              compression: number;
              name: string;
              originalSize: number;
              size: number;
          }

          Properties

          compression name originalSize size -

          Properties

          compression

          compression: number

          The compression format for the data stream. This number is determined by +

          Properties

          compression

          compression: number

          The compression format for the data stream. This number is determined by the spec in PKZIP's APPNOTE.txt, section 4.4.5. For example, 0 = no compression, 8 = deflate, 14 = LZMA. If the filter function returns true but this value is not 8, the unzip function will throw.

          name

          name: string

          The name of the file

          originalSize

          originalSize: number

          The original size of the file

          size

          size: number

          The compressed size of the file

          -

          Settings

          Member Visibility

          Theme

          On This Page

          compressionnameoriginalSizesize
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.UnzipOptions.html b/docs/interfaces/_runtime_data_compress.UnzipOptions.html index 00dc3556..50caba53 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.UnzipOptions.html @@ -1,4 +1,5 @@ -UnzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface UnzipOptions

          Options for expanding a ZIP archive

          -
          interface UnzipOptions {
              filter?: UnzipFileFilter;
          }

          Hierarchy (view full)

          Properties

          filter? -

          Properties

          Optional filter

          filter?: UnzipFileFilter

          A filter function to extract only certain files from a ZIP archive

          -

          Settings

          Member Visibility

          Theme

          On This Page

          filter
          \ No newline at end of file +UnzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface UnzipOptions

          Options for expanding a ZIP archive

          +
          interface UnzipOptions {
              filter?: UnzipFileFilter;
          }

          Hierarchy (view full)

          Properties

          filter? +

          Properties

          Optionalfilter

          filter?: UnzipFileFilter

          A filter function to extract only certain files from a ZIP archive

          +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.Unzipped.html b/docs/interfaces/_runtime_data_compress.Unzipped.html index 2ab52cee..f3b3ff03 100644 --- a/docs/interfaces/_runtime_data_compress.Unzipped.html +++ b/docs/interfaces/_runtime_data_compress.Unzipped.html @@ -1,3 +1,4 @@ -Unzipped | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface Unzipped

          An unzipped archive. The full path of each file is used as the key, +Unzipped | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          +

          Interface Unzipped

          An unzipped archive. The full path of each file is used as the key, and the file is the value

          -
          interface Unzipped {
              [path: string]: Uint8Array;
          }

          Indexable

          [path: string]: Uint8Array

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +

          Indexable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.UnzlibOptions.html b/docs/interfaces/_runtime_data_compress.UnzlibOptions.html index 4370b2d2..13189ee3 100644 --- a/docs/interfaces/_runtime_data_compress.UnzlibOptions.html +++ b/docs/interfaces/_runtime_data_compress.UnzlibOptions.html @@ -1,8 +1,9 @@ -UnzlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface UnzlibOptions

          Options for decompressing Zlib data

          -
          interface UnzlibOptions {
              dictionary?: Uint8Array;
              out?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? +UnzlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface UnzlibOptions

          Options for decompressing Zlib data

          +
          interface UnzlibOptions {
              dictionary?: Uint8Array;
              out?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? out? -

          Properties

          Optional dictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          +

          Properties

          Optionaldictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

          -

          Optional out

          out?: Uint8Array

          The buffer into which to write the decompressed data. Saves memory if you know the decompressed size in advance.

          +

          Optionalout

          out?: Uint8Array

          The buffer into which to write the decompressed data. Saves memory if you know the decompressed size in advance.

          Note that if the decompression result is larger than the size of this buffer, it will be truncated to fit.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          dictionaryout
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.UnzlibStreamOptions.html b/docs/interfaces/_runtime_data_compress.UnzlibStreamOptions.html index e95d19eb..6561ac9b 100644 --- a/docs/interfaces/_runtime_data_compress.UnzlibStreamOptions.html +++ b/docs/interfaces/_runtime_data_compress.UnzlibStreamOptions.html @@ -1,5 +1,6 @@ -UnzlibStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface UnzlibStreamOptions

          Options for decompressing a Zlib stream

          -
          interface UnzlibStreamOptions {
              dictionary?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? -

          Properties

          Optional dictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          +UnzlibStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface UnzlibStreamOptions

          Options for decompressing a Zlib stream

          +
          interface UnzlibStreamOptions {
              dictionary?: Uint8Array;
          }

          Hierarchy (view full)

          Properties

          dictionary? +

          Properties

          Optionaldictionary

          dictionary?: Uint8Array

          The dictionary used to compress the original data. If no dictionary was used during compression, this option has no effect.

          Supplying the wrong dictionary during decompression usually yields corrupt output or causes an invalid distance error.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          dictionary
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.ZipAttributes.html b/docs/interfaces/_runtime_data_compress.ZipAttributes.html index aa0cf3de..1c5fcf7e 100644 --- a/docs/interfaces/_runtime_data_compress.ZipAttributes.html +++ b/docs/interfaces/_runtime_data_compress.ZipAttributes.html @@ -1,10 +1,11 @@ -ZipAttributes | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface ZipAttributes

          Attributes for files added to a ZIP archive object

          -
          interface ZipAttributes {
              attrs?: number;
              comment?: string;
              extra?: Record<number, Uint8Array>;
              mtime?: string | number | Date;
              os?: number;
          }

          Hierarchy (view full)

          Properties

          attrs? +ZipAttributes | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface ZipAttributes

          Attributes for files added to a ZIP archive object

          +
          interface ZipAttributes {
              attrs?: number;
              comment?: string;
              extra?: Record<number, Uint8Array>;
              mtime?: string | number | Date;
              os?: number;
          }

          Hierarchy (view full)

          Properties

          attrs? comment? extra? mtime? os? -

          Properties

          Optional attrs

          attrs?: number

          The file's attributes. These are traditionally somewhat complicated +

          Properties

          Optionalattrs

          attrs?: number

          The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, here is a representation of what this is, bit by bit:

          TTTTugtrwxrwxrwx0000000000ADVSHR

          @@ -16,16 +17,16 @@

          If you want to set the Unix permissions, for instance, just bit shift by 16, e.g. 0o644 << 16. Note that attributes usually only work in conjunction with the os setting: you must use os = 3 (Unix) if you want to set Unix permissions

          -

          Optional comment

          comment?: string

          The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, +

          Optionalcomment

          comment?: string

          The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.26. The comment must be at most 65,535 bytes long UTF-8 encoded. This field is not read by consumer software.

          -

          Optional extra

          extra?: Record<number, Uint8Array>

          Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, +

          Optionalextra

          extra?: Record<number, Uint8Array>

          Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.28. At most 65,535 bytes may be used in each ID. The ID must be an integer between 0 and 65,535, inclusive.

          This field is incredibly rare and almost never needed except for compliance with proprietary standards and software.

          -

          Optional mtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time.

          -

          Optional os

          os?: number

          The operating system of origin for this file. The value is defined +

          Optionalmtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time.

          +

          Optionalos

          os?: number

          The operating system of origin for this file. The value is defined by PKZIP's APPNOTE.txt, section 4.4.2.2. For example, 0 (the default) is MS/DOS, 3 is Unix, 19 is macOS.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          attrscommentextramtimeos
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.ZipInputFile.html b/docs/interfaces/_runtime_data_compress.ZipInputFile.html index 244fc02e..93c3fbd5 100644 --- a/docs/interfaces/_runtime_data_compress.ZipInputFile.html +++ b/docs/interfaces/_runtime_data_compress.ZipInputFile.html @@ -1,5 +1,6 @@ -ZipInputFile | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface ZipInputFile

          A stream that can be used to create a file in a ZIP archive

          -
          interface ZipInputFile {
              attrs?: number;
              comment?: string;
              compression: number;
              crc: number;
              extra?: Record<number, Uint8Array>;
              filename: string;
              flag?: number;
              mtime?: string | number | Date;
              ondata?: AsyncFlateStreamHandler;
              os?: number;
              size: number;
              terminate?: AsyncTerminable;
          }

          Hierarchy (view full)

          Implemented by

          Properties

          attrs? +ZipInputFile | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface ZipInputFile

          A stream that can be used to create a file in a ZIP archive

          +
          interface ZipInputFile {
              attrs?: number;
              comment?: string;
              compression: number;
              crc: number;
              extra?: Record<number, Uint8Array>;
              filename: string;
              flag?: number;
              mtime?: string | number | Date;
              ondata?: AsyncFlateStreamHandler;
              os?: number;
              size: number;
              terminate?: AsyncTerminable;
          }

          Hierarchy (view full)

          Implemented by

          Properties

          attrs? comment? compression crc @@ -11,7 +12,7 @@ os? size terminate? -

          Properties

          Optional attrs

          attrs?: number

          The file's attributes. These are traditionally somewhat complicated +

          Properties

          Optionalattrs

          attrs?: number

          The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, here is a representation of what this is, bit by bit:

          TTTTugtrwxrwxrwx0000000000ADVSHR

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

          If you want to set the Unix permissions, for instance, just bit shift by 16, e.g. 0o644 << 16. Note that attributes usually only work in conjunction with the os setting: you must use os = 3 (Unix) if you want to set Unix permissions

          -

          Optional comment

          comment?: string

          The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, +

          Optionalcomment

          comment?: string

          The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.26. The comment must be at most 65,535 bytes long UTF-8 encoded. This field is not read by consumer software.

          compression

          compression: number

          The compression format for the data stream. This number is determined by @@ -35,7 +36,7 @@

          If you don't want to have to generate this yourself, consider extending the ZipPassThrough class and overriding its process() method, or using one of ZipDeflate or AsyncZipDeflate.

          -

          Optional extra

          extra?: Record<number, Uint8Array>

          Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, +

          Optionalextra

          extra?: Record<number, Uint8Array>

          Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.28. At most 65,535 bytes may be used in each ID. The ID must be an integer between 0 and 65,535, inclusive.

          This field is incredibly rare and almost never needed except for compliance with @@ -43,18 +44,18 @@

          filename

          filename: string

          The filename to associate with the data provided to this stream. If you want a file in a subdirectory, use forward slashes as a separator (e.g. directory/filename.ext). This will still work on Windows.

          -

          Optional flag

          flag?: number

          Bits 1 and 2 of the general purpose bit flag, specified in PKZIP's +

          Optionalflag

          flag?: number

          Bits 1 and 2 of the general purpose bit flag, specified in PKZIP's APPNOTE.txt, section 4.4.4. Should be between 0 and 3. This is unlikely to be necessary.

          -

          Optional mtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time.

          -

          Optional ondata

          ondata?: AsyncFlateStreamHandler

          The handler to be called when data is added. After passing this stream to +

          Optionalmtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time.

          +

          Optionalondata

          ondata?: AsyncFlateStreamHandler

          The handler to be called when data is added. After passing this stream to the ZIP file object, this handler will always be defined. To call it:

          stream.ondata(error, chunk, final)

          error = any error that occurred (null if there was no error)

          chunk = a Uint8Array of the data that was added (null if there was an error)

          final = boolean, whether this is the final chunk in the stream

          -

          Optional os

          os?: number

          The operating system of origin for this file. The value is defined +

          Optionalos

          os?: number

          The operating system of origin for this file. The value is defined by PKZIP's APPNOTE.txt, section 4.4.2.2. For example, 0 (the default) is MS/DOS, 3 is Unix, 19 is macOS.

          size

          size: number

          The size of the file in bytes. This attribute may be invalid after @@ -63,8 +64,8 @@

          If you don't want to have to compute this yourself, consider extending the ZipPassThrough class and overriding its process() method, or using one of ZipDeflate or AsyncZipDeflate.

          -

          Optional terminate

          terminate?: AsyncTerminable

          A method called when the stream is no longer needed, for clean-up +

          Optionalterminate

          terminate?: AsyncTerminable

          A method called when the stream is no longer needed, for clean-up purposes. This will not always be called after the stream completes, so you may wish to call this.terminate() after the final chunk is processed if you have clean-up logic.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          attrscommentcompressioncrcextrafilenameflagmtimeondataossizeterminate
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.ZipOptions.html b/docs/interfaces/_runtime_data_compress.ZipOptions.html index 837d70ce..edb01bd4 100644 --- a/docs/interfaces/_runtime_data_compress.ZipOptions.html +++ b/docs/interfaces/_runtime_data_compress.ZipOptions.html @@ -1,5 +1,6 @@ -ZipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface ZipOptions

          Options for creating a ZIP archive

          -
          interface ZipOptions {
              attrs?: number;
              comment?: string;
              dictionary?: Uint8Array;
              extra?: Record<number, Uint8Array>;
              level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
              mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
              mtime?: string | number | Date;
              os?: number;
          }

          Hierarchy (view full)

          Properties

          attrs? +ZipOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface ZipOptions

          Options for creating a ZIP archive

          +
          interface ZipOptions {
              attrs?: number;
              comment?: string;
              dictionary?: Uint8Array;
              extra?: Record<number, Uint8Array>;
              level?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
              mem?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12;
              mtime?: string | number | Date;
              os?: number;
          }

          Hierarchy (view full)

          Properties

          attrs? comment? dictionary? extra? @@ -7,7 +8,7 @@ mem? mtime? os? -

          Properties

          Optional attrs

          attrs?: number

          The file's attributes. These are traditionally somewhat complicated +

          Properties

          Optionalattrs

          attrs?: number

          The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, here is a representation of what this is, bit by bit:

          TTTTugtrwxrwxrwx0000000000ADVSHR

          @@ -19,20 +20,20 @@

          If you want to set the Unix permissions, for instance, just bit shift by 16, e.g. 0o644 << 16. Note that attributes usually only work in conjunction with the os setting: you must use os = 3 (Unix) if you want to set Unix permissions

          -

          Optional comment

          comment?: string

          The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, +

          Optionalcomment

          comment?: string

          The comment to attach to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.26. The comment must be at most 65,535 bytes long UTF-8 encoded. This field is not read by consumer software.

          -

          Optional dictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          +

          Optionaldictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          Dictionaries should be 32kB or smaller and include strings or byte sequences likely to appear in the input. The decompressor must supply the same dictionary as the compressor to extract the original data.

          Dictionaries only improve aggregate compression ratio when reused across multiple small inputs. They should typically not be used otherwise.

          Avoid using dictionaries with GZIP and ZIP to maximize software compatibility.

          -

          Optional extra

          extra?: Record<number, Uint8Array>

          Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, +

          Optionalextra

          extra?: Record<number, Uint8Array>

          Extra metadata to add to the file. This field is defined by PKZIP's APPNOTE.txt, section 4.4.28. At most 65,535 bytes may be used in each ID. The ID must be an integer between 0 and 65,535, inclusive.

          This field is incredibly rare and almost never needed except for compliance with proprietary standards and software.

          -

          Optional level

          level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

          The level of compression to use, ranging from 0-9.

          +

          Optionallevel

          level?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9

          The level of compression to use, ranging from 0-9.

          0 will store the data without compression. 1 is fastest but compresses the worst, 9 is slowest but compresses the best. The default level is 6.

          @@ -44,13 +45,13 @@
        • become 400 kB with level 1 in 10ms
        • become 320 kB with level 9 in 100ms
          • -

          Optional mem

          mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          +

          Optionalmem

          mem?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9
              | 10
              | 11
              | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB. It is recommended not to lower the value below 4, since that tends to hurt performance. In addition, values above 8 tend to help very little on most data and can even hurt performance.

          The default value is automatically determined based on the size of the input data.

          -

          Optional mtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time.

          -

          Optional os

          os?: number

          The operating system of origin for this file. The value is defined +

          Optionalmtime

          mtime?: string | number | Date

          When the file was last modified. Defaults to the current time.

          +

          Optionalos

          os?: number

          The operating system of origin for this file. The value is defined by PKZIP's APPNOTE.txt, section 4.4.2.2. For example, 0 (the default) is MS/DOS, 3 is Unix, 19 is macOS.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          attrscommentdictionaryextralevelmemmtimeos
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.Zippable.html b/docs/interfaces/_runtime_data_compress.Zippable.html index 0f2162a4..3284f784 100644 --- a/docs/interfaces/_runtime_data_compress.Zippable.html +++ b/docs/interfaces/_runtime_data_compress.Zippable.html @@ -1,2 +1,3 @@ -Zippable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface Zippable

          The complete directory structure of a ZIPpable archive

          -
          interface Zippable {
              [path: string]: ZippableFile;
          }

          Indexable

          [path: string]: ZippableFile

          Settings

          Member Visibility

          Theme

          \ No newline at end of file +Zippable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface Zippable

          The complete directory structure of a ZIPpable archive

          +

          Indexable

          Settings

          Member Visibility
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_compress.ZlibOptions.html b/docs/interfaces/_runtime_data_compress.ZlibOptions.html index 3e9502d4..c76e9ac0 100644 --- a/docs/interfaces/_runtime_data_compress.ZlibOptions.html +++ b/docs/interfaces/_runtime_data_compress.ZlibOptions.html @@ -1,13 +1,14 @@ -ZlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface ZlibOptions

          Options for compressing data into a Zlib format

          -
          interface ZlibOptions {
              dictionary?: Uint8Array;
              level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
              mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
          }

          Hierarchy (view full)

          Properties

          dictionary? +ZlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface ZlibOptions

          Options for compressing data into a Zlib format

          +
          interface ZlibOptions {
              dictionary?: Uint8Array;
              level?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9;
              mem?:
                  | 0
                  | 1
                  | 2
                  | 3
                  | 4
                  | 5
                  | 6
                  | 7
                  | 8
                  | 9
                  | 10
                  | 11
                  | 12;
          }

          Hierarchy (view full)

          Properties

          dictionary? level? mem? -

          Properties

          Optional dictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          +

          Properties

          Optionaldictionary

          dictionary?: Uint8Array

          A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

          Dictionaries should be 32kB or smaller and include strings or byte sequences likely to appear in the input. The decompressor must supply the same dictionary as the compressor to extract the original data.

          Dictionaries only improve aggregate compression ratio when reused across multiple small inputs. They should typically not be used otherwise.

          Avoid using dictionaries with GZIP and ZIP to maximize software compatibility.

          -

          Optional level

          level?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

          The level of compression to use, ranging from 0-9.

          +

          Optionallevel

          level?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9

          The level of compression to use, ranging from 0-9.

          0 will store the data without compression. 1 is fastest but compresses the worst, 9 is slowest but compresses the best. The default level is 6.

          @@ -19,9 +20,9 @@
        • become 400 kB with level 1 in 10ms
        • become 320 kB with level 9 in 100ms
          • -

          Optional mem

          mem?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          +

          Optionalmem

          mem?:
              | 0
              | 1
              | 2
              | 3
              | 4
              | 5
              | 6
              | 7
              | 8
              | 9
              | 10
              | 11
              | 12

          The memory level to use, ranging from 0-12. Increasing this increases speed and compression ratio at the cost of memory.

          Note that this is exponential: while level 0 uses 4 kB, level 4 uses 64 kB, level 8 uses 1 MB, and level 12 uses 16 MB. It is recommended not to lower the value below 4, since that tends to hurt performance. In addition, values above 8 tend to help very little on most data and can even hurt performance.

          The default value is automatically determined based on the size of the input data.

          -

          Settings

          Member Visibility

          Theme

          On This Page

          dictionarylevelmem
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Properties
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_format_json5.JSON5.html b/docs/interfaces/_runtime_data_format_json5.JSON5.html index 91db8b71..cf886cde 100644 --- a/docs/interfaces/_runtime_data_format_json5.JSON5.html +++ b/docs/interfaces/_runtime_data_format_json5.JSON5.html @@ -1,16 +1,17 @@ -JSON5 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface JSON5

          interface JSON5 {
              parse<T>(text, reviver?): T;
              stringify(value, replacer?, space?): string;
              stringify(value, replacer, space?): string;
              stringify(value, options): string;
          }

          Methods

          parse +JSON5 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface JSON5

          interface JSON5 {
              parse<T>(text: string, reviver?: ((this: any, key: string, value: any) => any)): T;
              stringify(value: any, replacer?: ((this: any, key: string, value: any) => any), space?: string | number): string;
              stringify(value: any, replacer: (string | number)[], space?: string | number): string;
              stringify(value: any, options: StringifyOptions): string;
          }

          Methods

          parse stringify -

          Methods

          parse

          • parse<T>(text, reviver?): T

          • Parses a JSON5 string, constructing the JavaScript value or object described by the string.

            +

          Methods

          parse

          • parse<T>(text, reviver?): T

          • Parses a JSON5 string, constructing the JavaScript value or object described by the string.

            Type Parameters

            • T = any

              The type of the return value.

            Parameters

            • text: string

              The string to parse as JSON5.

              -
            • Optional reviver: ((this, key, value) => any)

              A function that prescribes how the value originally produced by parsing is transformed before +

            • Optionalreviver: ((this: any, key: string, value: any) => any)

              A function that prescribes how the value originally produced by parsing is transformed before being returned.

                • (this, key, value): any

                • Parameters

                  • this: any
                  • key: string
                  • value: any

                  Returns any

            Returns T

            The JavaScript value converted from the JSON5 string.

          stringify

          • stringify(value, replacer?, space?): string

          • Converts a JavaScript value to a JSON5 string.

            Parameters

            • value: any

              The value to convert to a JSON5 string.

              -
            • Optional replacer: ((this, key, value) => any)

              A function that alters the behavior of the stringification process. If this value is null or not +

            • Optionalreplacer: ((this: any, key: string, value: any) => any)

              A function that alters the behavior of the stringification process. If this value is null or not provided, all properties of the object are included in the resulting JSON5 string.

              -
                • (this, key, value): any

                • Parameters

                  • this: any
                  • key: string
                  • value: any

                  Returns any

            • Optional space: string | number

              A String or Number object that's used to insert white space into the output JSON5 string for +

                • (this, key, value): any

                • Parameters

                  • this: any
                  • key: string
                  • value: any

                  Returns any

            • Optionalspace: string | number

              A String or Number object that's used to insert white space into the output JSON5 string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space; this number is capped at 10 (if it is greater, the value is just 10). Values less than 1 indicate that no space should be used. If this is a String, the string (or the first 10 characters of the string, if it's longer than @@ -22,7 +23,7 @@

            • replacer: (string | number)[]

              An array of String and Number objects that serve as an allowlist for selecting/filtering the properties of the value object to be included in the JSON5 string. If this value is null or not provided, all properties of the object are included in the resulting JSON5 string.

              -
            • Optional space: string | number

              A String or Number object that's used to insert white space into the output JSON5 string for +

            • Optionalspace: string | number

              A String or Number object that's used to insert white space into the output JSON5 string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space; this number is capped at 10 (if it is greater, the value is just 10). Values less than 1 indicate that no space should be used. If this is a String, the string (or the first 10 characters of the string, if it's longer than @@ -33,4 +34,4 @@

              Parameters

              • value: any

                The value to convert to a JSON5 string.

              • options: StringifyOptions

                An object specifying options.

              Returns string

              The JSON5 string converted from the JavaScript value.

              -

          Settings

          Member Visibility

          Theme

          On This Page

          parsestringify
          \ No newline at end of file +

          Settings

          Member Visibility

          On This Page

          Methods
          \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_format_msgpack.Options.html b/docs/interfaces/_runtime_data_format_msgpack.Options.html index 9bb8b059..26c07219 100644 --- a/docs/interfaces/_runtime_data_format_msgpack.Options.html +++ b/docs/interfaces/_runtime_data_format_msgpack.Options.html @@ -1,4 +1,5 @@ -Options | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

          Interface Options

          interface Options {
              bundleStrings?: boolean;
              coercibleKeyAsNumber?: boolean;
              copyBuffers?: boolean;
              encodeUndefinedAsNil?: boolean;
              int64AsNumber?: boolean;
              int64AsType?: "string" | "number" | "bigint";
              largeBigIntToFloat?: boolean;
              mapAsEmptyObject?: boolean;
              mapsAsObjects?: boolean;
              maxOwnStructures?: number;
              maxSharedStructures?: number;
              moreTypes?: boolean;
              onInvalidDate?: (() => any);
              sequential?: boolean;
              setAsEmptyObject?: boolean;
              shouldShareStructure?: ((keys) => boolean);
              structuredClone?: boolean;
              structures?: {}[];
              useBigIntExtension?: boolean;
              useFloat32?: FLOAT32_OPTIONS;
              useRecords?: boolean | ((value) => boolean);
              useTimestamp32?: boolean;
              variableMapSize?: boolean;
              getStructures?(): {}[];
              saveStructures?(structures): boolean | void;
          }

          Methods

          getStructures? +Options | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
          +

          Interface Options

          interface Options {
              bundleStrings?: boolean;
              coercibleKeyAsNumber?: boolean;
              copyBuffers?: boolean;
              encodeUndefinedAsNil?: boolean;
              int64AsNumber?: boolean;
              int64AsType?: "string" | "number" | "bigint";
              largeBigIntToFloat?: boolean;
              mapAsEmptyObject?: boolean;
              mapsAsObjects?: boolean;
              maxOwnStructures?: number;
              maxSharedStructures?: number;
              moreTypes?: boolean;
              onInvalidDate?: (() => any);
              sequential?: boolean;
              setAsEmptyObject?: boolean;
              shouldShareStructure?: ((keys: string[]) => boolean);
              structuredClone?: boolean;
              structures?: {}[];
              useBigIntExtension?: boolean;
              useFloat32?: FLOAT32_OPTIONS;
              useRecords?: boolean | ((value: any) => boolean);
              useTimestamp32?: boolean;
              variableMapSize?: boolean;
              getStructures?(): {}[];
              saveStructures?(structures: {}[]): boolean | void;
          }

          Methods

          getStructures? saveStructures?

          Properties

          bundleStrings? coercibleKeyAsNumber? @@ -23,5 +24,5 @@ useRecords? useTimestamp32? variableMapSize? -

          Methods

          Optional getStructures

          • getStructures(): {}[]

          • Returns {}[]

          Optional saveStructures

          • saveStructures(structures): boolean | void

          • Parameters

            • structures: {}[]

            Returns boolean | void

          Properties

          Optional bundleStrings

          bundleStrings?: boolean

          Optional coercibleKeyAsNumber

          coercibleKeyAsNumber?: boolean

          Optional copyBuffers

          copyBuffers?: boolean

          Optional encodeUndefinedAsNil

          encodeUndefinedAsNil?: boolean

          Optional int64AsNumber

          int64AsNumber?: boolean

          Deprecated

          use int64AsType: 'number'

          -

          Optional int64AsType

          int64AsType?: "string" | "number" | "bigint"

          Optional largeBigIntToFloat

          largeBigIntToFloat?: boolean

          Optional mapAsEmptyObject

          mapAsEmptyObject?: boolean

          Optional mapsAsObjects

          mapsAsObjects?: boolean

          Optional maxOwnStructures

          maxOwnStructures?: number

          Optional maxSharedStructures

          maxSharedStructures?: number

          Optional moreTypes

          moreTypes?: boolean

          Optional onInvalidDate

          onInvalidDate?: (() => any)

          Type declaration

            • (): any

            • Returns any

          Optional sequential

          sequential?: boolean

          Optional setAsEmptyObject

          setAsEmptyObject?: boolean

          Optional shouldShareStructure

          shouldShareStructure?: ((keys) => boolean)

          Type declaration

            • (keys): boolean

            • Parameters

              • keys: string[]

              Returns boolean

          Optional structuredClone

          structuredClone?: boolean

          Optional structures

          structures?: {}[]

          Type declaration

            Optional useBigIntExtension

            useBigIntExtension?: boolean

            Optional useFloat32

            useFloat32?: FLOAT32_OPTIONS

            Optional useRecords

            useRecords?: boolean | ((value) => boolean)

            Type declaration

              • (value): boolean

              • Parameters

                • value: any

                Returns boolean

            Optional useTimestamp32

            useTimestamp32?: boolean

            Optional variableMapSize

            variableMapSize?: boolean

            Settings

            Member Visibility

            Theme

            On This Page

            getStructuressaveStructuresbundleStringscoercibleKeyAsNumbercopyBuffersencodeUndefinedAsNilint64AsNumberint64AsTypelargeBigIntToFloatmapAsEmptyObjectmapsAsObjectsmaxOwnStructuresmaxSharedStructuresmoreTypesonInvalidDatesequentialsetAsEmptyObjectshouldShareStructurestructuredClonestructuresuseBigIntExtensionuseFloat32useRecordsuseTimestamp32variableMapSize
            \ No newline at end of file +

            Methods

            OptionalgetStructures

            • getStructures(): {}[]

            • Returns {}[]

            OptionalsaveStructures

            • saveStructures(structures): boolean | void

            • Parameters

              • structures: {}[]

              Returns boolean | void

            Properties

            OptionalbundleStrings

            bundleStrings?: boolean

            OptionalcoercibleKeyAsNumber

            coercibleKeyAsNumber?: boolean

            OptionalcopyBuffers

            copyBuffers?: boolean

            OptionalencodeUndefinedAsNil

            encodeUndefinedAsNil?: boolean

            Optionalint64AsNumber

            int64AsNumber?: boolean

            Deprecated

            use int64AsType: 'number'

            +

            Optionalint64AsType

            int64AsType?: "string" | "number" | "bigint"

            OptionallargeBigIntToFloat

            largeBigIntToFloat?: boolean

            OptionalmapAsEmptyObject

            mapAsEmptyObject?: boolean

            OptionalmapsAsObjects

            mapsAsObjects?: boolean

            OptionalmaxOwnStructures

            maxOwnStructures?: number

            OptionalmaxSharedStructures

            maxSharedStructures?: number

            OptionalmoreTypes

            moreTypes?: boolean

            OptionalonInvalidDate

            onInvalidDate?: (() => any)

            Optionalsequential

            sequential?: boolean

            OptionalsetAsEmptyObject

            setAsEmptyObject?: boolean

            OptionalshouldShareStructure

            shouldShareStructure?: ((keys: string[]) => boolean)

            OptionalstructuredClone

            structuredClone?: boolean

            Optionalstructures

            structures?: {}[]

            OptionaluseBigIntExtension

            useBigIntExtension?: boolean

            OptionaluseFloat32

            useFloat32?: FLOAT32_OPTIONS

            OptionaluseRecords

            useRecords?: boolean | ((value: any) => boolean)

            OptionaluseTimestamp32

            useTimestamp32?: boolean

            OptionalvariableMapSize

            variableMapSize?: boolean

            Settings

            Member Visibility

            On This Page

            Methods
            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_struct_search_trie.ITrieSearchReducer.html b/docs/interfaces/_runtime_data_struct_search_trie.ITrieSearchReducer.html index efe0e3ec..9820c42b 100644 --- a/docs/interfaces/_runtime_data_struct_search_trie.ITrieSearchReducer.html +++ b/docs/interfaces/_runtime_data_struct_search_trie.ITrieSearchReducer.html @@ -1,13 +1,14 @@ -ITrieSearchReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface ITrieSearchReducer<T>

            Provides an interface for all reducers.

            -
            interface ITrieSearchReducer<T> {
                get keyFields(): Key | KeyFields;
                get matches(): T[];
                reduce(data): void;
                reset(data): void;
            }

            Type Parameters

            • T extends object

            Implemented by

            Accessors

            keyFields +ITrieSearchReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface ITrieSearchReducer<T>

            Provides an interface for all reducers.

            +
            interface ITrieSearchReducer<T> {
                get keyFields(): Key | KeyFields;
                get matches(): T[];
                reduce(data: TrieSearchReducerData<T>): void;
                reset(data: TrieSearchReducerResetData<T>): void;
            }

            Type Parameters

            • T extends object

            Implemented by

            Accessors

            keyFields matches

            Methods

            reduce reset -

            Accessors

            keyFields

            • get keyFields(): Key | KeyFields

            • Returns Key | KeyFields

              Any associated key fields to limit match intersection / HashArray in +

            Accessors

            keyFields

            • get keyFields(): Key | KeyFields

            • Returns Key | KeyFields

              Any associated key fields to limit match intersection / HashArray in TrieSearch.#getImpl.

            matches

            • get matches(): T[]

            • Returns T[]

              The matches after reducing.

              -

            Methods

            reduce

            • reduce(data): void

            • Defines a reducer function used to accumulate and reduce data found in searching.

              +

            Methods

            reduce

            • reduce(data): void

            • Defines a reducer function used to accumulate and reduce data found in searching.

              Parameters

              Returns void

            reset

            Settings

            Member Visibility

            Theme

            On This Page

            keyFieldsmatchesreducereset
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_math_interpolate.InterpolateFunction.html b/docs/interfaces/_runtime_math_interpolate.InterpolateFunction.html index eed383db..55a24d11 100644 --- a/docs/interfaces/_runtime_math_interpolate.InterpolateFunction.html +++ b/docs/interfaces/_runtime_math_interpolate.InterpolateFunction.html @@ -1,6 +1,7 @@ -InterpolateFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface InterpolateFunction<T>

            Defines the shape of an interpolation function.

            -
            interface InterpolateFunction<T> ((start, end, amount) => T)

            Type Parameters

            • T
            • InterpolateFunction(start, end, amount): T

            • Parameters

              • start: T

                Start value.

                +InterpolateFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                +

                Interface InterpolateFunction<T>

                Defines the shape of an interpolation function.

                +

                Type Parameters

                • T
                • InterpolateFunction(start, end, amount): T

                • Parameters

                  • start: T

                    Start value.

                  • end: T

                    End value.

                  • amount: number

                    Current amount between 0 - 1 inclusive.

                  Returns T

                  Interpolated value between start & end.

                  -

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +

            Settings

            Member Visibility
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_plugin_manager.PluginSupportConstructor.html b/docs/interfaces/_runtime_plugin_manager.PluginSupportConstructor.html index f672113e..845eea43 100644 --- a/docs/interfaces/_runtime_plugin_manager.PluginSupportConstructor.html +++ b/docs/interfaces/_runtime_plugin_manager.PluginSupportConstructor.html @@ -1,2 +1,3 @@ -PluginSupportConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface PluginSupportConstructor

            interface PluginSupportConstructor {
                new PluginSupportConstructornew (pluginManager): PluginSupportImpl;
            }

            Constructors

            constructor -

            Constructors

            constructor

            Settings

            Member Visibility

            Theme

            On This Page

            constructor
            \ No newline at end of file +PluginSupportConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface PluginSupportConstructor

            interface PluginSupportConstructor {
                new PluginSupportConstructornew (pluginManager: PluginManager): PluginSupportImpl;
            }

            Constructors

            constructor +

            Constructors

            constructor

            Settings

            Member Visibility

            On This Page

            Constructors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_plugin_manager.PluginSupportImpl.html b/docs/interfaces/_runtime_plugin_manager.PluginSupportImpl.html index a52e2d54..cec8ef5e 100644 --- a/docs/interfaces/_runtime_plugin_manager.PluginSupportImpl.html +++ b/docs/interfaces/_runtime_plugin_manager.PluginSupportImpl.html @@ -1,11 +1,12 @@ -PluginSupportImpl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface PluginSupportImpl

            Describes the interface that all PluginSupport classes must implement.

            -
            interface PluginSupportImpl {
                destroy(opts): Promise<void>;
                setEventbus(opts): void;
                setOptions(options): void;
            }

            Implemented by

            Methods

            destroy +PluginSupportImpl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface PluginSupportImpl

            Describes the interface that all PluginSupport classes must implement.

            +
            interface PluginSupportImpl {
                destroy(opts: {
                    eventbus: Eventbus;
                    eventPrepend: string;
                }): Promise<void>;
                setEventbus(opts: {
                    newEventbus: Eventbus;
                    newPrepend: string;
                    oldEventbus: Eventbus;
                    oldPrepend: string;
                }): void;
                setOptions(options: PluginManagerOptions): void;
            }

            Implemented by

            Methods

            destroy setEventbus setOptions -

            Methods

            destroy

            • destroy(opts): Promise<void>

            • Destroys all managed plugins after unloading them.

              -

              Parameters

              • opts: {
                    eventPrepend: string;
                    eventbus: Eventbus;
                }

                An options object.

                -
                • eventPrepend: string

                  The current event prepend.

                  -
                • eventbus: Eventbus

                  The eventbus to disassociate.

                  +

            Methods

            destroy

            • destroy(opts): Promise<void>

            • Destroys all managed plugins after unloading them.

              +

              Parameters

              • opts: {
                    eventbus: Eventbus;
                    eventPrepend: string;
                }

                An options object.

                +
                • eventbus: Eventbus

                  The eventbus to disassociate.

                  +
                • eventPrepend: string

                  The current event prepend.

              Returns Promise<void>

            setEventbus

            • setEventbus(opts): void

            • Sets the eventbus associated with this plugin manager. If any previous eventbus was associated all plugin manager events will be removed then added to the new eventbus. If there are any existing plugins being managed their events will be removed from the old eventbus and then 'onPluginLoad' will be called with the new eventbus.

              @@ -16,4 +17,4 @@
            • oldPrepend: string

              The old event prepend.

            Returns void

            setOptions

            • setOptions(options): void

            • Set optional parameters.

              Parameters

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            destroysetEventbussetOptions
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_application.ApplicationState.html b/docs/interfaces/_runtime_svelte_application.ApplicationState.html index f8344751..661260fd 100644 --- a/docs/interfaces/_runtime_svelte_application.ApplicationState.html +++ b/docs/interfaces/_runtime_svelte_application.ApplicationState.html @@ -1,7 +1,8 @@ -ApplicationState | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface ApplicationState

            Provides the ability the save / restore / serialize application state for positional and UI state such as minimized +ApplicationState | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface ApplicationState

            Provides the ability the save / restore / serialize application state for positional and UI state such as minimized status.

            You can restore a saved state with animation; please see the options of ApplicationState.restore.

            -
            interface ApplicationState {
                clear(): void;
                current(extra?): ApplicationStateData;
                get(options): ApplicationStateData;
                keys(): IterableIterator<string>;
                remove(options): ApplicationStateData;
                restore(options): ApplicationStateData;
                save(options): ApplicationStateData;
                set(data, options?): void;
            }

            Methods

            clear +
            interface ApplicationState {
                clear(): void;
                current(extra?: object): ApplicationStateData;
                get(options: {
                    name: string;
                }): ApplicationStateData;
                keys(): IterableIterator<string>;
                remove(options: {
                    name: string;
                }): ApplicationStateData;
                restore(options: {
                    animateTo?: boolean;
                    duration?: number;
                    ease?: EasingReference;
                    name: string;
                    remove?: boolean;
                }): ApplicationStateData;
                save(options: {
                    extra?: any[];
                    name: string;
                }): ApplicationStateData;
                set(data: ApplicationStateData, options?: {
                    animateTo?: boolean;
                    async?: boolean;
                    duration?: number;
                    ease?: EasingReference;
                }): void;
            }

            Methods

            clear current get keys @@ -9,9 +10,9 @@ restore save set -

            Methods

            clear

            • clear(): void

            • Clears all saved application state.

              +

            Methods

            clear

            • clear(): void

            • Clears all saved application state.

              Returns void

            current

            • current(extra?): ApplicationStateData

            • Returns current application state along with any extra data passed into method.

              -

              Parameters

              • Optional extra: object

                Extra data to add to application state.

                +

                Parameters

                • Optionalextra: object

                  Extra data to add to application state.

                Returns ApplicationStateData

                Passed in object with current application state.

            get

            • get(options): ApplicationStateData

            • Gets any saved application state by name.

              Parameters

              • options: {
                    name: string;
                }

                Options.

                @@ -24,27 +25,27 @@

            Returns ApplicationStateData

            Any saved application state.

            restore

            • restore(options): ApplicationStateData

            • Restores a previously saved application state by name returning the data. Several optional parameters are available to animate / tween to the new state. When animateTo is true an animation is scheduled via -AnimationAPI.to and the duration and easing name or function may be specified.

              +AnimationAPI.to and the duration and easing name or function may be specified.

              Parameters

              • options: {
                    animateTo?: boolean;
                    duration?: number;
                    ease?: EasingReference;
                    name: string;
                    remove?: boolean;
                }

                Parameters

                -
                • Optional animateTo?: boolean

                  Animate to restore data.

                  -
                • Optional duration?: number

                  Duration in seconds.

                  -
                • Optional ease?: EasingReference

                  Easing function name or function.

                  +
                  • OptionalanimateTo?: boolean

                    Animate to restore data.

                    +
                  • Optionalduration?: number

                    Duration in seconds.

                    +
                  • Optionalease?: EasingReference

                    Easing function name or function.

                  • name: string

                    Saved data set name.

                    -
                  • Optional remove?: boolean

                    Remove data set.

                    +
                  • Optionalremove?: boolean

                    Remove data set.

              Returns ApplicationStateData

              Any saved application state.

            save

            • save(options): ApplicationStateData

            • Saves current application state with the opportunity to add extra data to the saved state.

              Parameters

              • options: {
                    extra?: any[];
                    name: string;
                }

                Options.

                -
                • Optional extra?: any[]

                  Extra data to add to saved state.

                  +
                  • Optionalextra?: any[]

                    Extra data to add to saved state.

                  • name: string

                    Name to index this saved state.

              Returns ApplicationStateData

              Current saved application state.

            set

            • set(data, options?): void

            • Sets application state from the given ApplicationStateData instance. Several optional parameters are available to animate / tween to the new state. When animateTo is true an animation is scheduled via -AnimationAPI.to and the duration and easing name or function may be specified.

              +AnimationAPI.to and the duration and easing name or function may be specified.

              Note: If serializing application state any minimized apps will use the before minimized state on initial render of the app as it is currently not possible to render apps with Foundry VTT core API in the minimized state.

              Parameters

              • data: ApplicationStateData

                Saved data set name.

                -
              • Optional options: {
                    animateTo?: boolean;
                    async?: boolean;
                    duration?: number;
                    ease?: EasingReference;
                }

                Optional parameters

                -
                • Optional animateTo?: boolean

                  Animate to restore data.

                  -
                • Optional async?: boolean
                • Optional duration?: number

                  Duration in seconds.

                  -
                • Optional ease?: EasingReference

                  Easing function.

                  -

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            clearcurrentgetkeysremoverestoresaveset
            \ No newline at end of file +
          • Optionaloptions: {
                animateTo?: boolean;
                async?: boolean;
                duration?: number;
                ease?: EasingReference;
            }

            Optional parameters

            +
            • OptionalanimateTo?: boolean

              Animate to restore data.

              +
            • Optionalasync?: boolean
            • Optionalduration?: number

              Duration in seconds.

              +
            • Optionalease?: EasingReference

              Easing function.

              +

            • Returns void

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_application.GetSvelteData.html b/docs/interfaces/_runtime_svelte_application.GetSvelteData.html index a59f54db..02bcba2e 100644 --- a/docs/interfaces/_runtime_svelte_application.GetSvelteData.html +++ b/docs/interfaces/_runtime_svelte_application.GetSvelteData.html @@ -1,5 +1,6 @@ -GetSvelteData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface GetSvelteData

            Provides a mechanism to retrieve and query all mounted Svelte components including the main application shell.

            -
            interface GetSvelteData {
                get applicationShell(): MountedAppShell;
                get length(): number;
                component(index): object;
                componentEntries(): IterableIterator<[number, SvelteComponent<any, any, any>]>;
                componentValues(): IterableIterator<SvelteComponent<any, any, any>>;
                data(index): SvelteData;
                dataByComponent(component): SvelteData;
                dataEntries(): IterableIterator<[number, SvelteData]>;
                dataValues(): IterableIterator<SvelteData>;
            }

            Accessors

            applicationShell +GetSvelteData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface GetSvelteData

            Provides a mechanism to retrieve and query all mounted Svelte components including the main application shell.

            +
            interface GetSvelteData {
                get applicationShell(): MountedAppShell;
                get length(): number;
                component(index: number): object;
                componentEntries(): IterableIterator<[number, SvelteComponent<any, any, any>]>;
                componentValues(): IterableIterator<SvelteComponent<any, any, any>>;
                data(index: number): SvelteData;
                dataByComponent(component: SvelteComponent<any, any, any>): SvelteData;
                dataEntries(): IterableIterator<[number, SvelteData]>;
                dataValues(): IterableIterator<SvelteData>;
            }

            Accessors

            applicationShell length

            Methods

            component componentEntries @@ -8,18 +9,18 @@ dataByComponent dataEntries dataValues -

            Accessors

            applicationShell

            Accessors

            applicationShell

            length

            • get length(): number

            • Returns the length of the mounted Svelte component list.

              Returns number

              Length of mounted Svelte component list.

              -

            Methods

            component

            • component(index): object

            • Returns the indexed Svelte component.

              +

            Methods

            component

            • component(index): object

            • Returns the indexed Svelte component.

              Parameters

              • index: number

                The index of Svelte component to retrieve.

              Returns object

              The loaded Svelte component.

            componentEntries

            componentValues

            componentValues

            data

            • data(index): SvelteData

            • Returns the indexed SvelteData entry.

              +

              Yields

            data

            • data(index): SvelteData

            • Returns the indexed SvelteData entry.

              Parameters

              • index: number

                The index of SvelteData instance to retrieve.

              Returns SvelteData

              The loaded Svelte config + component.

            dataByComponent

            dataValues

            Settings

            Member Visibility

            Theme

            On This Page

            applicationShelllengthcomponentcomponentEntriescomponentValuesdatadataByComponentdataEntriesdataValues
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_application.SvelteReactive.html b/docs/interfaces/_runtime_svelte_application.SvelteReactive.html index 8d0922ef..54843008 100644 --- a/docs/interfaces/_runtime_svelte_application.SvelteReactive.html +++ b/docs/interfaces/_runtime_svelte_application.SvelteReactive.html @@ -1,4 +1,5 @@ -SvelteReactive | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface SvelteReactive

            Contains the reactive functionality / Svelte stores associated with SvelteApplication and retrievable by +SvelteReactive | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface SvelteReactive

            Contains the reactive functionality / Svelte stores associated with SvelteApplication and retrievable by SvelteApplication.reactive.

            There are several reactive getters for UI state such and for two-way bindings / stores see SvelteReactive.storeUIState:

            @@ -31,9 +32,10 @@

            This API is not sealed, and it is recommended that you extend it with accessors to get / set data that is reactive in your application. An example of setting an exported prop document from the main mounted application shell.

            -

            Example

            import { hasSetter } from '#runtime/util/object';

            // Note: make a normal comment.
            //  * @member {object} document - Adds accessors to SvelteReactive to get / set the document associated with
            //  *                             Document with the mounted application shell Svelte component.
            //  *
            //  * @memberof SvelteReactive#
            //  *
            Object.defineProperty(this.reactive, 'document', {
               get: () => this.svelte?.applicationShell?.document,
               set: (document) =>
               {
                  const component = this.svelte?.applicationShell;
                  if (hasSetter(component, 'document')) { component.document = document; }
               }
            });
-
            -
            interface SvelteReactive {
                activeWindow: Window;
                draggable: boolean;
                get dragging(): boolean;
                focusAuto: boolean;
                focusKeep: boolean;
                focusTrap: boolean;
                headerButtonNoClose: boolean;
                headerButtonNoLabel: boolean;
                headerIcon: string;
                headerNoTitleMinimized: boolean;
                minimizable: boolean;
                get minimized(): boolean;
                popOut: boolean;
                positionable: boolean;
                resizable: boolean;
                get resizing(): boolean;
                get sessionStorage(): TJSWebStorage;
                get storeAppOptions(): StoreAppOptions;
                get storeUIState(): StoreUIOptions;
                title: string;
                getOptions(accessor, defaultValue?): any;
                mergeOptions(options): void;
                setOptions(accessor, value): void;
                toJSON(): SvelteReactiveData;
                updateHeaderButtons(opts?): void;
            }

            Accessors

            activeWindow +

            Example

            import { hasSetter } from '#runtime/util/object';

            // Note: make a normal comment.
            //  * @member {object} document - Adds accessors to SvelteReactive to get / set the document associated with
            //  *                             Document with the mounted application shell Svelte component.
            //  *
            //  * @memberof SvelteReactive#
            //  *
            Object.defineProperty(this.reactive, 'document', {
               get: () => this.svelte?.applicationShell?.document,
               set: (document) =>
               {
                  const component = this.svelte?.applicationShell;
                  if (hasSetter(component, 'document')) { component.document = document; }
               }
            });
+
            + +
            interface SvelteReactive {
                activeWindow: Window;
                draggable: boolean;
                get dragging(): boolean;
                focusAuto: boolean;
                focusKeep: boolean;
                focusTrap: boolean;
                headerButtonNoClose: boolean;
                headerButtonNoLabel: boolean;
                headerIcon: string;
                headerNoTitleMinimized: boolean;
                minimizable: boolean;
                get minimized(): boolean;
                popOut: boolean;
                positionable: boolean;
                resizable: boolean;
                get resizing(): boolean;
                get sessionStorage(): TJSWebStorage;
                get storeAppOptions(): StoreAppOptions;
                get storeUIState(): StoreUIOptions;
                title: string;
                getOptions(accessor: string, defaultValue?: any): any;
                mergeOptions(options: object): void;
                setOptions(accessor: string, value: any): void;
                toJSON(): SvelteReactiveData;
                updateHeaderButtons(opts?: {
                    headerButtonNoClose?: boolean;
                    headerButtonNoLabel?: boolean;
                }): void;
            }

            Accessors

            activeWindow draggable dragging focusAuto @@ -58,7 +60,7 @@ setOptions toJSON updateHeaderButtons -

            Accessors

            activeWindow

            • get activeWindow(): Window

            • Returns the current active Window / WindowProxy UI state.

              +

            Accessors

            activeWindow

            • get activeWindow(): Window

            • Returns the current active Window / WindowProxy UI state.

              Returns Window

              Active window UI state.

            • set activeWindow(activeWindow): void

            • Sets the current active Window / WindowProxy UI state.

              Note: This is protected usage and used internally.

              @@ -128,11 +130,11 @@
            • set title(title): void

            • Sets this.options.title which is reactive for application shells.

              Note: Will set empty string if title is undefined or null.

              Parameters

              • title: string

                Application title; will be localized, so a translation key is fine.

                -

              Returns void

            Methods

            getOptions

            • getOptions(accessor, defaultValue?): any

            • Provides a way to safely get this applications options given an accessor string which describes the +

            Returns void

            Methods

            getOptions

            • getOptions(accessor, defaultValue?): any

            • Provides a way to safely get this applications options given an accessor string which describes the entries to walk. To access deeper entries into the object format the accessor string with . between entries to walk.

              Parameters

              • accessor: string

                The path / key to set. You can set multiple levels.

                -
              • Optional defaultValue: any

                A default value returned if the accessor is not found.

                +
              • OptionaldefaultValue: any

                A default value returned if the accessor is not found.

              Returns any

              Value at the accessor.

            mergeOptions

            • mergeOptions(options): void

            • Provides a way to merge options into this applications options and update the appOptions store.

              Parameters

              • options: object

                The options object to merge with this.options.

                @@ -151,7 +153,7 @@

                Optionally you can set in the SvelteApplication app options SvelteApplicationOptions.headerButtonNoClose to remove the close button and SvelteApplicationOptions.headerButtonNoLabel to true and labels will be removed from the header buttons.

                -

                Parameters

                • Optional opts: {
                      headerButtonNoClose?: boolean;
                      headerButtonNoLabel?: boolean;
                  }

                  Optional parameters (for internal use)

                  -
                  • Optional headerButtonNoClose?: boolean

                    The value for headerButtonNoClose.

                    -
                  • Optional headerButtonNoLabel?: boolean

                    The value for headerButtonNoLabel.

                    -

                Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            activeWindowdraggabledraggingfocusAutofocusKeepfocusTrapheaderButtonNoCloseheaderButtonNoLabelheaderIconheaderNoTitleMinimizedminimizableminimizedpopOutpositionableresizableresizingsessionStoragestoreAppOptionsstoreUIStatetitlegetOptionsmergeOptionssetOptionstoJSONupdateHeaderButtons
            \ No newline at end of file +

            Parameters

            • Optionalopts: {
                  headerButtonNoClose?: boolean;
                  headerButtonNoLabel?: boolean;
              }

              Optional parameters (for internal use)

              +
              • OptionalheaderButtonNoClose?: boolean

                The value for headerButtonNoClose.

                +
              • OptionalheaderButtonNoLabel?: boolean

                The value for headerButtonNoLabel.

                +

            Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_application.TJSDialogData.html b/docs/interfaces/_runtime_svelte_application.TJSDialogData.html index 9b8d52aa..bf5fcf47 100644 --- a/docs/interfaces/_runtime_svelte_application.TJSDialogData.html +++ b/docs/interfaces/_runtime_svelte_application.TJSDialogData.html @@ -1,6 +1,7 @@ -TJSDialogData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TJSDialogData

            Provides storage for all dialog options through individual accessors and get, merge, replace and set methods +TJSDialogData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface TJSDialogData

            Provides storage for all dialog options through individual accessors and get, merge, replace and set methods that safely access and update data changed to the mounted DialogShell component reactively.

            -
            interface TJSDialogData {
                buttons: Record<string, TJSDialogButtonData>;
                content: string | TJSSvelteConfig;
                default: string;
                draggable: boolean;
                focusAuto: boolean;
                focusFirst: boolean;
                focusKeep: boolean;
                minimizable: boolean;
                modal: boolean;
                modalOptions: TJSDialogModalOptions;
                notifyError: boolean;
                onClose: string | ((data?) => any);
                rejectClose: boolean;
                resizable: boolean;
                resolveId: boolean;
                title: string;
                transition: TJSDialogTransitionOptions;
                zIndex: number;
                clone(): TJSDialogOptions;
                get(accessor, defaultValue?): any;
                merge(data): void;
                replace(data): void;
                set(accessor, value): boolean;
            }

            Accessors

            buttons +
            interface TJSDialogData {
                buttons: Record<string, TJSDialogButtonData>;
                content: string | TJSSvelteConfig;
                default: string;
                draggable: boolean;
                focusAuto: boolean;
                focusFirst: boolean;
                focusKeep: boolean;
                minimizable: boolean;
                modal: boolean;
                modalOptions: TJSDialogModalOptions;
                notifyError: boolean;
                onClose: string | ((data?: {
                    application?: TJSDialog;
                }) => any);
                rejectClose: boolean;
                resizable: boolean;
                resolveId: boolean;
                title: string;
                transition: TJSDialogTransitionOptions;
                zIndex: number;
                clone(): TJSDialogOptions;
                get(accessor: string, defaultValue?: any): any;
                merge(data: TJSDialogOptions): void;
                replace(data: any): void;
                set(accessor: string, value: any): boolean;
            }

            Accessors

            buttons content default draggable @@ -23,7 +24,7 @@ merge replace set -

            Accessors

            buttons

            Accessors

            buttons

            content

            • get content(): string | TJSSvelteConfig

            • Returns string | TJSSvelteConfig

              The Svelte configuration object or HTML string content.

              @@ -57,22 +58,22 @@
            • set notifyError(notifyError): void

            • Set the dialog notifyError state. When true and an error is raised in dialog callback functions post a UI error notification.

              Parameters

              • notifyError: boolean

                New dialog notifyError state.

                -

              Returns void

            onClose

            • get onClose(): string | ((data?) => any)

            • Returns string | ((data?) => any)

              Callback invoked when dialog is - closed; no button option selected. When defined as a string any matching function by name exported from - content Svelte component is invoked.

              +

            Returns void

            onClose

            • get onClose(): string | ((data?: {
                  application?: TJSDialog;
              }) => any)

            • Returns string | ((data?: {
                  application?: TJSDialog;
              }) => any)

              Callback invoked when dialog is +closed; no button option selected. When defined as a string any matching function by name exported from +content Svelte component is invoked.

            • set onClose(onClose): void

            • Set callback invoked when dialog is closed; no button option selected. When defined as a string any matching function by name exported from content Svelte component is invoked..

              -

              Parameters

              • onClose: string | ((data?) => any)

                New dialog onClose state.

                +

                Parameters

                • onClose: string | ((data?: {
                      application?: TJSDialog;
                  }) => any)

                  New dialog onClose state.

                Returns void

            rejectClose

            • get rejectClose(): boolean

            • Returns boolean

              Dialog rejectClose state. When true and a Promise has been created by TJSDialog.wait - and the Promise is not in the process of being resolved or rejected on close of the dialog any onClose - function is invoked and any result that is undefined will cause the Promise to then be rejected..

              +and the Promise is not in the process of being resolved or rejected on close of the dialog any onClose +function is invoked and any result that is undefined will cause the Promise to then be rejected..

            • set rejectClose(rejectClose): void

            • Set the dialog rejectClose state.

              Parameters

              • rejectClose: boolean

                New dialog rejectClose state.

              Returns void

            resizable

            • get resizable(): boolean

            • Returns boolean

              When true the dialog is resizable.

            • set resizable(resizable): void

            • Set the dialog resizable state. When true the dialog is resizable.

              Parameters

              • resizable: boolean

                New dialog resizable state.

              Returns void

            resolveId

            • get resolveId(): boolean

            • Returns boolean

              When true and resolving any Promises and there are undefined results from any button callbacks - the button ID is resolved.

              +the button ID is resolved.

            • set resolveId(resolveId): void

            • Set the dialog resolveId state. When true and resolving any Promises and there are undefined results from any button callbacks the button ID is resolved.

              Parameters

              • resolveId: boolean

                New dialog resolveId state.

                @@ -83,17 +84,17 @@
              • set transition(transition): void

              • Set transition options for the dialog.

                Parameters

                Returns void

            zIndex

            • get zIndex(): number

            • Returns number

              A specific z-index for the dialog. Pass null for the dialog to act like other - applications in regard bringing to top when activated.

              +applications in regard bringing to top when activated.

            • set zIndex(zIndex): void

            • Set specific z-index for the dialog.

              Parameters

              • zIndex: number

                New z-index for the dialog.

                -

              Returns void

            Methods

            clone

            Returns void

            Methods

            clone

            • clone(): TJSDialogOptions

            • Provides a cloned copy of the dialog data. Note: The content attribute is not cloned as complex / props may be present.

              Returns TJSDialogOptions

              A clone of the dialog data.

            get

            • get(accessor, defaultValue?): any

            • Provides a way to safely get this dialogs data given an accessor string which describes the entries to walk. To access deeper entries into the object format the accessor string with . between entries to walk.

              Parameters

              • accessor: string

                The path / key to set. You can set multiple levels.

                -
              • Optional defaultValue: any

                A default value returned if the accessor is not found.

                +
              • OptionaldefaultValue: any

                A default value returned if the accessor is not found.

              Returns any

              Value at the accessor.

            merge

            • merge(data): void

            • Parameters

              Returns void

            replace

            • replace(data): void

            • Replaces all dialog data; this is reactive.

              @@ -105,4 +106,4 @@

              Parameters

              • accessor: string

                The path / key to set. You can set multiple levels.

              • value: any

                Value to set.

              Returns boolean

              True if successful.

              -

            Settings

            Member Visibility

            Theme

            On This Page

            buttonscontentdefaultdraggablefocusAutofocusFirstfocusKeepminimizablemodalmodalOptionsnotifyErroronCloserejectCloseresizableresolveIdtitletransitionzIndexclonegetmergereplaceset
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_gsap.Action.DraggableGsapOptionsStore.html b/docs/interfaces/_runtime_svelte_gsap.Action.DraggableGsapOptionsStore.html index 42aa7564..cf838d9c 100644 --- a/docs/interfaces/_runtime_svelte_gsap.Action.DraggableGsapOptionsStore.html +++ b/docs/interfaces/_runtime_svelte_gsap.Action.DraggableGsapOptionsStore.html @@ -1,7 +1,8 @@ -DraggableGsapOptionsStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface DraggableGsapOptionsStore

            Provides an interface of the draggableGsap action options support / Readable store to make updating / +DraggableGsapOptionsStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface DraggableGsapOptionsStore

            Provides an interface of the draggableGsap action options support / Readable store to make updating / setting draggableGsap options much easier. When subscribing to the options instance returned by draggableGsap.options the Subscriber handler receives the entire instance.

            -
            interface DraggableGsapOptionsStore {
                inertia: boolean;
                inertiaOptions: GsapInertiaOptions;
                tween: boolean;
                tweenOptions: GsapTweenOptions;
                set inertiaDuration(duration: {
                    max: number;
                    min: number;
                });
                inertiaDurationMax: number;
                inertiaDurationMin: number;
                inertiaEnd: number | Function | any[];
                inertiaResistance: number;
                inertiaVelocityScale: number;
                tweenDuration: number;
                tweenEase: string | Function;
                reset(): void;
                resetInertia(): void;
                resetInertiaOptions(): void;
                resetTween(): void;
                resetTweenOptions(): void;
                subscribe(this, run, invalidate?): Unsubscriber;
            }

            Hierarchy (view full)

            Accessors

            inertiaDuration +
            interface DraggableGsapOptionsStore {
                inertia: boolean;
                inertiaOptions: GsapInertiaOptions;
                tween: boolean;
                tweenOptions: GsapTweenOptions;
                set inertiaDuration(duration: {
                    max: number;
                    min: number;
                });
                inertiaDurationMax: number;
                inertiaDurationMin: number;
                inertiaEnd: number | Function | any[];
                inertiaResistance: number;
                inertiaVelocityScale: number;
                tweenDuration: number;
                tweenEase: string | Function;
                reset(): void;
                resetInertia(): void;
                resetInertiaOptions(): void;
                resetTween(): void;
                resetTweenOptions(): void;
                subscribe(this: void, run: Subscriber<DraggableGsapOptionsStore>, invalidate?: Invalidator<DraggableGsapOptionsStore>): Unsubscriber;
            }

            Hierarchy (view full)

            Accessors

            inertiaDuration inertiaDurationMax inertiaDurationMin inertiaEnd @@ -19,15 +20,15 @@ inertiaOptions tween tweenOptions -

            Accessors

            inertiaDuration

            • set inertiaDuration(duration): void

            • Parameters

              • duration: {
                    max: number;
                    min: number;
                }

                Set inertia duration min & max.

                +

            Accessors

            inertiaDuration

            • set inertiaDuration(duration): void

            • Parameters

              • duration: {
                    max: number;
                    min: number;
                }

                Set inertia duration min & max.

                • max: number
                • min: number

              Returns void

            inertiaDurationMax

            • get inertiaDurationMax(): number

            • Returns number

              Get inertia duration max time (seconds)

            • set inertiaDurationMax(max): void

            • Parameters

              • max: number

                Set inertia duration max.

              Returns void

            inertiaDurationMin

            • get inertiaDurationMin(): number

            • Returns number

              Get inertia duration min time (seconds)

            • set inertiaDurationMin(min): void

            • Parameters

              • min: number

                Set inertia duration min.

              Returns void

            inertiaEnd

            Returns void

            See

            end https://greensock.com/docs/v3/Plugins/InertiaPlugin

            inertiaResistance

            • get inertiaResistance(): number

            • Returns number

              Get inertia resistance (1000 is default).

            • set inertiaResistance(resistance): void

            • Parameters

              • resistance: number

                Set inertia resistance. Default: 1000

              Returns void

            inertiaVelocityScale

            • get inertiaVelocityScale(): number

            • Returns number

              Get inertia velocity scale.

              @@ -36,16 +37,16 @@
            • set tweenDuration(duration): void

            • Parameters

              • duration: number

                Set ease duration.

              Returns void

            tweenEase

            • get tweenEase(): string | Function

            • Returns string | Function

              Get easing function value.

            • set tweenEase(value): void

            • Parameters

              • value: string | Function

                Get easing function value.

                -

              Returns void

            Methods

            reset

            • reset(): void

            • Resets all options data to initial values.

              +

            Returns void

            Methods

            reset

            • reset(): void

            • Resets all options data to initial values.

              Returns void

            resetInertia

            • resetInertia(): void

            • Resets inertia enabled state to initial value.

              Returns void

            resetInertiaOptions

            • resetInertiaOptions(): void

            • Resets inertia options to initial values.

              Returns void

            resetTween

            • resetTween(): void

            • Resets tween enabled state to initial value.

              Returns void

            resetTweenOptions

            • resetTweenOptions(): void

            • Resets tween options to initial values.

              Returns void

            subscribe

            Properties

            inertia

            inertia: boolean

            Inertia enabled state.

            +
          • Optionalinvalidate: Invalidator<DraggableGsapOptionsStore>

            cleanup callback

            +

            • Returns Unsubscriber

            Properties

            inertia

            inertia: boolean

            Inertia enabled state.

            inertiaOptions

            inertiaOptions: GsapInertiaOptions

            Inertia options.

            tween

            tween: boolean

            Tweening enabled state.

            tweenOptions

            tweenOptions: GsapTweenOptions

            GSAP tween options for easing function and duration.

            -

            Settings

            Member Visibility

            Theme

            On This Page

            inertiaDurationinertiaDurationMaxinertiaDurationMininertiaEndinertiaResistanceinertiaVelocityScaletweenDurationtweenEaseresetresetInertiaresetInertiaOptionsresetTweenresetTweenOptionssubscribeinertiainertiaOptionstweentweenOptions
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_fvtt_document.EmbeddedAPI.html b/docs/interfaces/_runtime_svelte_store_fvtt_document.EmbeddedAPI.html index 46b9d7bc..5dab49f4 100644 --- a/docs/interfaces/_runtime_svelte_store_fvtt_document.EmbeddedAPI.html +++ b/docs/interfaces/_runtime_svelte_store_fvtt_document.EmbeddedAPI.html @@ -1,12 +1,13 @@ -EmbeddedAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface EmbeddedAPI

            Provides the public embedded reactive collection API.

            -
            interface EmbeddedAPI {
                create<T>(doc, options): DynMapReducer<string, InstanceType<T>>;
                destroy<T>(doc?, storeName?): boolean;
                get<T>(doc, storeName): DynMapReducer<string, InstanceType<T>>;
            }

            Methods

            create +EmbeddedAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface EmbeddedAPI

            Provides the public embedded reactive collection API.

            +
            interface EmbeddedAPI {
                create<T>(doc: T, options: DynOptionsMapCreate<string, InstanceType<T>>): DynMapReducer<string, InstanceType<T>>;
                destroy<T>(doc?: T, storeName?: string): boolean;
                get<T>(doc: T, storeName: string): DynMapReducer<string, InstanceType<T>>;
            }

            Methods

            create destroy get -

            Methods

            create

            Methods

            create

            destroy

            • destroy<T>(doc?, storeName?): boolean
              • Destroys one or more embedded collection stores.
              -

              Type Parameters

              Parameters

              • Optional doc: T
              • Optional storeName: string

              Returns boolean

            get

            get

            Settings

            Member Visibility

            Theme

            On This Page

            createdestroyget
            \ No newline at end of file +

            Type Parameters

            Parameters

            • doc: T
            • storeName: string

            Returns DynMapReducer<string, InstanceType<T>>

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_fvtt_document.NamedDocumentConstructor.html b/docs/interfaces/_runtime_svelte_store_fvtt_document.NamedDocumentConstructor.html index 83f86443..c1cc41f5 100644 --- a/docs/interfaces/_runtime_svelte_store_fvtt_document.NamedDocumentConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_fvtt_document.NamedDocumentConstructor.html @@ -1,4 +1,5 @@ -NamedDocumentConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface NamedDocumentConstructor

            Provides a basic duck type for Foundry documents. Expects a constructor / class w/ static property name.

            -
            interface NamedDocumentConstructor {
                new NamedDocumentConstructornew (...args): any;
                documentName: string;
            }

            Constructors

            constructor +NamedDocumentConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface NamedDocumentConstructor

            Provides a basic duck type for Foundry documents. Expects a constructor / class w/ static property name.

            +
            interface NamedDocumentConstructor {
                new NamedDocumentConstructornew (...args: any[]): any;
                documentName: string;
            }

            Constructors

            constructor

            Properties

            documentName -

            Constructors

            constructor

            • new NamedDocumentConstructor(...args): any

            • Parameters

              • Rest ...args: any[]

              Returns any

            Properties

            Readonly documentName

            documentName: string

            Settings

            Member Visibility

            Theme

            On This Page

            constructordocumentName
            \ No newline at end of file +

            Constructors

            constructor

            • new NamedDocumentConstructor(...args): any

            • Parameters

              • Rest...args: any[]

              Returns any

            Properties

            ReadonlydocumentName

            documentName: string

            Settings

            Member Visibility

            On This Page

            Constructors
            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_fvtt_settings.UIControl.html b/docs/interfaces/_runtime_svelte_store_fvtt_settings.UIControl.html index 8acf44c1..92cedf0b 100644 --- a/docs/interfaces/_runtime_svelte_store_fvtt_settings.UIControl.html +++ b/docs/interfaces/_runtime_svelte_store_fvtt_settings.UIControl.html @@ -1,20 +1,21 @@ -UIControl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface UIControl

            Controls preparation and processing of registered game settings w/ TJSGameSettings. Game settings are parsed +UIControl | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface UIControl

            Controls preparation and processing of registered game settings w/ TJSGameSettings. Game settings are parsed for UI display by TJSSettingsEdit. The store showSettings is utilized in TJSSettingsSwap component to provide an easy way to flip between settings component or any main slotted component.

            -
            interface UIControl {
                showSettings: boolean;
                get stores(): {
                    showSettings: Readable<boolean>;
                };
                addSection(options): void;
                create(options?): TJSSettingsUIData;
                swapShowSettings(): boolean;
            }

            Accessors

            showSettings +
            interface UIControl {
                showSettings: boolean;
                get stores(): {
                    showSettings: Readable<boolean>;
                };
                addSection(options: TJSSettingsCustomSection): void;
                create(options?: TJSSettingsCreateOptions): TJSSettingsUIData;
                swapShowSettings(): boolean;
            }

            Accessors

            showSettings stores

            Methods

            addSection create swapShowSettings -

            Accessors

            showSettings

            • get showSettings(): boolean

            • Returns boolean

              Current showSettings state.

              +

            Accessors

            showSettings

            • get showSettings(): boolean

            • Returns boolean

              Current showSettings state.

            • set showSettings(showSettings): void

            • Sets current showSettings state.

              Parameters

              • showSettings: boolean

                New showSettings state.

              Returns void

            stores

            • get stores(): {
                  showSettings: Readable<boolean>;
              }

            • Returns {
                  showSettings: Readable<boolean>;
              }

              Returns the managed stores.

              -

            Methods

            addSection

            • addSection(options): void

            • Adds a custom section / folder defined by the provided TJSSettingsCustomSection options object.

              +

            Methods

            addSection

            • addSection(options): void

            • Adds a custom section / folder defined by the provided TJSSettingsCustomSection options object.

              Parameters

              Returns void

            create

            swapShowSettings

            • swapShowSettings(): boolean

            • Convenience method to swap showSettings.

              Returns boolean

              New showSettings state.

              -

            Settings

            Member Visibility

            Theme

            On This Page

            showSettingsstoresaddSectioncreateswapShowSettings
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.Action.DraggableOptionsStore.html b/docs/interfaces/_runtime_svelte_store_position.Action.DraggableOptionsStore.html index e9af1282..76030071 100644 --- a/docs/interfaces/_runtime_svelte_store_position.Action.DraggableOptionsStore.html +++ b/docs/interfaces/_runtime_svelte_store_position.Action.DraggableOptionsStore.html @@ -1,7 +1,8 @@ -DraggableOptionsStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface DraggableOptionsStore

            Provides an interface of the draggable action options support / Readable store to make updating / setting +DraggableOptionsStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface DraggableOptionsStore

            Provides an interface of the draggable action options support / Readable store to make updating / setting draggable options much easier. When subscribing to the options instance returned by draggable.options the Subscriber handler receives the entire instance.

            -
            interface DraggableOptionsStore {
                tween: boolean;
                tweenOptions: QuickTweenOptions;
                tweenDuration: number;
                tweenEase: EasingReference;
                reset(): void;
                resetTween(): void;
                resetTweenOptions(): void;
                subscribe(this, run, invalidate?): Unsubscriber;
            }

            Hierarchy (view full)

            Accessors

            tweenDuration +
            interface DraggableOptionsStore {
                tween: boolean;
                tweenOptions: QuickTweenOptions;
                tweenDuration: number;
                tweenEase: EasingReference;
                reset(): void;
                resetTween(): void;
                resetTweenOptions(): void;
                subscribe(this: void, run: Subscriber<DraggableOptionsStore>, invalidate?: Invalidator<DraggableOptionsStore>): Unsubscriber;
            }

            Hierarchy (view full)

            Accessors

            tweenDuration tweenEase

            Methods

            reset resetTween @@ -9,16 +10,16 @@ subscribe

            Properties

            tween tweenOptions -

            Accessors

            tweenDuration

            • get tweenDuration(): number

            • Returns number

              Get tween duration.

              +

            Accessors

            tweenDuration

            • get tweenDuration(): number

            • Returns number

              Get tween duration.

            • set tweenDuration(duration): void

            • Parameters

              • duration: number

                Set tween duration.

              Returns void

            tweenEase

            Methods

            reset

            • reset(): void

            • Resets all options data to initial values.

              +

            Returns void

            Methods

            reset

            • reset(): void

            • Resets all options data to initial values.

              Returns void

            resetTween

            • resetTween(): void

            • Resets tween enabled state to initial value.

              Returns void

            resetTweenOptions

            • resetTweenOptions(): void

            • Resets tween options to initial values.

              Returns void

            subscribe

            Properties

            tween

            tween: boolean

            Tweening enabled state.

            +
          • Optionalinvalidate: Invalidator<DraggableOptionsStore>

            cleanup callback

            +

            • Returns Unsubscriber

            Properties

            tween

            tween: boolean

            Tweening enabled state.

            tweenOptions

            tweenOptions: QuickTweenOptions

            Quick tween options for easing function and duration.

            -

            Settings

            Member Visibility

            Theme

            On This Page

            tweenDurationtweenEaseresetresetTweenresetTweenOptionssubscribetweentweenOptions
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupDataCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupDataCallback.html index d8eef22f..b8a3b680 100644 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupDataCallback.html +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupDataCallback.html @@ -1,10 +1,11 @@ -GroupDataCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface GroupDataCallback

            Defines a callback to process each TJSPosition / TJSPositionTypes.Positionable instance allowing +GroupDataCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface GroupDataCallback

            Defines a callback to process each TJSPosition / TJSPositionTypes.Positionable instance allowing different position data to be assigned to each instance in the grouped animation.

            -
            interface GroupDataCallback ((options?) => TJSPositionDataRelative)
            • GroupDataCallback(options?): TJSPositionDataRelative

            • Parameters

              • Optionaloptions: GroupCallbackOptions

                The group callback options defining the order of the current +position / positionable being processed.

              Returns TJSPositionDataRelative

              • The unique position data target to animate for this position / - positionable instance. When null or undefined is returned the current position / positionable is - removed from the animation.
                • +positionable instance. When null or undefined is returned the current position / positionable is +removed from the animation.
              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Settings

            Member Visibility
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickToCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickToCallback.html index 3c730ae5..96a21805 100644 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickToCallback.html +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickToCallback.html @@ -1,13 +1,14 @@ -GroupQuickToCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface GroupQuickToCallback

            The quickTo callback function returned from AnimationGroupAPI.quickTo. Extends QuickToCallback +GroupQuickToCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface GroupQuickToCallback

            The quickTo callback function returned from AnimationGroupAPI.quickTo. Extends QuickToCallback accepting functions for setting each instance of group with new position data and / or options.

            -
            interface GroupQuickToCallback {
                keys: AnimationKey[];
                options: ((options) => GroupQuickToCallback);
                (arg): void;
                (...args): void;
                (arg): void;
            }

            Hierarchy (view full)

            • GroupQuickToCallback(arg): void

            • Parameters

              • arg: GroupDataCallback

                A callback function invoked for unique positional data for each instance of the group.

                -

              Returns void

            • GroupQuickToCallback(...args): void

            • Parameters

              • Rest ...args: (string | number)[]

                Individual numbers or relative strings corresponding to the order in which animation keys are +

            interface GroupQuickToCallback {
                keys: AnimationKey[];
                options: ((options: QuickTweenOptions | GroupQuickTweenOptionsCallback) => GroupQuickToCallback);
                (arg: GroupDataCallback): void;
                (...args: (string | number)[]): void;
                (arg: Partial<Record<AnimationKey, string | number>>): void;
            }

            Hierarchy (view full)

            • GroupQuickToCallback(arg): void

            • Parameters

              • arg: GroupDataCallback

                A callback function invoked for unique positional data for each instance of the group.

                +

              Returns void

            • GroupQuickToCallback(...args): void

            • Parameters

              • Rest...args: (string | number)[]

                Individual numbers or relative strings corresponding to the order in which animation keys are specified.

              Returns void

            • GroupQuickToCallback(arg): void

            • Parameters

              • arg: Partial<Record<AnimationKey, string | number>>

                A single object with animation keys specified and numerical or relative string values.

                -

              Returns void

            Properties

            keys +

            Returns void

            Properties

            keys options -

            Properties

            Readonly keys

            keys: AnimationKey[]

            The keys assigned for this quickTo callback.

            -

            options

            options: ((options) => GroupQuickToCallback)

            Sets options of quickTo tween.

            +

            Properties

            Readonlykeys

            keys: AnimationKey[]

            The keys assigned for this quickTo callback.

            +

            options

            options: ((options: QuickTweenOptions | GroupQuickTweenOptionsCallback) => GroupQuickToCallback)

            Sets options of quickTo tween.

            Type declaration

            Returns

            This quickTo callback function.

            -

            Settings

            Member Visibility

            Theme

            On This Page

            keysoptions
            \ No newline at end of file +

            Returns GroupQuickToCallback

            This quickTo callback function.

            +

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickTweenOptionsCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickTweenOptionsCallback.html index 4d78466b..3cf6f673 100644 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickTweenOptionsCallback.html +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickTweenOptionsCallback.html @@ -1,9 +1,10 @@ -GroupQuickTweenOptionsCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface GroupQuickTweenOptionsCallback

            Defines a callback to process each TJSPosition / TJSPositionTypes.Positionable instance allowing +GroupQuickTweenOptionsCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface GroupQuickTweenOptionsCallback

            Defines a callback to process each TJSPosition / TJSPositionTypes.Positionable instance allowing different quick tween options to be assigned to each instance in the grouped animation.

            -
            interface GroupQuickTweenOptionsCallback ((options?) => QuickTweenOptions)
            • GroupQuickTweenOptionsCallback(options?): QuickTweenOptions

            • Parameters

              • Optional options: GroupCallbackOptions

                The group callback options defining the order of the current - position / positionable being processed.

                +
            • GroupQuickTweenOptionsCallback(options?): QuickTweenOptions

            • Parameters

              • Optionaloptions: GroupCallbackOptions

                The group callback options defining the order of the current +position / positionable being processed.

              Returns QuickTweenOptions

              • The unique quick tween options to set for this position / positionable instance. - When null or undefined is returned the current position / positionable is removed from the animation.
                • +When null or undefined is returned the current position / positionable is removed from the animation.
              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Settings

            Member Visibility
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupTweenOptionsCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupTweenOptionsCallback.html index 85b21c3e..d178e1cf 100644 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupTweenOptionsCallback.html +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupTweenOptionsCallback.html @@ -1,9 +1,10 @@ -GroupTweenOptionsCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface GroupTweenOptionsCallback

            Defines a callback to process each TJSPosition / TJSPositionTypes.Positionable instance allowing +GroupTweenOptionsCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface GroupTweenOptionsCallback

            Defines a callback to process each TJSPosition / TJSPositionTypes.Positionable instance allowing different tween options to be assigned to each instance in the grouped animation.

            -
            interface GroupTweenOptionsCallback ((options?) => TweenOptions)
            • GroupTweenOptionsCallback(options?): TweenOptions

            • Parameters

              • Optional options: GroupCallbackOptions

                The group callback options defining the order of the current - position / positionable being processed.

                +
            • GroupTweenOptionsCallback(options?): TweenOptions

            • Parameters

              • Optionaloptions: GroupCallbackOptions

                The group callback options defining the order of the current +position / positionable being processed.

              Returns TweenOptions

              • The unique tween options to set for this position / positionable instance. When null - or undefined is returned the current position / positionable is removed from the animation.
                • +or undefined is returned the current position / positionable is removed from the animation.
              -

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Settings

            Member Visibility
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.QuickToCallback.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.QuickToCallback.html index f103e7b4..288520c1 100644 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.QuickToCallback.html +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.QuickToCallback.html @@ -1,11 +1,12 @@ -QuickToCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface QuickToCallback

            The quickTo callback function returned from AnimationAPI.quickTo.

            -
            interface QuickToCallback {
                keys: AnimationKey[];
                options: ((options) => QuickToCallback);
                (...args): void;
                (arg): void;
            }

            Hierarchy (view full)

            Properties

            keys options -

            Properties

            Readonly keys

            keys: AnimationKey[]

            The keys assigned for this quickTo callback.

            -

            options

            options: ((options) => QuickToCallback)

            Sets options of quickTo tween.

            +

            Properties

            Readonlykeys

            keys: AnimationKey[]

            The keys assigned for this quickTo callback.

            +

            options

            options: ((options: QuickTweenOptions) => QuickToCallback)

            Sets options of quickTo tween.

            Type declaration

            Returns

            This quickTo callback function.

            -

            Settings

            Member Visibility

            Theme

            On This Page

            keysoptions
            \ No newline at end of file +

            Returns QuickToCallback

            This quickTo callback function.

            +

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.html b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.html index aef1d22e..c6f34c03 100644 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.html @@ -1,30 +1,31 @@ -AnimationAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface AnimationAPI

            interface AnimationAPI {
                get isScheduled(): boolean;
                cancel(): void;
                from(fromData, options?): BasicAnimation;
                fromTo(fromData, toData, options?): BasicAnimation;
                getScheduled(): BasicAnimation[];
                quickTo(keys, options?): QuickToCallback;
                to(toData, options?): BasicAnimation;
            }

            Accessors

            isScheduled +AnimationAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface AnimationAPI

            interface AnimationAPI {
                get isScheduled(): boolean;
                cancel(): void;
                from(fromData: TJSPositionDataRelative, options?: TweenOptions): BasicAnimation;
                fromTo(fromData: TJSPositionDataRelative, toData: TJSPositionDataRelative, options?: TweenOptions): BasicAnimation;
                getScheduled(): BasicAnimation[];
                quickTo(keys: Iterable<AnimationKey>, options?: QuickTweenOptions): QuickToCallback;
                to(toData: TJSPositionDataRelative, options?: TweenOptions): BasicAnimation;
            }

            Accessors

            isScheduled

            Methods

            cancel from fromTo getScheduled quickTo to -

            Accessors

            isScheduled

            • get isScheduled(): boolean

            • Returns if there are scheduled animations whether active or pending for this TJSPosition instance.

              +

            Accessors

            isScheduled

            • get isScheduled(): boolean

            • Returns if there are scheduled animations whether active or pending for this TJSPosition instance.

              Returns boolean

              Are there scheduled animations.

              -

            Methods

            cancel

            • cancel(): void

            • Cancels all animation instances for this TJSPosition instance.

              +

            Methods

            cancel

            • cancel(): void

            • Cancels all animation instances for this TJSPosition instance.

              Returns void

            from

            • from(fromData, options?): BasicAnimation

            • Provides a tween from given position data to the current position.

              Parameters

              Returns BasicAnimation

              A control object that can cancel animation and provides a finished Promise.

            fromTo

            getScheduled

            • getScheduled(): BasicAnimation[]

            • Returns all currently scheduled AnimationControl instances for this TJSPosition instance.

              Returns BasicAnimation[]

              All currently scheduled animation controls for this TJSPosition instance.

            quickTo

            to

            • to(toData, options?): BasicAnimation

            • Provides a tween to given position data from the current position.

              Parameters

              Returns BasicAnimation

              A control object that can cancel animation and provides a finished Promise.

              -

            Settings

            Member Visibility

            Theme

            On This Page

            isScheduledcancelfromfromTogetScheduledquickToto
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.AnimationGroupAPI.html b/docs/interfaces/_runtime_svelte_store_position.AnimationGroupAPI.html index a4eaf619..28ab53da 100644 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationGroupAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationGroupAPI.html @@ -1,7 +1,8 @@ -AnimationGroupAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface AnimationGroupAPI

            Provides a public API for grouping multiple TJSPosition animations together and is accessible from +AnimationGroupAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface AnimationGroupAPI

            Provides a public API for grouping multiple TJSPosition animations together and is accessible from TJSPosition.Animate.

            -

            See

            AnimationAPI

            -
            interface AnimationGroupAPI {
                cancel(positionGroup): void;
                cancelAll(): void;
                from(positionGroup, fromData, options?): BasicAnimation;
                fromTo(positionGroup, fromData, toData, options?): BasicAnimation;
                getScheduled(positionGroup): {
                    controls: BasicAnimation[];
                    entry: Positionable;
                    position: TJSPosition;
                }[];
                isAnimationKey(key): key is AnimationKey;
                isScheduled(positionGroup, options?): boolean;
                quickTo(positionGroup, keys, options?): GroupQuickToCallback;
                to(positionGroup, toData, options?): BasicAnimation;
            }

            Methods

            cancel +

            See

            AnimationAPI

            +
            interface AnimationGroupAPI {
                cancel(positionGroup: PositionGroup): void;
                cancelAll(): void;
                from(positionGroup: PositionGroup, fromData: TJSPositionDataRelative | GroupDataCallback, options?: TweenOptions | GroupTweenOptionsCallback): BasicAnimation;
                fromTo(positionGroup: PositionGroup, fromData: TJSPositionDataRelative | GroupDataCallback, toData: TJSPositionDataRelative | GroupDataCallback, options?: TweenOptions | GroupTweenOptionsCallback): BasicAnimation;
                getScheduled(positionGroup: PositionGroup): {
                    controls: BasicAnimation[];
                    entry: Positionable;
                    position: TJSPosition;
                }[];
                isAnimationKey(key: unknown): key is AnimationKey;
                isScheduled(positionGroup: PositionGroup, options?: ScheduleOptions): boolean;
                quickTo(positionGroup: PositionGroup, keys: Iterable<AnimationKey>, options?: QuickTweenOptions | GroupQuickTweenOptionsCallback): GroupQuickToCallback;
                to(positionGroup: PositionGroup, toData: TJSPositionDataRelative | GroupDataCallback, options?: TweenOptions | GroupTweenOptionsCallback): BasicAnimation;
            }

            Methods

            cancel cancelAll from fromTo @@ -10,24 +11,24 @@ isScheduled quickTo to -

            Methods

            cancel

            • cancel(positionGroup): void

            • Cancels any animation for given PositionGroup data.

              +

            Methods

            cancel

            • cancel(positionGroup): void

            • Cancels any animation for given PositionGroup data.

              Parameters

              Returns void

            cancelAll

            • cancelAll(): void

            • Cancels all TJSPosition animation.

              Returns void

            from

            • from(positionGroup, fromData, options?): BasicAnimation

            • Provides the from animation tween for one or more positionable instances as a group.

              Parameters

              • positionGroup: PositionGroup

                A position group.

              • fromData: TJSPositionDataRelative | GroupDataCallback

                A position data object assigned - to all positionable instances or a callback function invoked for unique data for each instance.

                -
              • Optional options: TweenOptions | GroupTweenOptionsCallback

                Tween options assigned - to all positionable instances or a callback function invoked for unique options for each instance.

                +to all positionable instances or a callback function invoked for unique data for each instance.

                +
              • Optionaloptions: TweenOptions | GroupTweenOptionsCallback

                Tween options assigned +to all positionable instances or a callback function invoked for unique options for each instance.

              Returns BasicAnimation

              Basic animation control.

            fromTo

            • fromTo(positionGroup, fromData, toData, options?): BasicAnimation

            • Provides the fromTo animation tween for one or more positionable instances as a group.

              Parameters

              • positionGroup: PositionGroup

                A position group.

              • fromData: TJSPositionDataRelative | GroupDataCallback

                A position data object - assigned to all positionable instances or a callback function invoked for unique data for each instance.

                +assigned to all positionable instances or a callback function invoked for unique data for each instance.

              • toData: TJSPositionDataRelative | GroupDataCallback

                A position data object assigned - to all positionable instances or a callback function invoked for unique data for each instance.

                -
              • Optional options: TweenOptions | GroupTweenOptionsCallback

                Tween options assigned - to all positionable instances or a callback function invoked for unique options for each instance.

                +to all positionable instances or a callback function invoked for unique data for each instance.

                +
              • Optionaloptions: TweenOptions | GroupTweenOptionsCallback

                Tween options assigned +to all positionable instances or a callback function invoked for unique options for each instance.

              Returns BasicAnimation

              Basic animation control.

            getScheduled

            • getScheduled(positionGroup): {
                  controls: BasicAnimation[];
                  entry: Positionable;
                  position: TJSPosition;
              }[]

            • Gets all animation controls for the given position group data.

              Parameters

              • positionGroup: PositionGroup

                A position group.

                @@ -37,20 +38,20 @@

              Returns key is AnimationKey

              Whether the given key is an animation key.

            isScheduled

            • isScheduled(positionGroup, options?): boolean

            • Returns the status for the entire position group specified if all position instances of the group are scheduled.

              Parameters

              Returns boolean

              True if all are scheduled / false if just one position instance in the group is not scheduled.

            quickTo

            to

            • to(positionGroup, toData, options?): BasicAnimation

            • Provides the to animation tween for one or more positionable instances as a group.

              Parameters

              • positionGroup: PositionGroup

                A position group.

              • toData: TJSPositionDataRelative | GroupDataCallback

                A position data object assigned - to all positionable instances or a callback function invoked for unique data for each instance.

                -
              • Optional options: TweenOptions | GroupTweenOptionsCallback

                Tween options assigned - to all positionable instances or a callback function invoked for unique options for each instance.

                +to all positionable instances or a callback function invoked for unique data for each instance.

                +
              • Optionaloptions: TweenOptions | GroupTweenOptionsCallback

                Tween options assigned +to all positionable instances or a callback function invoked for unique options for each instance.

              Returns BasicAnimation

              Basic animation control.

              -

            Settings

            Member Visibility

            Theme

            On This Page

            cancelcancelAllfromfromTogetScheduledisAnimationKeyisScheduledquickToto
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html b/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html index 6bb475e6..ff137f62 100644 --- a/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html +++ b/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html @@ -1,6 +1,7 @@ -TJSPositionData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TJSPositionData

            Defines the primary TJSPosition data object used by various TJSPosition APIs. To externally create a new instance +TJSPositionData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface TJSPositionData

            Defines the primary TJSPosition data object used by various TJSPosition APIs. To externally create a new instance use the static accessor TJSPosition.Data.

            -
            interface TJSPositionData {
                height: number | "auto" | "inherit";
                left: number;
                maxHeight: number;
                maxWidth: number;
                minHeight: number;
                minWidth: number;
                rotateX: number;
                rotateY: number;
                rotateZ: number;
                rotation: number;
                scale: number;
                top: number;
                transformOrigin: TransformOrigin;
                translateX: number;
                translateY: number;
                translateZ: number;
                width: number | "auto" | "inherit";
                zIndex: number;
            }

            Properties

            height +
            interface TJSPositionData {
                height: number | "auto" | "inherit";
                left: number;
                maxHeight: number;
                maxWidth: number;
                minHeight: number;
                minWidth: number;
                rotateX: number;
                rotateY: number;
                rotateZ: number;
                rotation: number;
                scale: number;
                top: number;
                transformOrigin: TransformOrigin;
                translateX: number;
                translateY: number;
                translateZ: number;
                width: number | "auto" | "inherit";
                zIndex: number;
            }

            Properties

            height left maxHeight maxWidth @@ -18,4 +19,4 @@ translateZ width zIndex -

            Properties

            height

            height: number | "auto" | "inherit"

            left

            left: number

            maxHeight

            maxHeight: number

            maxWidth

            maxWidth: number

            minHeight

            minHeight: number

            minWidth

            minWidth: number

            rotateX

            rotateX: number

            rotateY

            rotateY: number

            rotateZ

            rotateZ: number

            rotation

            rotation: number

            scale

            scale: number

            top

            top: number

            transformOrigin

            transformOrigin: TransformOrigin

            translateX

            translateX: number

            translateY

            translateY: number

            translateZ

            translateZ: number

            width

            width: number | "auto" | "inherit"

            zIndex

            zIndex: number

            Settings

            Member Visibility

            Theme

            On This Page

            heightleftmaxHeightmaxWidthminHeightminWidthrotateXrotateYrotateZrotationscaletoptransformOrigintranslateXtranslateYtranslateZwidthzIndex
            \ No newline at end of file +

            Properties

            height

            height: number | "auto" | "inherit"

            left

            left: number

            maxHeight

            maxHeight: number

            maxWidth

            maxWidth: number

            minHeight

            minHeight: number

            minWidth

            minWidth: number

            rotateX

            rotateX: number

            rotateY

            rotateY: number

            rotateZ

            rotateZ: number

            rotation

            rotation: number

            scale

            scale: number

            top

            top: number

            transformOrigin

            transformOrigin: TransformOrigin

            translateX

            translateX: number

            translateY

            translateY: number

            translateZ

            translateZ: number

            width

            width: number | "auto" | "inherit"

            zIndex

            zIndex: number

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataConstructor.html b/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataConstructor.html index f6fd1f38..c1560f80 100644 --- a/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataConstructor.html @@ -1,3 +1,4 @@ -TJSPositionDataConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TJSPositionDataConstructor

            Defines the constructor function for TJSPositionData.

            -
            interface TJSPositionDataConstructor {
                new TJSPositionDataConstructornew (__namedParameters?): TJSPositionData;
            }

            Constructors

            constructor -

            Constructors

            constructor

            • new TJSPositionDataConstructor(__namedParameters?): TJSPositionData

            • Parameters

              • Optional __namedParameters: {
                    height?: number | "auto" | "inherit";
                    left?: number;
                    maxHeight?: number;
                    maxWidth?: number;
                    minHeight?: number;
                    minWidth?: number;
                    rotateX?: number;
                    rotateY?: number;
                    rotateZ?: number;
                    rotation?: number;
                    scale?: number;
                    top?: number;
                    transformOrigin?: TransformOrigin;
                    translateX?: number;
                    translateY?: number;
                    translateZ?: number;
                    width?: number | "auto" | "inherit";
                    zIndex?: number;
                }
                • Optional height?: number | "auto" | "inherit"
                • Optional left?: number
                • Optional maxHeight?: number
                • Optional maxWidth?: number
                • Optional minHeight?: number
                • Optional minWidth?: number
                • Optional rotateX?: number
                • Optional rotateY?: number
                • Optional rotateZ?: number
                • Optional rotation?: number
                • Optional scale?: number
                • Optional top?: number
                • Optional transformOrigin?: TransformOrigin
                • Optional translateX?: number
                • Optional translateY?: number
                • Optional translateZ?: number
                • Optional width?: number | "auto" | "inherit"
                • Optional zIndex?: number

              Returns TJSPositionData

            Settings

            Member Visibility

            Theme

            On This Page

            constructor
            \ No newline at end of file +TJSPositionDataConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface TJSPositionDataConstructor

            Defines the constructor function for TJSPositionData.

            +
            interface TJSPositionDataConstructor {
                new TJSPositionDataConstructornew (__namedParameters?: {
                    height?: number | "auto" | "inherit";
                    left?: number;
                    maxHeight?: number;
                    maxWidth?: number;
                    minHeight?: number;
                    minWidth?: number;
                    rotateX?: number;
                    rotateY?: number;
                    rotateZ?: number;
                    rotation?: number;
                    scale?: number;
                    top?: number;
                    transformOrigin?: TransformOrigin;
                    translateX?: number;
                    translateY?: number;
                    translateZ?: number;
                    width?: number | "auto" | "inherit";
                    zIndex?: number;
                }): TJSPositionData;
            }

            Constructors

            constructor +

            Constructors

            constructor

            • new TJSPositionDataConstructor(__namedParameters?): TJSPositionData

            • Parameters

              • Optional__namedParameters: {
                    height?: number | "auto" | "inherit";
                    left?: number;
                    maxHeight?: number;
                    maxWidth?: number;
                    minHeight?: number;
                    minWidth?: number;
                    rotateX?: number;
                    rotateY?: number;
                    rotateZ?: number;
                    rotation?: number;
                    scale?: number;
                    top?: number;
                    transformOrigin?: TransformOrigin;
                    translateX?: number;
                    translateY?: number;
                    translateZ?: number;
                    width?: number | "auto" | "inherit";
                    zIndex?: number;
                }
                • Optionalheight?: number | "auto" | "inherit"
                • Optionalleft?: number
                • OptionalmaxHeight?: number
                • OptionalmaxWidth?: number
                • OptionalminHeight?: number
                • OptionalminWidth?: number
                • OptionalrotateX?: number
                • OptionalrotateY?: number
                • OptionalrotateZ?: number
                • Optionalrotation?: number
                • Optionalscale?: number
                • Optionaltop?: number
                • OptionaltransformOrigin?: TransformOrigin
                • OptionaltranslateX?: number
                • OptionaltranslateY?: number
                • OptionaltranslateZ?: number
                • Optionalwidth?: number | "auto" | "inherit"
                • OptionalzIndex?: number

              Returns TJSPositionData

            Settings

            Member Visibility

            On This Page

            Constructors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataExtra.html b/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataExtra.html index c62ec7d2..fad58c88 100644 --- a/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataExtra.html +++ b/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataExtra.html @@ -1,5 +1,6 @@ -TJSPositionDataExtra | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TJSPositionDataExtra

            Defines a TJSPositionData instance that has extra properties / attributes.

            -
            interface TJSPositionDataExtra {
                height?: number | "auto" | "inherit";
                left?: number;
                maxHeight?: number;
                maxWidth?: number;
                minHeight?: number;
                minWidth?: number;
                rotateX?: number;
                rotateY?: number;
                rotateZ?: number;
                rotation?: number;
                scale?: number;
                top?: number;
                transformOrigin?: TransformOrigin;
                translateX?: number;
                translateY?: number;
                translateZ?: number;
                width?: number | "auto" | "inherit";
                zIndex?: number;
                [key: string]: any;
            }

            Hierarchy

            Indexable

            [key: string]: any

            Properties

            height? +TJSPositionDataExtra | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface TJSPositionDataExtra

            Defines a TJSPositionData instance that has extra properties / attributes.

            +
            interface TJSPositionDataExtra {
                height?: number | "auto" | "inherit";
                left?: number;
                maxHeight?: number;
                maxWidth?: number;
                minHeight?: number;
                minWidth?: number;
                rotateX?: number;
                rotateY?: number;
                rotateZ?: number;
                rotation?: number;
                scale?: number;
                top?: number;
                transformOrigin?: TransformOrigin;
                translateX?: number;
                translateY?: number;
                translateZ?: number;
                width?: number | "auto" | "inherit";
                zIndex?: number;
                [key: string]: any;
            }

            Hierarchy

            Indexable

            • [key: string]: any

            Properties

            height? left? maxHeight? maxWidth? @@ -17,4 +18,4 @@ translateZ? width? zIndex? -

            Properties

            Optional height

            height?: number | "auto" | "inherit"

            Optional left

            left?: number

            Optional maxHeight

            maxHeight?: number

            Optional maxWidth

            maxWidth?: number

            Optional minHeight

            minHeight?: number

            Optional minWidth

            minWidth?: number

            Optional rotateX

            rotateX?: number

            Optional rotateY

            rotateY?: number

            Optional rotateZ

            rotateZ?: number

            Optional rotation

            rotation?: number

            Optional scale

            scale?: number

            Optional top

            top?: number

            Optional transformOrigin

            transformOrigin?: TransformOrigin

            Optional translateX

            translateX?: number

            Optional translateY

            translateY?: number

            Optional translateZ

            translateZ?: number

            Optional width

            width?: number | "auto" | "inherit"

            Optional zIndex

            zIndex?: number

            Settings

            Member Visibility

            Theme

            On This Page

            heightleftmaxHeightmaxWidthminHeightminWidthrotateXrotateYrotateZrotationscaletoptransformOrigintranslateXtranslateYtranslateZwidthzIndex
            \ No newline at end of file +

            Properties

            Optionalheight

            height?: number | "auto" | "inherit"

            Optionalleft

            left?: number

            OptionalmaxHeight

            maxHeight?: number

            OptionalmaxWidth

            maxWidth?: number

            OptionalminHeight

            minHeight?: number

            OptionalminWidth

            minWidth?: number

            OptionalrotateX

            rotateX?: number

            OptionalrotateY

            rotateY?: number

            OptionalrotateZ

            rotateZ?: number

            Optionalrotation

            rotation?: number

            Optionalscale

            scale?: number

            Optionaltop

            top?: number

            OptionaltransformOrigin

            transformOrigin?: TransformOrigin

            OptionaltranslateX

            translateX?: number

            OptionaltranslateY

            translateY?: number

            OptionaltranslateZ

            translateZ?: number

            Optionalwidth

            width?: number | "auto" | "inherit"

            OptionalzIndex

            zIndex?: number

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.PositionStateAPI.html b/docs/interfaces/_runtime_svelte_store_position.PositionStateAPI.html index ee623097..8bb499ff 100644 --- a/docs/interfaces/_runtime_svelte_store_position.PositionStateAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.PositionStateAPI.html @@ -1,4 +1,5 @@ -PositionStateAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface PositionStateAPI

            interface PositionStateAPI {
                clear(): void;
                get(options): TJSPositionDataExtra;
                getDefault(): TJSPositionDataExtra;
                keys(): IterableIterator<string>;
                remove(options): TJSPositionDataExtra;
                reset(options?): boolean;
                restore(options): TJSPositionDataExtra | Promise<TJSPositionDataExtra>;
                save(options, optionsGet?): TJSPositionDataExtra;
                set(options): void;
            }

            Methods

            clear +PositionStateAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface PositionStateAPI

            interface PositionStateAPI {
                clear(): void;
                get(options: {
                    name: string;
                }): TJSPositionDataExtra;
                getDefault(): TJSPositionDataExtra;
                keys(): IterableIterator<string>;
                remove(options: {
                    name: string;
                }): TJSPositionDataExtra;
                reset(options?: {
                    invokeSet?: boolean;
                    keepZIndex?: boolean;
                }): boolean;
                restore(options: {
                    animateTo?: boolean;
                    async?: boolean;
                    duration?: number;
                    ease?: EasingReference;
                    name: string;
                    properties?: Iterable<string>;
                    remove?: boolean;
                    silent?: boolean;
                }): TJSPositionDataExtra | Promise<TJSPositionDataExtra>;
                save(options: {
                    name: string;
                    [key: string]: any;
                }, optionsGet?: OptionsGet): TJSPositionDataExtra;
                set(options: {
                    name: string;
                    [key: string]: any;
                }): void;
            }

            Methods

            clear get getDefault keys @@ -7,7 +8,7 @@ restore save set -

            Methods

            clear

            • clear(): void

            • Clears all saved position data except any default state.

              +

            Methods

            clear

            • clear(): void

            • Clears all saved position data except any default state.

              Returns void

            get

            • get(options): TJSPositionDataExtra

            • Gets any stored saved position data by name.

              Parameters

              • options: {
                    name: string;
                }

                Options.

                • name: string

                  Saved data name.

                  @@ -20,34 +21,34 @@
                  • name: string

                    Name to remove and retrieve.

              Returns TJSPositionDataExtra

              Any saved position data.

            reset

            • reset(options?): boolean

            • Resets position instance to default data and invokes set.

              -

              Parameters

              • Optional options: {
                    invokeSet?: boolean;
                    keepZIndex?: boolean;
                }

                Optional parameters.

                -
                • Optional invokeSet?: boolean

                  When true invokes set method.

                  -
                • Optional keepZIndex?: boolean

                  When true keeps current z-index.

                  +

                  Parameters

                  • Optionaloptions: {
                        invokeSet?: boolean;
                        keepZIndex?: boolean;
                    }

                    Optional parameters.

                    +
                    • OptionalinvokeSet?: boolean

                      When true invokes set method.

                      +
                    • OptionalkeepZIndex?: boolean

                      When true keeps current z-index.

                  Returns boolean

                  Operation successful.

            restore

            • restore(options): TJSPositionDataExtra | Promise<TJSPositionDataExtra>

            • Restores a saved positional state returning the data. Several optional parameters are available to control whether the restore action occurs silently (no store / inline styles updates), animates to the stored data, or simply sets the stored data. Restoring via AnimationAPI.to allows specification of the duration and easing along with configuring a Promise to be returned if awaiting the end of the animation.

              Parameters

              • options: {
                    animateTo?: boolean;
                    async?: boolean;
                    duration?: number;
                    ease?: EasingReference;
                    name: string;
                    properties?: Iterable<string>;
                    remove?: boolean;
                    silent?: boolean;
                }

                Parameters

                -
                • Optional animateTo?: boolean

                  Animate to restore data.

                  -
                • Optional async?: boolean

                  If animating return a Promise that resolves with any saved - data.

                  -
                • Optional duration?: number

                  Duration in seconds.

                  -
                • Optional ease?: EasingReference

                  Easing function name or function.

                  +
                  • OptionalanimateTo?: boolean

                    Animate to restore data.

                    +
                  • Optionalasync?: boolean

                    If animating return a Promise that resolves with any saved +data.

                    +
                  • Optionalduration?: number

                    Duration in seconds.

                    +
                  • Optionalease?: EasingReference

                    Easing function name or function.

                  • name: string

                    Saved data set name.

                    -
                  • Optional properties?: Iterable<string>

                    Specific properties to set / animate.

                    -
                  • Optional remove?: boolean

                    Remove data set.

                    -
                  • Optional silent?: boolean

                    Set position data directly; no store or style updates.

                    +
                  • Optionalproperties?: Iterable<string>

                    Specific properties to set / animate.

                    +
                  • Optionalremove?: boolean

                    Remove data set.

                    +
                  • Optionalsilent?: boolean

                    Set position data directly; no store or style updates.

              Returns TJSPositionDataExtra | Promise<TJSPositionDataExtra>

              Any saved - position data.

              +position data.

            save

            • save(options, optionsGet?): TJSPositionDataExtra

            • Saves current position state with the opportunity to add extra data to the saved state. Simply include extra properties in options to save extra data.

              Parameters

              • options: {
                    name: string;
                    [key: string]: any;
                }

                Options.

                • [key: string]: any
                • name: string

                  name to index this saved data.

                  -
              • Optional optionsGet: OptionsGet

                Additional options for - TJSPosition.get when serializing position state. By default, nullable values are included.

                +
            • OptionaloptionsGet: OptionsGet

              Additional options for +TJSPosition.get when serializing position state. By default, nullable values are included.

            Returns TJSPositionDataExtra

            Current position data

            set

            • set(options): void

            • Directly sets a saved position state. Simply include extra properties in options to set extra data.

              Parameters

              • options: {
                    name: string;
                    [key: string]: any;
                }

                Options.

                • [key: string]: any
                • name: string

                  name to index this saved data.

                  -

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            cleargetgetDefaultkeysremoveresetrestoresaveset
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystem.html b/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystem.html index c50163b8..b9f8359e 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystem.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystem.html @@ -1,5 +1,6 @@ -InitialSystem | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface InitialSystem

            Provides helper functions to initially position an element.

            -
            interface InitialSystem {
                constrain: boolean;
                element: HTMLElement;
                enabled: boolean;
                height: number;
                get locked(): boolean;
                width: number;
                getLeft(width): number;
                getTop(height): number;
                setDimension(width, height): void;
            }

            Hierarchy (view full)

            Accessors

            constrain +InitialSystem | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface InitialSystem

            Provides helper functions to initially position an element.

            +
            interface InitialSystem {
                constrain: boolean;
                element: HTMLElement;
                enabled: boolean;
                height: number;
                get locked(): boolean;
                width: number;
                getLeft(width: number): number;
                getTop(height: number): number;
                setDimension(width: number, height: number): void;
            }

            Hierarchy (view full)

            Accessors

            constrain element enabled height @@ -8,7 +9,7 @@

            Methods

            getLeft getTop setDimension -

            Accessors

            constrain

            • get constrain(): boolean

            • Returns boolean

              The current constrain state.

              +

            Accessors

            constrain

            • get constrain(): boolean

            • Returns boolean

              The current constrain state.

            • set constrain(constrain): void

            • Parameters

              • constrain: boolean

                Set constrain state.

              Returns void

            element

            • get element(): HTMLElement

            • Returns HTMLElement

              Target element.

            • set element(element): void

            • Parameters

              • element: HTMLElement

                Set target element.

                @@ -19,7 +20,7 @@

              Returns void

            locked

            • get locked(): boolean

            • Returns boolean

              Get locked state.

            width

            • get width(): number

            • Returns number

              Get manual width.

            • set width(width): void

            • Parameters

              • width: number

                Set manual width.

                -

              Returns void

            Methods

            getLeft

            • getLeft(width): number

            • Get the left constraint.

              +

            Returns void

            Methods

            getLeft

            • getLeft(width): number

            • Get the left constraint.

              Parameters

              • width: number

                Target width.

              Returns number

              Calculated left constraint.

            getTop

            • getTop(height): number

            • Get the top constraint.

              @@ -28,4 +29,4 @@

            setDimension

            • setDimension(width, height): void

            • Set manual width & height.

              Parameters

              • width: number

                New manual width.

              • height: number

                New manual height.

                -

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            constrainelementenabledheightlockedwidthgetLeftgetTopsetDimension
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystemConstructor.html b/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystemConstructor.html index 20ba7037..1e824741 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystemConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystemConstructor.html @@ -1,10 +1,11 @@ -InitialSystemConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface InitialSystemConstructor

            Describes the constructor function for an InitialSystem implementation.

            -
            interface InitialSystemConstructor {
                new InitialSystemConstructornew (options?): InitialSystem;
            }

            Constructors

            constructor -

            Constructors

            constructor

            • new InitialSystemConstructor(options?): InitialSystem

            • Parameters

              • Optional options: {
                    constrain?: boolean;
                    element?: HTMLElement;
                    enabled?: boolean;
                    height?: number;
                    lock?: boolean;
                    width?: number;
                }

                Initial options.

                -
                • Optional constrain?: boolean

                  Constrain state.

                  -
                • Optional element?: HTMLElement

                  Target element.

                  -
                • Optional enabled?: boolean

                  Enabled state.

                  -
                • Optional height?: number

                  Manual height.

                  -
                • Optional lock?: boolean

                  Lock parameters from being set.

                  -
                • Optional width?: number

                  Manual width.

                  -

              Returns InitialSystem

            Settings

            Member Visibility

            Theme

            On This Page

            constructor
            \ No newline at end of file +InitialSystemConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface InitialSystemConstructor

            Describes the constructor function for an InitialSystem implementation.

            +
            interface InitialSystemConstructor {
                new InitialSystemConstructornew (options?: {
                    constrain?: boolean;
                    element?: HTMLElement;
                    enabled?: boolean;
                    height?: number;
                    lock?: boolean;
                    width?: number;
                }): InitialSystem;
            }

            Constructors

            constructor +

            Constructors

            constructor

            • new InitialSystemConstructor(options?): InitialSystem

            • Parameters

              • Optionaloptions: {
                    constrain?: boolean;
                    element?: HTMLElement;
                    enabled?: boolean;
                    height?: number;
                    lock?: boolean;
                    width?: number;
                }

                Initial options.

                +
                • Optionalconstrain?: boolean

                  Constrain state.

                  +
                • Optionalelement?: HTMLElement

                  Target element.

                  +
                • Optionalenabled?: boolean

                  Enabled state.

                  +
                • Optionalheight?: number

                  Manual height.

                  +
                • Optionallock?: boolean

                  Lock parameters from being set.

                  +
                • Optionalwidth?: number

                  Manual width.

                  +

              Returns InitialSystem

            Settings

            Member Visibility

            On This Page

            Constructors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.System.SystemBase.html b/docs/interfaces/_runtime_svelte_store_position.System.SystemBase.html index e12c0b1d..432addf7 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.SystemBase.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.SystemBase.html @@ -1,11 +1,12 @@ -SystemBase | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface SystemBase

            interface SystemBase {
                constrain: boolean;
                element: HTMLElement;
                enabled: boolean;
                height: number;
                get locked(): boolean;
                width: number;
                setDimension(width, height): void;
            }

            Hierarchy (view full)

            Accessors

            constrain +SystemBase | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface SystemBase

            interface SystemBase {
                constrain: boolean;
                element: HTMLElement;
                enabled: boolean;
                height: number;
                get locked(): boolean;
                width: number;
                setDimension(width: number, height: number): void;
            }

            Hierarchy (view full)

            Accessors

            constrain element enabled height locked width

            Methods

            setDimension -

            Accessors

            constrain

            • get constrain(): boolean

            • Returns boolean

              The current constrain state.

              +

            Accessors

            constrain

            • get constrain(): boolean

            • Returns boolean

              The current constrain state.

            • set constrain(constrain): void

            • Parameters

              • constrain: boolean

                Set constrain state.

              Returns void

            element

            • get element(): HTMLElement

            • Returns HTMLElement

              Target element.

            • set element(element): void

            • Parameters

              • element: HTMLElement

                Set target element.

                @@ -16,7 +17,7 @@

              Returns void

            locked

            • get locked(): boolean

            • Returns boolean

              Get locked state.

            width

            • get width(): number

            • Returns number

              Get manual width.

            • set width(width): void

            • Parameters

              • width: number

                Set manual width.

                -

              Returns void

            Methods

            setDimension

            • setDimension(width, height): void

            • Set manual width & height.

              +

            Returns void

            Methods

            setDimension

            • setDimension(width, height): void

            • Set manual width & height.

              Parameters

              • width: number

                New manual width.

              • height: number

                New manual height.

                -

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            constrainelementenabledheightlockedwidthsetDimension
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.System.SystemBaseConstructor.html b/docs/interfaces/_runtime_svelte_store_position.System.SystemBaseConstructor.html index ba05f768..a6322e11 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.SystemBaseConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.SystemBaseConstructor.html @@ -1,10 +1,11 @@ -SystemBaseConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface SystemBaseConstructor

            Describes the constructor function for anu SystemBase implementation.

            -
            interface SystemBaseConstructor {
                new SystemBaseConstructornew (options?): SystemBase;
            }

            Constructors

            constructor -

            Constructors

            constructor

            • new SystemBaseConstructor(options?): SystemBase

            • Parameters

              • Optional options: {
                    constrain?: boolean;
                    element?: HTMLElement;
                    enabled?: boolean;
                    height?: number;
                    lock?: boolean;
                    width?: number;
                }

                Initial options.

                -
                • Optional constrain?: boolean

                  Constrain state.

                  -
                • Optional element?: HTMLElement

                  Target element.

                  -
                • Optional enabled?: boolean

                  Enabled state.

                  -
                • Optional height?: number

                  Manual height.

                  -
                • Optional lock?: boolean

                  Lock parameters from being set.

                  -
                • Optional width?: number

                  Manual width.

                  -

              Returns SystemBase

            Settings

            Member Visibility

            Theme

            On This Page

            constructor
            \ No newline at end of file +SystemBaseConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface SystemBaseConstructor

            Describes the constructor function for anu SystemBase implementation.

            +
            interface SystemBaseConstructor {
                new SystemBaseConstructornew (options?: {
                    constrain?: boolean;
                    element?: HTMLElement;
                    enabled?: boolean;
                    height?: number;
                    lock?: boolean;
                    width?: number;
                }): SystemBase;
            }

            Constructors

            constructor +

            Constructors

            constructor

            • new SystemBaseConstructor(options?): SystemBase

            • Parameters

              • Optionaloptions: {
                    constrain?: boolean;
                    element?: HTMLElement;
                    enabled?: boolean;
                    height?: number;
                    lock?: boolean;
                    width?: number;
                }

                Initial options.

                +
                • Optionalconstrain?: boolean

                  Constrain state.

                  +
                • Optionalelement?: HTMLElement

                  Target element.

                  +
                • Optionalenabled?: boolean

                  Enabled state.

                  +
                • Optionalheight?: number

                  Manual height.

                  +
                • Optionallock?: boolean

                  Lock parameters from being set.

                  +
                • Optionalwidth?: number

                  Manual width.

                  +

              Returns SystemBase

            Settings

            Member Visibility

            On This Page

            Constructors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystem.html b/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystem.html index ca5ff4f4..741d02aa 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystem.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystem.html @@ -1,5 +1,6 @@ -ValidatorSystem | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface ValidatorSystem

            Provides a system to validate positional changes.

            -
            interface ValidatorSystem {
                id?: any;
                validate: ValidatorFn;
                weight?: number;
                constrain: boolean;
                element: HTMLElement;
                enabled: boolean;
                height: number;
                get locked(): boolean;
                width: number;
                setDimension(width, height): void;
                subscribe?(this, run, invalidate?): Unsubscriber;
            }

            Hierarchy (view full)

            Accessors

            constrain +ValidatorSystem | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface ValidatorSystem

            Provides a system to validate positional changes.

            +
            interface ValidatorSystem {
                id?: any;
                validate: ValidatorFn;
                weight?: number;
                constrain: boolean;
                element: HTMLElement;
                enabled: boolean;
                height: number;
                get locked(): boolean;
                width: number;
                setDimension(width: number, height: number): void;
                subscribe?(this: void, run: Subscriber<any>, invalidate?: Invalidator<any>): Unsubscriber;
            }

            Hierarchy (view full)

            Accessors

            constrain element enabled height @@ -10,7 +11,7 @@

            Properties

            id? validate weight? -

            Accessors

            constrain

            • get constrain(): boolean

            • Returns boolean

              The current constrain state.

              +

            Accessors

            constrain

            • get constrain(): boolean

            • Returns boolean

              The current constrain state.

            • set constrain(constrain): void

            • Parameters

              • constrain: boolean

                Set constrain state.

              Returns void

            element

            • get element(): HTMLElement

            • Returns HTMLElement

              Target element.

            • set element(element): void

            • Parameters

              • element: HTMLElement

                Set target element.

                @@ -21,15 +22,15 @@

              Returns void

            locked

            • get locked(): boolean

            • Returns boolean

              Get locked state.

            width

            • get width(): number

            • Returns number

              Get manual width.

            • set width(width): void

            • Parameters

              • width: number

                Set manual width.

                -

              Returns void

            Methods

            setDimension

            • setDimension(width, height): void

            • Set manual width & height.

              +

            Returns void

            Methods

            setDimension

            • setDimension(width, height): void

            • Set manual width & height.

              Parameters

              • width: number

                New manual width.

              • height: number

                New manual height.

                -

              Returns void

            Optional subscribe

            • subscribe(this, run, invalidate?): Unsubscriber

            • Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will +

            Returns void

            Optionalsubscribe

            • subscribe(this, run, invalidate?): Unsubscriber

            • Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will be processed again.

              -

              Parameters

              Returns Unsubscriber

            Properties

            Optional id

            id?: any

            An ID associated with this validator. Can be used to remove the validator; default: undefined.

            +

            Parameters

            Returns Unsubscriber

            Properties

            Optionalid

            id?: any

            An ID associated with this validator. Can be used to remove the validator; default: undefined.

            validate

            validate: ValidatorFn

            Provides a validator that respects transforms in positional data constraining the position to within the target elements bounds.

            -

            Param: valData

            The associated validation data for position updates.

            -

            Returns

            Potentially adjusted position data.

            -

            Optional weight

            weight?: number

            A number between 0 and 1 inclusive to position this validator against others; default: 1.

            -

            Settings

            Member Visibility

            Theme

            On This Page

            constrainelementenabledheightlockedwidthsetDimensionsubscribeidvalidateweight
            \ No newline at end of file +

            Param: valData

            The associated validation data for position updates.

            +

            Returns

            Potentially adjusted position data.

            +

            Optionalweight

            weight?: number

            A number between 0 and 1 inclusive to position this validator against others; default: 1.

            +

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystemConstructor.html b/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystemConstructor.html index eb8ea86f..916d9e34 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystemConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystemConstructor.html @@ -1,10 +1,11 @@ -ValidatorSystemConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface ValidatorSystemConstructor

            Describes the constructor function for an ValidatorSystem implementation.

            -
            interface ValidatorSystemConstructor {
                new ValidatorSystemConstructornew (options?): ValidatorSystem;
            }

            Constructors

            constructor -

            Constructors

            constructor

            • new ValidatorSystemConstructor(options?): ValidatorSystem

            • Parameters

              • Optional options: {
                    constrain?: boolean;
                    element?: HTMLElement;
                    enabled?: boolean;
                    height?: number;
                    lock?: boolean;
                    width?: number;
                }

                Initial options.

                -
                • Optional constrain?: boolean

                  Constrain state.

                  -
                • Optional element?: HTMLElement

                  Target element.

                  -
                • Optional enabled?: boolean

                  Enabled state.

                  -
                • Optional height?: number

                  Manual height.

                  -
                • Optional lock?: boolean

                  Lock parameters from being set.

                  -
                • Optional width?: number

                  Manual width.

                  -

              Returns ValidatorSystem

            Settings

            Member Visibility

            Theme

            On This Page

            constructor
            \ No newline at end of file +ValidatorSystemConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface ValidatorSystemConstructor

            Describes the constructor function for an ValidatorSystem implementation.

            +
            interface ValidatorSystemConstructor {
                new ValidatorSystemConstructornew (options?: {
                    constrain?: boolean;
                    element?: HTMLElement;
                    enabled?: boolean;
                    height?: number;
                    lock?: boolean;
                    width?: number;
                }): ValidatorSystem;
            }

            Constructors

            constructor +

            Constructors

            constructor

            • new ValidatorSystemConstructor(options?): ValidatorSystem

            • Parameters

              • Optionaloptions: {
                    constrain?: boolean;
                    element?: HTMLElement;
                    enabled?: boolean;
                    height?: number;
                    lock?: boolean;
                    width?: number;
                }

                Initial options.

                +
                • Optionalconstrain?: boolean

                  Constrain state.

                  +
                • Optionalelement?: HTMLElement

                  Target element.

                  +
                • Optionalenabled?: boolean

                  Enabled state.

                  +
                • Optionalheight?: number

                  Manual height.

                  +
                • Optionallock?: boolean

                  Lock parameters from being set.

                  +
                • Optionalwidth?: number

                  Manual width.

                  +

              Returns ValidatorSystem

            Settings

            Member Visibility

            On This Page

            Constructors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.Positionable.html b/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.Positionable.html index f1f96373..aa525bdc 100644 --- a/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.Positionable.html +++ b/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.Positionable.html @@ -1,3 +1,4 @@ -Positionable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface Positionable

            Defines the shape of an instance / object that is positionable.

            -
            interface Positionable {
                position: TJSPosition;
            }

            Implemented by

            Properties

            position -

            Properties

            position

            position: TJSPosition

            Settings

            Member Visibility

            Theme

            On This Page

            position
            \ No newline at end of file +Positionable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface Positionable

            Defines the shape of an instance / object that is positionable.

            +
            interface Positionable {
                position: TJSPosition;
            }

            Implemented by

            Properties

            position +

            Properties

            position

            position: TJSPosition

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html b/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html index a6a5f7f6..6f7c3d3f 100644 --- a/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html +++ b/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html @@ -1,12 +1,13 @@ -TJSPositionWritable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TJSPositionWritable

            Provides an overloaded Writable store interface for TJSPosition.set.

            -
            interface TJSPositionWritable {
                set(this, value, options?): TJSPosition;
                subscribe(this, run, invalidate?): Unsubscriber;
                update(this, updater): void;
            }

            Hierarchy (view full)

            Implemented by

            Methods

            set +TJSPositionWritable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface TJSPositionWritable

            Provides an overloaded Writable store interface for TJSPosition.set.

            +
            interface TJSPositionWritable {
                set(this: void, value: TJSPositionDataRelative, options?: OptionsSet): TJSPosition;
                subscribe(this: void, run: Subscriber<TJSPositionDataRelative>, invalidate?: Invalidator<TJSPositionDataRelative>): Unsubscriber;
                update(this: void, updater: Updater<TJSPositionDataRelative>): void;
            }

            Hierarchy (view full)

            Implemented by

            Methods

            set subscribe update -

            Methods

            set

            • set(this, value, options?): TJSPosition

            • Set value and inform subscribers.

              +

            Methods

            set

            subscribe

            Returns TJSPosition

            subscribe

            update

            Settings

            Member Visibility

            Theme

            On This Page

            setsubscribeupdate
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformData.html b/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformData.html index e685fa79..e7efb155 100644 --- a/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformData.html +++ b/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformData.html @@ -1,12 +1,13 @@ -TransformData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TransformData

            Provides the output data for TransformAPI.getData.

            -
            interface TransformData {
                get boundingRect(): DOMRect;
                get corners(): Vec3[];
                get css(): string;
                get mat4(): Mat4;
                get originTranslations(): Mat4[];
            }

            Accessors

            boundingRect +TransformData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface TransformData

            Provides the output data for TransformAPI.getData.

            +
            interface TransformData {
                get boundingRect(): DOMRect;
                get corners(): Vec3[];
                get css(): string;
                get mat4(): Mat4;
                get originTranslations(): Mat4[];
            }

            Accessors

            boundingRect corners css mat4 originTranslations -

            Accessors

            boundingRect

            Accessors

            boundingRect

            corners

            • get corners(): Vec3[]

            • Returns Vec3[]

              The transformed corner points as Vec3 in screen space.

            css

            • get css(): string

            • Returns string

              Returns the CSS style string for the transform matrix.

            mat4

            • get mat4(): Mat4

            • Returns Mat4

              The transform matrix.

            originTranslations

            • get originTranslations(): Mat4[]

            • Returns Mat4[]

              The pre / post translation matrices for origin translation.

              -

            Settings

            Member Visibility

            Theme

            On This Page

            boundingRectcornerscssmat4originTranslations
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Accessors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformDataConstructor.html b/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformDataConstructor.html index 2637f4c0..68dbd8ab 100644 --- a/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformDataConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformDataConstructor.html @@ -1,3 +1,4 @@ -TransformDataConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TransformDataConstructor

            Describes the constructor function for TransformData.

            -
            interface TransformDataConstructor {
                new TransformDataConstructornew (): TransformData;
            }

            Constructors

            constructor -

            Constructors

            constructor

            Settings

            Member Visibility

            Theme

            On This Page

            constructor
            \ No newline at end of file +TransformDataConstructor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface TransformDataConstructor

            Describes the constructor function for TransformData.

            +
            interface TransformDataConstructor {
                new TransformDataConstructornew (): TransformData;
            }

            Constructors

            constructor +

            Constructors

            constructor

            Settings

            Member Visibility

            On This Page

            Constructors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformOriginWritable.html b/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformOriginWritable.html index 56f1e10d..fd6d5e1a 100644 --- a/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformOriginWritable.html +++ b/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformOriginWritable.html @@ -1,14 +1,15 @@ -TransformOriginWritable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TransformOriginWritable

            Provides a custom writable for the transformOrigin store adding a read only property values that +TransformOriginWritable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface TransformOriginWritable

            Provides a custom writable for the transformOrigin store adding a read only property values that contains a list of all transform origin values.

            -
            interface TransformOriginWritable {
                get values(): readonly TransformOrigin[];
                set(this, value): void;
                subscribe(this, run, invalidate?): Unsubscriber;
                update(this, updater): void;
            }

            Hierarchy (view full)

            Accessors

            values +
            interface TransformOriginWritable {
                get values(): readonly TransformOrigin[];
                set(this: void, value: TransformOrigin): void;
                subscribe(this: void, run: Subscriber<TransformOrigin>, invalidate?: Invalidator<TransformOrigin>): Unsubscriber;
                update(this: void, updater: Updater<TransformOrigin>): void;
            }

            Hierarchy (view full)

            Accessors

            values

            Methods

            set subscribe update -

            Accessors

            values

            Methods

            set

            • set(this, value): void

            • Set value and inform subscribers.

              +

            Accessors

            values

            Methods

            set

            • set(this, value): void

            • Set value and inform subscribers.

              Parameters

              Returns void

            subscribe

            update

            • update(this, updater): void

            • Update value using callback and inform subscribers.

              Parameters

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            valuessetsubscribeupdate
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.TransformAPI.html b/docs/interfaces/_runtime_svelte_store_position.TransformAPI.html index 8b757067..29448bd4 100644 --- a/docs/interfaces/_runtime_svelte_store_position.TransformAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.TransformAPI.html @@ -1,4 +1,5 @@ -TransformAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TransformAPI

            interface TransformAPI {
                get isActive(): boolean;
                rotateX: number;
                rotateY: number;
                rotateZ: number;
                scale: number;
                translateX: number;
                translateY: number;
                translateZ: number;
                getCSS(data?): string;
                getCSSOrtho(data?): string;
                getData(position, output?, validationData?): TransformData;
                getMat4(data?, output?): Mat4;
                getMat4Ortho(data?, output?): Mat4;
                hasTransform(data): boolean;
                reset(data): void;
            }

            Accessors

            isActive +TransformAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface TransformAPI

            interface TransformAPI {
                get isActive(): boolean;
                rotateX: number;
                rotateY: number;
                rotateZ: number;
                scale: number;
                translateX: number;
                translateY: number;
                translateZ: number;
                getCSS(data?: object): string;
                getCSSOrtho(data?: object): string;
                getData(position: TJSPositionData, output?: TransformData, validationData?: object): TransformData;
                getMat4(data?: object, output?: Mat4): Mat4;
                getMat4Ortho(data?: object, output?: Mat4): Mat4;
                hasTransform(data: object): boolean;
                reset(data: object): void;
            }

            Accessors

            isActive rotateX rotateY rotateZ @@ -13,7 +14,7 @@ getMat4Ortho hasTransform reset -

            Accessors

            isActive

            • get isActive(): boolean

            • Returns boolean

              Whether there are active transforms in local data.

              +

            Accessors

            isActive

            • get isActive(): boolean

            • Returns boolean

              Whether there are active transforms in local data.

            rotateX

            • get rotateX(): number

            • Returns number

              Any local rotateX data.

            • set rotateX(value): void

            • Sets the local rotateX data if the value is a finite number otherwise removes the local data.

              Parameters

              • value: number

                A value to set.

                @@ -35,24 +36,24 @@

              Returns void

            translateZ

            • get translateZ(): number

            • Returns number

              Any local translateZ data.

            • set translateZ(value): void

            • Sets the local translateZ data if the value is a finite number otherwise removes the local data.

              Parameters

              • value: number

                A value to set.

                -

              Returns void

            Methods

            getCSS

            • getCSS(data?): string

            • Returns the matrix3d CSS transform for the given position / transform data.

              -

              Parameters

              • Optional data: object

                Optional position data otherwise use local stored transform data.

                +

              Returns void

            Methods

            getCSS

            • getCSS(data?): string

            • Returns the matrix3d CSS transform for the given position / transform data.

              +

              Parameters

              • Optionaldata: object

                Optional position data otherwise use local stored transform data.

              Returns string

              The CSS matrix3d string.

            getCSSOrtho

            • getCSSOrtho(data?): string

            • Returns the matrix3d CSS transform for the given position / transform data.

              -

              Parameters

              • Optional data: object

                Optional position data otherwise use local stored transform data.

                +

                Parameters

                • Optionaldata: object

                  Optional position data otherwise use local stored transform data.

                Returns string

                The CSS matrix3d string.

            getData

            • getData(position, output?, validationData?): TransformData

            • Collects all data including a bounding rect, transform matrix, and points array of the given TJSPositionData instance with the applied local transform data.

              Parameters

              • position: TJSPositionData

                The position data to process.

                -
              • Optional output: TransformData

                Optional TransformAPI.Data output instance.

                -
              • Optional validationData: object

                Optional validation data for adjustment parameters.

                +
              • Optionaloutput: TransformData

                Optional TransformAPI.Data output instance.

                +
              • OptionalvalidationData: object

                Optional validation data for adjustment parameters.

              Returns TransformData

              The output TransformAPI.Data instance.

            getMat4

            • getMat4(data?, output?): Mat4

            • Creates a transform matrix based on local data applied in order it was added.

              If no data object is provided then the source is the local transform data. If another data object is supplied then the stored local transform order is applied then all remaining transform keys are applied. This allows the construction of a transform matrix in advance of setting local data and is useful in collision detection.

              -

              Parameters

              • Optional data: object

                TJSPositionData instance or local transform data.

                -
              • Optional output: Mat4

                The output mat4 instance.

                +

                Parameters

                • Optionaldata: object

                  TJSPositionData instance or local transform data.

                  +
                • Optionaloutput: Mat4

                  The output mat4 instance.

                Returns Mat4

                Transform matrix.

            getMat4Ortho

            • getMat4Ortho(data?, output?): Mat4

            • Provides an orthographic enhancement to convert left / top positional data to a translate operation.

              This transform matrix takes into account that the remaining operations are , but adds any left / top attributes @@ -60,12 +61,12 @@

              If no data object is provided then the source is the local transform data. If another data object is supplied then the stored local transform order is applied then all remaining transform keys are applied. This allows the construction of a transform matrix in advance of setting local data and is useful in collision detection.

              -

              Parameters

              • Optional data: object

                TJSPositionData instance or local transform data.

                -
              • Optional output: Mat4

                The output mat4 instance.

                +

                Parameters

                • Optionaldata: object

                  TJSPositionData instance or local transform data.

                  +
                • Optionaloutput: Mat4

                  The output mat4 instance.

                Returns Mat4

                Transform matrix.

            hasTransform

            • hasTransform(data): boolean

            • Tests an object if it contains transform keys and the values are finite numbers.

              Parameters

              • data: object

                An object to test for transform data.

              Returns boolean

              Whether the given TJSPositionData has transforms.

            reset

            • reset(data): void

            • Resets internal data from the given object containing valid transform keys.

              Parameters

              • data: object

                An object with transform data.

                -

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            isActiverotateXrotateYrotateZscaletranslateXtranslateYtranslateZgetCSSgetCSSOrthogetDatagetMat4getMat4OrthohasTransformreset
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorFn.html b/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorFn.html index c5e057dd..1c6d7471 100644 --- a/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorFn.html +++ b/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorFn.html @@ -1,8 +1,9 @@ -ValidatorFn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface ValidatorFn

            interface ValidatorFn {
                arguments: any;
                caller: Function;
                length: number;
                name: string;
                prototype: any;
                [hasInstance](value): boolean;
                apply(this, thisArg, argArray?): any;
                bind(this, thisArg, ...argArray): any;
                call(this, thisArg, ...argArray): any;
                subscribe?(this, run, invalidate?): Unsubscriber;
                toString(): string;
                (data): TJSPositionData;
            }

            Hierarchy

            Methods

            [hasInstance] apply bind call @@ -13,22 +14,22 @@ length name prototype -

            Methods

            [hasInstance]

            • [hasInstance](value): boolean

            • Determines whether the given value inherits from this function if this function was used +

            Methods

            [hasInstance]

            • [hasInstance](value): boolean

            • Determines whether the given value inherits from this function if this function was used as a constructor function.

              A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.

              Parameters

              • value: any

              Returns boolean

            apply

            • apply(this, thisArg, argArray?): any

            • Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

              Parameters

              • this: Function
              • thisArg: any

                The object to be used as the this object.

                -
              • Optional argArray: any

                A set of arguments to be passed to the function.

                +
              • OptionalargArray: any

                A set of arguments to be passed to the function.

              Returns any

            bind

            • bind(this, thisArg, ...argArray): any

            • For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.

              Parameters

              • this: Function
              • thisArg: any

                An object to which the this keyword can refer inside the new function.

                -
              • Rest ...argArray: any[]

                A list of arguments to be passed to the new function.

                +
              • Rest...argArray: any[]

                A list of arguments to be passed to the new function.

              Returns any

            call

            • call(this, thisArg, ...argArray): any

            • Calls a method of an object, substituting another object for the current object.

              Parameters

              • this: Function
              • thisArg: any

                The object to be used as the current object.

                -
              • Rest ...argArray: any[]

                A list of arguments to be passed to the method.

                -

              Returns any

            Optional subscribe

            • subscribe(this, run, invalidate?): Unsubscriber

            • Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will +

            • Rest...argArray: any[]

              A list of arguments to be passed to the method.

              +

            Returns any

            Optionalsubscribe

            • subscribe(this, run, invalidate?): Unsubscriber

            • Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will be processed again.

              -

              Parameters

              Returns Unsubscriber

            toString

            • toString(): string

            • Returns a string representation of a function.

              -

              Returns string

            Properties

            arguments

            arguments: any

            caller

            caller: Function

            Readonly length

            length: number

            Readonly name

            name: string

            Returns the name of the function. Function names are read-only and can not be changed.

            -

            prototype

            prototype: any

            Settings

            Member Visibility

            Theme

            On This Page

            [hasInstance]applybindcallsubscribetoStringargumentscallerlengthnameprototype
            \ No newline at end of file +

            Parameters

            Returns Unsubscriber

            toString

            • toString(): string

            • Returns a string representation of a function.

              +

              Returns string

            Properties

            arguments

            arguments: any

            caller

            caller: Function

            Readonlylength

            length: number

            Readonlyname

            name: string

            Returns the name of the function. Function names are read-only and can not be changed.

            +

            prototype

            prototype: any

            Settings

            Member Visibility

            On This Page

            Methods
            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI.html b/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI.html index 92798ddc..da25e495 100644 --- a/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI.html @@ -1,8 +1,9 @@ -ValidatorAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface ValidatorAPI

            Provides the validator API implementation for TJSPosition.validators. You may add one or more validator +ValidatorAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface ValidatorAPI

            Provides the validator API implementation for TJSPosition.validators. You may add one or more validator functions which evaluate changes in the associated TJSPosition instance. This allows standard validation for browser bounds / transform checking available via TJSPosition.Validators or custom validators added which may provide unique bounding validation / constraints.

            -
            interface ValidatorAPI {
                enabled: boolean;
                get length(): number;
                [iterator](): IterableIterator<ValidatorData>;
                add(...validators): void;
                clear(): void;
                remove(...validators): void;
                removeBy(callback): void;
                removeById(...ids): void;
            }

            Accessors

            enabled +
            interface ValidatorAPI {
                enabled: boolean;
                get length(): number;
                [iterator](): IterableIterator<ValidatorData>;
                add(...validators: (ValidatorData | ValidatorFn)[]): void;
                clear(): void;
                remove(...validators: (ValidatorData | ValidatorFn)[]): void;
                removeBy(callback: RemoveByCallback): void;
                removeById(...ids: any[]): void;
            }

            Accessors

            enabled length

            Methods

            [iterator] add @@ -10,19 +11,19 @@ remove removeBy removeById -

            Accessors

            enabled

            • get enabled(): boolean

            • Returns boolean

              Returns the enabled state.

              +

            Accessors

            enabled

            • get enabled(): boolean

            • Returns boolean

              Returns the enabled state.

            • set enabled(enabled): void

            • Parameters

              • enabled: boolean

                Sets enabled state.

              Returns void

            length

            • get length(): number

            • Returns number

              Returns the length of the validators array.

              -

            Methods

            [iterator]

            Methods

            [iterator]

            add

            • add(...validators): void

            • Adds the given validators.

              -

              Parameters

            add

            • add(...validators): void

            • Adds the given validators.

              +

              Parameters

              Returns void

            clear

            • clear(): void

            • Clears / removes all validators.

              Returns void

            remove

            • remove(...validators): void

            • Removes one or more given validators.

              -

              Parameters

            removeBy

            • removeBy(callback): void

            • Remove validators by the provided callback. The callback takes 3 parameters: id, validator, and weight. Any truthy value returned will remove that validator.

              Parameters

              Returns void

            removeById

            • removeById(...ids): void

            • Removes any validators with matching IDs.

              -

              Parameters

              • Rest ...ids: any[]

                IDs to remove.

                -

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            enabledlength[iterator]addclearremoveremoveByremoveById
            \ No newline at end of file +

            Parameters

            • Rest...ids: any[]

              IDs to remove.

              +

            Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.IDynAdapterFilters.html b/docs/interfaces/_runtime_svelte_store_reducer.IDynAdapterFilters.html index 2b6ee321..5d5acf19 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.IDynAdapterFilters.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.IDynAdapterFilters.html @@ -1,4 +1,5 @@ -IDynAdapterFilters | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface IDynAdapterFilters<T>

            Provides the storage and sequencing of managed filters. Each filter added may be a bespoke function or a +IDynAdapterFilters | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface IDynAdapterFilters<T>

            Provides the storage and sequencing of managed filters. Each filter added may be a bespoke function or a DynDataFilter object containing an id, filter, and weight attributes; filter is the only required attribute.

            The id attribute can be anything that creates a unique ID for the filter; recommended strings or numbers. This @@ -9,23 +10,24 @@ lower weight; an example of this is a keyword / name that will filter out many entries making any further filtering faster. If no weight is specified the default of '1' is assigned and it is appended to the end of the filters list.

            This class forms the public API which is accessible from the .filters getter in the main reducer implementation.

            -
            const dynArray = new DynArrayReducer([...]);
            dynArray.filters.add(...);
            dynArray.filters.clear();
            dynArray.filters.length;
            dynArray.filters.remove(...);
            dynArray.filters.removeBy(...);
            dynArray.filters.removeById(...);
+
            const dynArray = new DynArrayReducer([...]);
            dynArray.filters.add(...);
            dynArray.filters.clear();
            dynArray.filters.length;
            dynArray.filters.remove(...);
            dynArray.filters.removeBy(...);
            dynArray.filters.removeById(...);
 
            
-
            interface IDynAdapterFilters<T> {
                get length(): number;
                [iterator](): void | IterableIterator<DynDataFilter<T>>;
                add(...filters): void;
                clear(): void;
                remove(...filters): void;
                removeBy(callback): void;
                removeById(...ids): void;
            }

            Type Parameters

            • T

            Accessors

            length + +
            interface IDynAdapterFilters<T> {
                get length(): number;
                [iterator](): void | IterableIterator<DynDataFilter<T>>;
                add(...filters: (DynDataFilter<T> | DynFilterFn<T>)[]): void;
                clear(): void;
                remove(...filters: (DynDataFilter<T> | DynFilterFn<T>)[]): void;
                removeBy(callback: ((id: any, filter: DynFilterFn<T>, weight: number) => boolean)): void;
                removeById(...ids: any[]): void;
            }

            Type Parameters

            • T

            Accessors

            length

            Methods

            [iterator] add clear remove removeBy removeById -

            Accessors

            length

            • get length(): number

            • Returns number

              Returns the length of the filter data.

              -

            Methods

            [iterator]

            add

            • add(...filters): void

            • Parameters

            Accessors

            length

            • get length(): number

            • Returns number

              Returns the length of the filter data.

              +

            Methods

            [iterator]

            add

            • add(...filters): void

            • Parameters

              Returns void

            clear

            • clear(): void

            • Clears and removes all filters.

              -

              Returns void

            remove

            • remove(...filters): void

            • Parameters

            remove

            • remove(...filters): void

            • Parameters

              Returns void

            removeBy

            • removeBy(callback): void

            • Remove filters by the provided callback. The callback takes 3 parameters: id, filter, and weight. Any truthy value returned will remove that filter.

              -

              Parameters

              • callback: ((id, filter, weight) => boolean)

                Callback function to evaluate - each filter entry.

                -
                  • (id, filter, weight): boolean

                  • Parameters

                    Returns boolean

              Returns void

            removeById

            • removeById(...ids): void

            • Parameters

              • Rest ...ids: any[]

                Removes filters by ID.

                -

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            length[iterator]addclearremoveremoveByremoveById
            \ No newline at end of file +

            Parameters

            • callback: ((id: any, filter: DynFilterFn<T>, weight: number) => boolean)

              Callback function to evaluate +each filter entry.

              +
                • (id, filter, weight): boolean

                • Parameters

                  Returns boolean

            Returns void

            removeById

            • removeById(...ids): void

            • Parameters

              • Rest...ids: any[]

                Removes filters by ID.

                +

              Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.IDynAdapterSort.html b/docs/interfaces/_runtime_svelte_store_reducer.IDynAdapterSort.html index 11fb9a2e..ab2f434c 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.IDynAdapterSort.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.IDynAdapterSort.html @@ -1,17 +1,19 @@ -IDynAdapterSort | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface IDynAdapterSort<T>

            Provides the storage and sequencing of a managed sort function. The sort function set may be a bespoke function or a +IDynAdapterSort | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface IDynAdapterSort<T>

            Provides the storage and sequencing of a managed sort function. The sort function set may be a bespoke function or a DynDataSort object containing an compare, and subscribe attributes; compare is the only required attribute.

            Note: You can set a compare function that also has a subscribe function attached as the subscribe attribute. If a subscribe function is provided the sort function can notify any updates that may change sort order and this triggers an index update.

            This class forms the public API which is accessible from the .sort getter in the main reducer implementation.

            -
            const dynArray = new DynArrayReducer([...]);
            dynArray.sort.clear();
            dynArray.sort.set(...);
+
            const dynArray = new DynArrayReducer([...]);
            dynArray.sort.clear();
            dynArray.sort.set(...);
 
            
-
            interface IDynAdapterSort<T> {
                clear(): void;
                set(sort): void;
            }

            Type Parameters

            • T

            Methods

            clear + +
            interface IDynAdapterSort<T> {
                clear(): void;
                set(sort: DynCompareFn<T> | DynDataSort<T>): void;
            }

            Type Parameters

            • T

            Methods

            clear set -

            Methods

            clear

            • clear(): void

            • Clears & removes any assigned sort function and triggers an index update.

              +

            Methods

            clear

            • clear(): void

            • Clears & removes any assigned sort function and triggers an index update.

              Returns void

            set

            Settings

            Member Visibility

            Theme

            On This Page

            clearset
            \ No newline at end of file +

            Returns void

            See

            https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#parameters

            +

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.IDynArrayReducerCtor.html b/docs/interfaces/_runtime_svelte_store_reducer.IDynArrayReducerCtor.html index 6a7e7774..a6978269 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.IDynArrayReducerCtor.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.IDynArrayReducerCtor.html @@ -1,3 +1,4 @@ -IDynArrayReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface IDynArrayReducerCtor<T>

            Defines the shape of a dynamic array constructor function.

            -
            interface IDynArrayReducerCtor<T> {
                new IDynArrayReducerCtornew (data?): DynArrayReducer<T>;
            }

            Type Parameters

            • T

            Constructors

            constructor -

            Constructors

            constructor

            Settings

            Member Visibility

            Theme

            On This Page

            constructor
            \ No newline at end of file +IDynArrayReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface IDynArrayReducerCtor<T>

            Defines the shape of a dynamic array constructor function.

            +
            interface IDynArrayReducerCtor<T> {
                new IDynArrayReducerCtornew (data?: Iterable<T> | DynArrayData<T>): DynArrayReducer<T>;
            }

            Type Parameters

            • T

            Constructors

            constructor +

            Constructors

            constructor

            Settings

            Member Visibility

            On This Page

            Constructors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedAPI.html b/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedAPI.html index f1e78c4b..561f2493 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedAPI.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedAPI.html @@ -1,15 +1,17 @@ -IDynDerivedAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface IDynDerivedAPI<D, K, T>

            Provides the public API for derived reducers. There are several ways to create a derived reducer from utilizing the +IDynDerivedAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface IDynDerivedAPI<D, K, T>

            Provides the public API for derived reducers. There are several ways to create a derived reducer from utilizing the default implementation or passing in a constructor function / class for a custom derived reducer.

            This class forms the public API which is accessible from the .derived getter in the main reducer implementation.

            -
            const dynArray = new DynArrayReducer([...]);
            dynArray.derived.clear();
            dynArray.derived.create(...);
            dynArray.derived.delete(...);
            dynArray.derived.destroy();
            dynArray.derived.get(...);
+
            const dynArray = new DynArrayReducer([...]);
            dynArray.derived.clear();
            dynArray.derived.create(...);
            dynArray.derived.delete(...);
            dynArray.derived.destroy();
            dynArray.derived.get(...);
 
            
-

            Template: D,

            K, T

            -
            interface IDynDerivedAPI<D, K, T> {
                clear(): void;
                create(options): IDynDerivedReducer<D, K, T>;
                delete(name): boolean;
                destroy(): void;
                get(name): IDynDerivedReducer<D, K, T>;
            }

            Type Parameters

            • D
            • K
            • T

            Methods

            clear + +

            Template: D,

            K, T

            +
            interface IDynDerivedAPI<D, K, T> {
                clear(): void;
                create(options: DynOptionsDerivedCreate<T>): IDynDerivedReducer<D, K, T>;
                delete(name: string): boolean;
                destroy(): void;
                get(name: string): IDynDerivedReducer<D, K, T>;
            }

            Type Parameters

            • D
            • K
            • T

            Methods

            clear create delete destroy get -

            Methods

            clear

            • clear(): void

            • Removes all derived reducers and associated subscriptions.

              +

            Methods

            clear

            • clear(): void

            • Removes all derived reducers and associated subscriptions.

              Returns void

            create

            delete

            • delete(name): boolean

            • Deletes and destroys a derived reducer.

              @@ -19,4 +21,4 @@

              Returns void

            get

            Settings

            Member Visibility

            Theme

            On This Page

            clearcreatedeletedestroyget
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedReducer.html b/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedReducer.html index c00c2f87..6e881b3f 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedReducer.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedReducer.html @@ -1,5 +1,6 @@ -IDynDerivedReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface IDynDerivedReducer<D, K, T>

            Defines the interface for a derived reducer.

            -
            interface IDynDerivedReducer<D, K, T> {
                get data(): D;
                get derived(): IDynDerivedAPI<D, K, T>;
                get destroyed(): boolean;
                get filters(): IDynAdapterFilters<T>;
                get index(): IDynIndexerAPI<K, T>;
                get length(): number;
                reversed: boolean;
                get sort(): IDynAdapterSort<T>;
                destroy(): void;
                subscribe(handler): (() => void);
            }

            Type Parameters

            • D
            • K
            • T

            Implemented by

            Accessors

            data +IDynDerivedReducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface IDynDerivedReducer<D, K, T>

            Defines the interface for a derived reducer.

            +
            interface IDynDerivedReducer<D, K, T> {
                get data(): D;
                get derived(): IDynDerivedAPI<D, K, T>;
                get destroyed(): boolean;
                get filters(): IDynAdapterFilters<T>;
                get index(): IDynIndexerAPI<K, T>;
                get length(): number;
                reversed: boolean;
                get sort(): IDynAdapterSort<T>;
                destroy(): void;
                subscribe(handler: ((value: IDynDerivedReducer<D, K, T>) => void)): (() => void);
            }

            Type Parameters

            • D
            • K
            • T

            Implemented by

            Accessors

            data derived destroyed filters @@ -9,7 +10,7 @@ sort

            Methods

            destroy subscribe -

            Accessors

            data

            • get data(): D

            • Returns the internal data of this instance. Be careful!

              +

            Accessors

            data

            • get data(): D

            • Returns the internal data of this instance. Be careful!

              Note: if an array is set as initial data then that array is used as the internal data. If any changes are performed to the data externally do invoke update via IDynDerivedReducer.index with true to recalculate the index and notify all subscribers.

              @@ -23,8 +24,8 @@
            • set reversed(reversed): void

            • Sets reversed state and notifies subscribers.

              Parameters

              • reversed: boolean

                New reversed state.

              Returns void

            sort

            Methods

            destroy

            • destroy(): void

            • Removes all derived reducers, subscriptions, and cleans up all resources.

              +

            Methods

            destroy

            • destroy(): void

            • Removes all derived reducers, subscriptions, and cleans up all resources.

              Returns void

            subscribe

            • subscribe(handler): (() => void)

            • Subscribe to this IDerivedReducer.

              -

              Parameters

              • handler: ((value) => void)

                Callback function that is invoked on update / changes. Receives derived reducer reference.

                +

                Parameters

                • handler: ((value: IDynDerivedReducer<D, K, T>) => void)

                  Callback function that is invoked on update / changes. Receives derived reducer reference.

                Returns (() => void)

                Unsubscribe function.

                -
                  • (): void

                  • Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            dataderiveddestroyedfiltersindexlengthreversedsortdestroysubscribe
            \ No newline at end of file +
              • (): void

              • Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedReducerCtor.html b/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedReducerCtor.html index 3ced8f67..4add1745 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedReducerCtor.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.IDynDerivedReducerCtor.html @@ -1,3 +1,4 @@ -IDynDerivedReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface IDynDerivedReducerCtor<T>

            Defines the shape of a derived reducer constructor function.

            -
            interface IDynDerivedReducerCtor<T> {
                new IDynDerivedReducerCtornew (hostData, parentIndex, options): IDynDerivedReducer<any, any, T>;
            }

            Type Parameters

            • T

            Constructors

            constructor -

            Constructors

            constructor

            Settings

            Member Visibility

            Theme

            On This Page

            constructor
            \ No newline at end of file +IDynDerivedReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface IDynDerivedReducerCtor<T>

            Defines the shape of a derived reducer constructor function.

            +
            interface IDynDerivedReducerCtor<T> {
                new IDynDerivedReducerCtornew (hostData: DynDataHost<any>, parentIndex: IDynIndexerAPI<any, T>, options: DynDataOptions<T>): IDynDerivedReducer<any, any, T>;
            }

            Type Parameters

            • T

            Constructors

            constructor +

            Constructors

            constructor

            Settings

            Member Visibility

            On This Page

            Constructors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.IDynIndexerAPI.html b/docs/interfaces/_runtime_svelte_store_reducer.IDynIndexerAPI.html index 70a1a797..138f421d 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.IDynIndexerAPI.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.IDynIndexerAPI.html @@ -1,18 +1,20 @@ -IDynIndexerAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface IDynIndexerAPI<K, T>

            Provides the public API for accessing the index API.

            +IDynIndexerAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface IDynIndexerAPI<K, T>

            Provides the public API for accessing the index API.

            This class forms the public API which is accessible from the .index getter in the main reducer implementation.

            -
            const dynArray = new DynArrayReducer([...]);
            dynArray.index.active;
            dynArray.index.hash;
            dynArray.index.length;
            dynArray.index.update(...);
+
            const dynArray = new DynArrayReducer([...]);
            dynArray.index.active;
            dynArray.index.hash;
            dynArray.index.length;
            dynArray.index.update(...);
 
            
-

            Template: K,

            T

            -
            interface IDynIndexerAPI<K, T> {
                get active(): boolean;
                get hash(): number;
                get length(): number;
                [iterator](): IterableIterator<K>;
                update(force?): void;
            }

            Type Parameters

            • K
            • T

            Accessors

            active + +

            Template: K,

            T

            +
            interface IDynIndexerAPI<K, T> {
                get active(): boolean;
                get hash(): number;
                get length(): number;
                [iterator](): IterableIterator<K>;
                update(force?: boolean): void;
            }

            Type Parameters

            • K
            • T

            Accessors

            active hash length

            Methods

            [iterator] update -

            Accessors

            active

            • get active(): boolean

            • Returns boolean

              Returns whether the index is active.

              +

            Accessors

            active

            • get active(): boolean

            • Returns boolean

              Returns whether the index is active.

            hash

            • get hash(): number

            • Returns number

              Current hash value of the index.

            length

            • get length(): number

            • Returns number

              Returns length of reduced index.

              -

            Methods

            [iterator]

            Methods

            [iterator]

            update

            • update(force?): void

            • Manually invoke an update of the index.

              -

              Parameters

              • Optional force: boolean

                Force update to any subscribers.

                -

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            activehashlength[iterator]update
            \ No newline at end of file +

            Yields

            update

            • update(force?): void

            • Manually invoke an update of the index.

              +

              Parameters

              • Optionalforce: boolean

                Force update to any subscribers.

                +

              Returns void

            Settings

            Member Visibility

            On This Page

            Accessors
            Methods
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.IDynMapReducerCtor.html b/docs/interfaces/_runtime_svelte_store_reducer.IDynMapReducerCtor.html index 3dfa41bc..365f927c 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.IDynMapReducerCtor.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.IDynMapReducerCtor.html @@ -1,3 +1,4 @@ -IDynMapReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface IDynMapReducerCtor<K, T>

            Defines the shape of a dynamic map constructor function.

            -
            interface IDynMapReducerCtor<K, T> {
                new IDynMapReducerCtornew (data?): DynMapReducer<K, T>;
            }

            Type Parameters

            • K
            • T

            Constructors

            constructor -

            Constructors

            constructor

            Settings

            Member Visibility

            Theme

            On This Page

            constructor
            \ No newline at end of file +IDynMapReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface IDynMapReducerCtor<K, T>

            Defines the shape of a dynamic map constructor function.

            +
            interface IDynMapReducerCtor<K, T> {
                new IDynMapReducerCtornew (data?: Map<K, T> | DynMapData<K, T>): DynMapReducer<K, T>;
            }

            Type Parameters

            • K
            • T

            Constructors

            constructor +

            Constructors

            constructor

            Settings

            Member Visibility

            On This Page

            Constructors
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_util.BasicAnimation.html b/docs/interfaces/_runtime_util.BasicAnimation.html deleted file mode 100644 index 4b28d92d..00000000 --- a/docs/interfaces/_runtime_util.BasicAnimation.html +++ /dev/null @@ -1,10 +0,0 @@ -BasicAnimation | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface BasicAnimation

            Defines the implementation for basic animation control.

            -
            interface BasicAnimation {
                finished: Promise<BasicAnimationState>;
                isActive: boolean;
                isFinished: boolean;
                cancel(): void;
            }

            Methods

            cancel -

            Properties

            finished -isActive -isFinished -

            Methods

            cancel

            • cancel(): void

            • Cancels animation when invoked.

              -

              Returns void

            Properties

            Readonly finished

            finished: Promise<BasicAnimationState>

            A Promise that is resolved when animation is finished.

            -

            Readonly isActive

            isActive: boolean

            True if animation is active; note: delayed animations are not active until start.

            -

            Readonly isFinished

            isFinished: boolean

            True if animation is completely finished.

            -

            Settings

            Member Visibility

            Theme

            On This Page

            cancelfinishedisActiveisFinished
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_util_animate.BasicAnimation.html b/docs/interfaces/_runtime_util_animate.BasicAnimation.html index 5579929f..6850a65f 100644 --- a/docs/interfaces/_runtime_util_animate.BasicAnimation.html +++ b/docs/interfaces/_runtime_util_animate.BasicAnimation.html @@ -1,10 +1,11 @@ -BasicAnimation | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface BasicAnimation

            Defines the implementation for basic animation control.

            -
            interface BasicAnimation {
                finished: Promise<BasicAnimationState>;
                isActive: boolean;
                isFinished: boolean;
                cancel(): void;
            }

            Methods

            cancel +BasicAnimation | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface BasicAnimation

            Defines the implementation for basic animation control.

            +
            interface BasicAnimation {
                finished: Promise<BasicAnimationState>;
                isActive: boolean;
                isFinished: boolean;
                cancel(): void;
            }

            Methods

            cancel

            Properties

            finished isActive isFinished -

            Methods

            cancel

            • cancel(): void

            • Cancels animation when invoked.

              -

              Returns void

            Properties

            Readonly finished

            finished: Promise<BasicAnimationState>

            A Promise that is resolved when animation is finished.

            -

            Readonly isActive

            isActive: boolean

            True if animation is active; note: delayed animations are not active until start.

            -

            Readonly isFinished

            isFinished: boolean

            True if animation is completely finished.

            -

            Settings

            Member Visibility

            Theme

            On This Page

            cancelfinishedisActiveisFinished
            \ No newline at end of file +

            Methods

            cancel

            • cancel(): void

            • Cancels animation when invoked.

              +

              Returns void

            Properties

            Readonlyfinished

            finished: Promise<BasicAnimationState>

            A Promise that is resolved when animation is finished.

            +

            ReadonlyisActive

            isActive: boolean

            True if animation is active; note: delayed animations are not active until start.

            +

            ReadonlyisFinished

            isFinished: boolean

            True if animation is completely finished.

            +

            Settings

            Member Visibility

            On This Page

            Methods
            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_util_object.JSONArray.html b/docs/interfaces/_runtime_util_object.JSONArray.html index 4151b6c0..9ab2137d 100644 --- a/docs/interfaces/_runtime_util_object.JSONArray.html +++ b/docs/interfaces/_runtime_util_object.JSONArray.html @@ -1,4 +1,5 @@ -JSONArray | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface JSONArray

            interface JSONArray {
                [unscopables]: {
                    [unscopables]?: boolean;
                    length?: boolean;
                    [iterator]?: any;
                    at?: any;
                    concat?: any;
                    copyWithin?: any;
                    entries?: any;
                    every?: any;
                    fill?: any;
                    filter?: any;
                    find?: any;
                    findIndex?: any;
                    flat?: any;
                    flatMap?: any;
                    forEach?: any;
                    includes?: any;
                    indexOf?: any;
                    join?: any;
                    keys?: any;
                    lastIndexOf?: any;
                    map?: any;
                    pop?: any;
                    push?: any;
                    reduce?: any;
                    reduceRight?: any;
                    reverse?: any;
                    shift?: any;
                    slice?: any;
                    some?: any;
                    sort?: any;
                    splice?: any;
                    toLocaleString?: any;
                    toString?: any;
                    unshift?: any;
                    values?: any;
                };
                length: number;
                [iterator](): IterableIterator<JSONValue>;
                at(index): JSONValue;
                concat(...items): JSONValue[];
                concat(...items): JSONValue[];
                copyWithin(target, start, end?): this;
                entries(): IterableIterator<[number, JSONValue]>;
                every<S>(predicate, thisArg?): this is S[];
                every(predicate, thisArg?): boolean;
                fill(value, start?, end?): this;
                filter<S>(predicate, thisArg?): S[];
                filter(predicate, thisArg?): JSONValue[];
                find<S>(predicate, thisArg?): S;
                find(predicate, thisArg?): JSONValue;
                findIndex(predicate, thisArg?): number;
                flat<A, D>(this, depth?): FlatArray<A, D>[];
                flatMap<U, This>(callback, thisArg?): U[];
                forEach(callbackfn, thisArg?): void;
                includes(searchElement, fromIndex?): boolean;
                indexOf(searchElement, fromIndex?): number;
                join(separator?): string;
                keys(): IterableIterator<number>;
                lastIndexOf(searchElement, fromIndex?): number;
                map<U>(callbackfn, thisArg?): U[];
                pop(): JSONValue;
                push(...items): number;
                reduce(callbackfn): JSONValue;
                reduce(callbackfn, initialValue): JSONValue;
                reduce<U>(callbackfn, initialValue): U;
                reduceRight(callbackfn): JSONValue;
                reduceRight(callbackfn, initialValue): JSONValue;
                reduceRight<U>(callbackfn, initialValue): U;
                reverse(): JSONValue[];
                shift(): JSONValue;
                slice(start?, end?): JSONValue[];
                some(predicate, thisArg?): boolean;
                sort(compareFn?): this;
                splice(start, deleteCount?): JSONValue[];
                splice(start, deleteCount, ...items): JSONValue[];
                toLocaleString(): string;
                toString(): string;
                unshift(...items): number;
                values(): IterableIterator<JSONValue>;
            }

            Hierarchy

            Methods

            [iterator] +JSONArray | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface JSONArray

            interface JSONArray {
                [unscopables]: {
                    [unscopables]?: boolean;
                    length?: boolean;
                    [iterator]?: any;
                    at?: any;
                    concat?: any;
                    copyWithin?: any;
                    entries?: any;
                    every?: any;
                    fill?: any;
                    filter?: any;
                    find?: any;
                    findIndex?: any;
                    flat?: any;
                    flatMap?: any;
                    forEach?: any;
                    includes?: any;
                    indexOf?: any;
                    join?: any;
                    keys?: any;
                    lastIndexOf?: any;
                    map?: any;
                    pop?: any;
                    push?: any;
                    reduce?: any;
                    reduceRight?: any;
                    reverse?: any;
                    shift?: any;
                    slice?: any;
                    some?: any;
                    sort?: any;
                    splice?: any;
                    toLocaleString?: any;
                    toString?: any;
                    unshift?: any;
                    values?: any;
                };
                length: number;
                [iterator](): IterableIterator<JSONValue>;
                at(index: number): JSONValue;
                concat(...items: ConcatArray<JSONValue>[]): JSONValue[];
                concat(...items: (JSONValue | ConcatArray<JSONValue>)[]): JSONValue[];
                copyWithin(target: number, start: number, end?: number): this;
                entries(): IterableIterator<[number, JSONValue]>;
                every<S>(predicate: ((value: JSONValue, index: number, array: JSONValue[]) => value is S), thisArg?: any): this is S[];
                every(predicate: ((value: JSONValue, index: number, array: JSONValue[]) => unknown), thisArg?: any): boolean;
                fill(value: JSONValue, start?: number, end?: number): this;
                filter<S>(predicate: ((value: JSONValue, index: number, array: JSONValue[]) => value is S), thisArg?: any): S[];
                filter(predicate: ((value: JSONValue, index: number, array: JSONValue[]) => unknown), thisArg?: any): JSONValue[];
                find<S>(predicate: ((value: JSONValue, index: number, obj: JSONValue[]) => value is S), thisArg?: any): S;
                find(predicate: ((value: JSONValue, index: number, obj: JSONValue[]) => unknown), thisArg?: any): JSONValue;
                findIndex(predicate: ((value: JSONValue, index: number, obj: JSONValue[]) => unknown), thisArg?: any): number;
                flat<A, D>(this: A, depth?: D): FlatArray<A, D>[];
                flatMap<U, This>(callback: ((this: This, value: JSONValue, index: number, array: JSONValue[]) => U | readonly U[]), thisArg?: This): U[];
                forEach(callbackfn: ((value: JSONValue, index: number, array: JSONValue[]) => void), thisArg?: any): void;
                includes(searchElement: JSONValue, fromIndex?: number): boolean;
                indexOf(searchElement: JSONValue, fromIndex?: number): number;
                join(separator?: string): string;
                keys(): IterableIterator<number>;
                lastIndexOf(searchElement: JSONValue, fromIndex?: number): number;
                map<U>(callbackfn: ((value: JSONValue, index: number, array: JSONValue[]) => U), thisArg?: any): U[];
                pop(): JSONValue;
                push(...items: JSONValue[]): number;
                reduce(callbackfn: ((previousValue: JSONValue, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => JSONValue)): JSONValue;
                reduce(callbackfn: ((previousValue: JSONValue, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => JSONValue), initialValue: JSONValue): JSONValue;
                reduce<U>(callbackfn: ((previousValue: U, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => U), initialValue: U): U;
                reduceRight(callbackfn: ((previousValue: JSONValue, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => JSONValue)): JSONValue;
                reduceRight(callbackfn: ((previousValue: JSONValue, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => JSONValue), initialValue: JSONValue): JSONValue;
                reduceRight<U>(callbackfn: ((previousValue: U, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => U), initialValue: U): U;
                reverse(): JSONValue[];
                shift(): JSONValue;
                slice(start?: number, end?: number): JSONValue[];
                some(predicate: ((value: JSONValue, index: number, array: JSONValue[]) => unknown), thisArg?: any): boolean;
                sort(compareFn?: ((a: JSONValue, b: JSONValue) => number)): this;
                splice(start: number, deleteCount?: number): JSONValue[];
                splice(start: number, deleteCount: number, ...items: JSONValue[]): JSONValue[];
                toLocaleString(): string;
                toString(): string;
                unshift(...items: JSONValue[]): number;
                values(): IterableIterator<JSONValue>;
            }

            Hierarchy

            Methods

            [iterator] at concat copyWithin @@ -33,102 +34,102 @@ values

            Properties

            [unscopables] length -

            Methods

            [iterator]

            Methods

            [iterator]

            at

            • at(index): JSONValue

            • Returns the item located at the specified index.

              Parameters

              • index: number

                The zero-based index of the desired code unit. A negative index will count back from the last item.

              Returns JSONValue

            concat

            • concat(...items): JSONValue[]

            • Combines two or more arrays. This method returns a new array without modifying any existing arrays.

              -

              Parameters

              • Rest ...items: ConcatArray<JSONValue>[]

                Additional arrays and/or items to add to the end of the array.

                +

                Parameters

                • Rest...items: ConcatArray<JSONValue>[]

                  Additional arrays and/or items to add to the end of the array.

                Returns JSONValue[]

              • concat(...items): JSONValue[]

              • Combines two or more arrays. This method returns a new array without modifying any existing arrays.

                -

                Parameters

            copyWithin

            • copyWithin(target, start, end?): this

            • Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

              Parameters

              • target: number

                If target is negative, it is treated as length+target where length is the length of the array.

              • start: number

                If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

                -
              • Optional end: number

                If not specified, length of the this object is used as its default value.

                +
              • Optionalend: number

                If not specified, length of the this object is used as its default value.

              Returns this

            entries

            every

            • every<S>(predicate, thisArg?): this is S[]

            • Determines whether all the members of an array satisfy the specified test.

              -

              Type Parameters

              Parameters

              • predicate: ((value, index, array) => value is S)

                A function that accepts up to three arguments. The every method calls +

                Type Parameters

                Parameters

                • predicate: ((value: JSONValue, index: number, array: JSONValue[]) => value is S)

                  A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

                  -
                    • (value, index, array): value is S

                    • Parameters

                      Returns value is S

                • Optional thisArg: any

                  An object to which the this keyword can refer in the predicate function. +

                    • (value, index, array): value is S

                    • Parameters

                      Returns value is S

                • OptionalthisArg: any

                  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                Returns this is S[]

              • every(predicate, thisArg?): boolean

              • Determines whether all the members of an array satisfy the specified test.

                -

                Parameters

                • predicate: ((value, index, array) => unknown)

                  A function that accepts up to three arguments. The every method calls +

                  Parameters

                  • predicate: ((value: JSONValue, index: number, array: JSONValue[]) => unknown)

                    A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

                    -
                      • (value, index, array): unknown

                      • Parameters

                        Returns unknown

                  • Optional thisArg: any

                    An object to which the this keyword can refer in the predicate function. +

                      • (value, index, array): unknown

                      • Parameters

                        Returns unknown

                  • OptionalthisArg: any

                    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                  Returns boolean

            fill

            • fill(value, start?, end?): this

            • Changes all array elements from start to end index to a static value and returns the modified array

              Parameters

              • value: JSONValue

                value to fill array section with

                -
              • Optional start: number

                index to start filling the array at. If start is negative, it is treated as +

              • Optionalstart: number

                index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

                -
              • Optional end: number

                index to stop filling the array at. If end is negative, it is treated as +

              • Optionalend: number

                index to stop filling the array at. If end is negative, it is treated as length+end.

              Returns this

            filter

            • filter<S>(predicate, thisArg?): S[]

            • Returns the elements of an array that meet the condition specified in a callback function.

              -

              Type Parameters

              Parameters

              • predicate: ((value, index, array) => value is S)

                A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

                -
                  • (value, index, array): value is S

                  • Parameters

                    Returns value is S

              • Optional thisArg: any

                An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                +

                Type Parameters

                Parameters

                • predicate: ((value: JSONValue, index: number, array: JSONValue[]) => value is S)

                  A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

                  +
                    • (value, index, array): value is S

                    • Parameters

                      Returns value is S

                • OptionalthisArg: any

                  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                Returns S[]

              • filter(predicate, thisArg?): JSONValue[]

              • Returns the elements of an array that meet the condition specified in a callback function.

                -

                Parameters

                • predicate: ((value, index, array) => unknown)

                  A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

                  -
                    • (value, index, array): unknown

                    • Parameters

                      Returns unknown

                • Optional thisArg: any

                  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                  +

                  Parameters

                  • predicate: ((value: JSONValue, index: number, array: JSONValue[]) => unknown)

                    A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

                    +
                      • (value, index, array): unknown

                      • Parameters

                        Returns unknown

                  • OptionalthisArg: any

                    An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                  Returns JSONValue[]

            find

            • find<S>(predicate, thisArg?): S

            • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

              -

              Type Parameters

              Parameters

              • predicate: ((value, index, obj) => value is S)

                find calls predicate once for each element of the array, in ascending +

                Type Parameters

                Parameters

                • predicate: ((value: JSONValue, index: number, obj: JSONValue[]) => value is S)

                  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

                  -
                    • (value, index, obj): value is S

                    • Parameters

                      Returns value is S

                • Optional thisArg: any

                  If provided, it will be used as the this value for each invocation of +

                    • (value, index, obj): value is S

                    • Parameters

                      Returns value is S

                • OptionalthisArg: any

                  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

                  -

                Returns S

              • find(predicate, thisArg?): JSONValue

              • Parameters

                • predicate: ((value, index, obj) => unknown)
                    • (value, index, obj): unknown

                    • Parameters

                      Returns unknown

                • Optional thisArg: any

                Returns JSONValue

            findIndex

            • findIndex(predicate, thisArg?): number

            • Returns the index of the first element in the array where predicate is true, and -1 +

            Returns S

          • find(predicate, thisArg?): JSONValue

          • Parameters

            • predicate: ((value: JSONValue, index: number, obj: JSONValue[]) => unknown)
                • (value, index, obj): unknown

                • Parameters

                  Returns unknown

            • OptionalthisArg: any

            Returns JSONValue

            • findIndex

            • findIndex(predicate, thisArg?): number

            • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

              -

              Parameters

              • predicate: ((value, index, obj) => unknown)

                find calls predicate once for each element of the array, in ascending +

                Parameters

                • predicate: ((value: JSONValue, index: number, obj: JSONValue[]) => unknown)

                  find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

                  -
                    • (value, index, obj): unknown

                    • Parameters

                      Returns unknown

                • Optional thisArg: any

                  If provided, it will be used as the this value for each invocation of +

                    • (value, index, obj): unknown

                    • Parameters

                      Returns unknown

                • OptionalthisArg: any

                  If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

                Returns number

            flat

            • flat<A, D>(this, depth?): FlatArray<A, D>[]

            • Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

              -

              Type Parameters

              • A
              • D extends number = 1

              Parameters

              • this: A
              • Optional depth: D

                The maximum recursion depth

                +

                Type Parameters

                • A
                • D extends number = 1

                Parameters

                • this: A
                • Optionaldepth: D

                  The maximum recursion depth

                Returns FlatArray<A, D>[]

            flatMap

            • flatMap<U, This>(callback, thisArg?): U[]

            • Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

              -

              Type Parameters

              • U
              • This = undefined

              Parameters

              • callback: ((this, value, index, array) => U | readonly U[])

                A function that accepts up to three arguments. The flatMap method calls the +

                Type Parameters

                • U
                • This = undefined

                Parameters

                • callback: ((this: This, value: JSONValue, index: number, array: JSONValue[]) => U | readonly U[])

                  A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

                  -
                    • (this, value, index, array): U | readonly U[]

                    • Parameters

                      Returns U | readonly U[]

                • Optional thisArg: This

                  An object to which the this keyword can refer in the callback function. If +

                    • (this, value, index, array): U | readonly U[]

                    • Parameters

                      Returns U | readonly U[]

                • OptionalthisArg: This

                  An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

                Returns U[]

            forEach

            • forEach(callbackfn, thisArg?): void

            • Performs the specified action for each element in an array.

              -

              Parameters

              • callbackfn: ((value, index, array) => void)

                A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

                -
                  • (value, index, array): void

                  • Parameters

                    Returns void

              • Optional thisArg: any

                An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

                +

                Parameters

                • callbackfn: ((value: JSONValue, index: number, array: JSONValue[]) => void)

                  A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

                  +
                    • (value, index, array): void

                    • Parameters

                      Returns void

                • OptionalthisArg: any

                  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

                Returns void

            includes

            • includes(searchElement, fromIndex?): boolean

            • Determines whether an array includes a certain element, returning true or false as appropriate.

              Parameters

              • searchElement: JSONValue

                The element to search for.

                -
              • Optional fromIndex: number

                The position in this array at which to begin searching for searchElement.

                +
              • OptionalfromIndex: number

                The position in this array at which to begin searching for searchElement.

              Returns boolean

            indexOf

            • indexOf(searchElement, fromIndex?): number

            • Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

              Parameters

              • searchElement: JSONValue

                The value to locate in the array.

                -
              • Optional fromIndex: number

                The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

                +
              • OptionalfromIndex: number

                The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

              Returns number

            join

            • join(separator?): string

            • Adds all the elements of an array into a string, separated by the specified separator string.

              -

              Parameters

              • Optional separator: string

                A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

                +

                Parameters

                • Optionalseparator: string

                  A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

                Returns string

            keys

            lastIndexOf

            • lastIndexOf(searchElement, fromIndex?): number

            • Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

              Parameters

              • searchElement: JSONValue

                The value to locate in the array.

                -
              • Optional fromIndex: number

                The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

                +
              • OptionalfromIndex: number

                The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

              Returns number

            map

            • map<U>(callbackfn, thisArg?): U[]

            • Calls a defined callback function on each element of an array, and returns an array that contains the results.

              -

              Type Parameters

              • U

              Parameters

              • callbackfn: ((value, index, array) => U)

                A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

                -
              • Optional thisArg: any

                An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

                +

                Type Parameters

                • U

                Parameters

                • callbackfn: ((value: JSONValue, index: number, array: JSONValue[]) => U)

                  A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

                  +
                • OptionalthisArg: any

                  An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

                Returns U[]

            pop

            • pop(): JSONValue

            • Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

              Returns JSONValue

            push

            • push(...items): number

            • Appends new elements to the end of an array, and returns the new length of the array.

              -

              Parameters

              • Rest ...items: JSONValue[]

                New elements to add to the array.

                +

                Parameters

                • Rest...items: JSONValue[]

                  New elements to add to the array.

                Returns number

            reduce

            • reduce(callbackfn): JSONValue

            • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

              -

              Parameters

              • callbackfn: ((previousValue, currentValue, currentIndex, array) => JSONValue)

                A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

                -

              Returns JSONValue

            • reduce(callbackfn, initialValue): JSONValue

            • Parameters

              Returns JSONValue

            • reduce<U>(callbackfn, initialValue): U

            • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

              -

              Type Parameters

              • U

              Parameters

              • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

                A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

                +

                Parameters

                • callbackfn: ((previousValue: JSONValue, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => JSONValue)

                  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

                  +

                Returns JSONValue

              • reduce(callbackfn, initialValue): JSONValue

              • Parameters

                Returns JSONValue

              • reduce<U>(callbackfn, initialValue): U

              • Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

                +

                Type Parameters

                • U

                Parameters

                • callbackfn: ((previousValue: U, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => U)

                  A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

                    • (previousValue, currentValue, currentIndex, array): U

                    • Parameters

                      Returns U

                • initialValue: U

                  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

                Returns U

            reduceRight

            • reduceRight(callbackfn): JSONValue

            • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

              -

              Parameters

              • callbackfn: ((previousValue, currentValue, currentIndex, array) => JSONValue)

                A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

                -

              Returns JSONValue

            • reduceRight(callbackfn, initialValue): JSONValue

            • Parameters

              Returns JSONValue

            • reduceRight<U>(callbackfn, initialValue): U

            • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

              -

              Type Parameters

              • U

              Parameters

              • callbackfn: ((previousValue, currentValue, currentIndex, array) => U)

                A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

                +

                Parameters

                • callbackfn: ((previousValue: JSONValue, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => JSONValue)

                  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

                  +

                Returns JSONValue

              • reduceRight(callbackfn, initialValue): JSONValue

              • Parameters

                Returns JSONValue

              • reduceRight<U>(callbackfn, initialValue): U

              • Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

                +

                Type Parameters

                • U

                Parameters

                • callbackfn: ((previousValue: U, currentValue: JSONValue, currentIndex: number, array: JSONValue[]) => U)

                  A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

                    • (previousValue, currentValue, currentIndex, array): U

                    • Parameters

                      Returns U

                • initialValue: U

                  If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

                Returns U

            reverse

            • reverse(): JSONValue[]

            • Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

              @@ -137,41 +138,42 @@

              Returns JSONValue

            slice

            • slice(start?, end?): JSONValue[]

            • Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array.

              -

              Parameters

              • Optional start: number

                The beginning index of the specified portion of the array. +

                Parameters

                • Optionalstart: number

                  The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

                  -
                • Optional end: number

                  The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. +

                • Optionalend: number

                  The end index of the specified portion of the array. This is exclusive of the element at the index 'end'. If end is undefined, then the slice extends to the end of the array.

                Returns JSONValue[]

            some

            • some(predicate, thisArg?): boolean

            • Determines whether the specified callback function returns true for any element of an array.

              -

              Parameters

              • predicate: ((value, index, array) => unknown)

                A function that accepts up to three arguments. The some method calls +

                Parameters

                • predicate: ((value: JSONValue, index: number, array: JSONValue[]) => unknown)

                  A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

                  -
                    • (value, index, array): unknown

                    • Parameters

                      Returns unknown

                • Optional thisArg: any

                  An object to which the this keyword can refer in the predicate function. +

                    • (value, index, array): unknown

                    • Parameters

                      Returns unknown

                • OptionalthisArg: any

                  An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

                Returns boolean

            sort

            • sort(compareFn?): this

            • Sorts an array in place. This method mutates the array and returns a reference to the same array.

              -

              Parameters

              • Optional compareFn: ((a, b) => number)

                Function used to determine the order of the elements. It is expected to return +

                Parameters

                • OptionalcompareFn: ((a: JSONValue, b: JSONValue) => number)

                  Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

                  -
                  [11,2,22,1].sort((a, b) => a - b)
-
                  +
                  [11,2,22,1].sort((a, b) => a - b)
+
                  +

                Returns this

            splice

            • splice(start, deleteCount?): JSONValue[]

            • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

              Parameters

              • start: number

                The zero-based location in the array from which to start removing elements.

                -
              • Optional deleteCount: number

                The number of elements to remove.

                +
              • OptionaldeleteCount: number

                The number of elements to remove.

              Returns JSONValue[]

              An array containing the elements that were deleted.

            • splice(start, deleteCount, ...items): JSONValue[]

            • Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

              Parameters

              • start: number

                The zero-based location in the array from which to start removing elements.

              • deleteCount: number

                The number of elements to remove.

                -
              • Rest ...items: JSONValue[]

                Elements to insert into the array in place of the deleted elements.

                +
              • Rest...items: JSONValue[]

                Elements to insert into the array in place of the deleted elements.

              Returns JSONValue[]

              An array containing the elements that were deleted.

            toLocaleString

            • toLocaleString(): string

            • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

              Returns string

            toString

            • toString(): string

            • Returns a string representation of an array.

              Returns string

            unshift

            • unshift(...items): number

            • Inserts new elements at the start of an array, and returns the new length of the array.

              -

              Parameters

              • Rest ...items: JSONValue[]

                Elements to insert at the start of the array.

                +

                Parameters

                • Rest...items: JSONValue[]

                  Elements to insert at the start of the array.

                Returns number

            values

            Properties

            Readonly [unscopables]

            [unscopables]: {
                [unscopables]?: boolean;
                length?: boolean;
                [iterator]?: any;
                at?: any;
                concat?: any;
                copyWithin?: any;
                entries?: any;
                every?: any;
                fill?: any;
                filter?: any;
                find?: any;
                findIndex?: any;
                flat?: any;
                flatMap?: any;
                forEach?: any;
                includes?: any;
                indexOf?: any;
                join?: any;
                keys?: any;
                lastIndexOf?: any;
                map?: any;
                pop?: any;
                push?: any;
                reduce?: any;
                reduceRight?: any;
                reverse?: any;
                shift?: any;
                slice?: any;
                some?: any;
                sort?: any;
                splice?: any;
                toLocaleString?: any;
                toString?: any;
                unshift?: any;
                values?: any;
            }

            Is an object whose properties have the value 'true' +

            Returns IterableIterator<JSONValue>

            Properties

            Readonly[unscopables]

            [unscopables]: {
                [unscopables]?: boolean;
                length?: boolean;
                [iterator]?: any;
                at?: any;
                concat?: any;
                copyWithin?: any;
                entries?: any;
                every?: any;
                fill?: any;
                filter?: any;
                find?: any;
                findIndex?: any;
                flat?: any;
                flatMap?: any;
                forEach?: any;
                includes?: any;
                indexOf?: any;
                join?: any;
                keys?: any;
                lastIndexOf?: any;
                map?: any;
                pop?: any;
                push?: any;
                reduce?: any;
                reduceRight?: any;
                reverse?: any;
                shift?: any;
                slice?: any;
                some?: any;
                sort?: any;
                splice?: any;
                toLocaleString?: any;
                toString?: any;
                unshift?: any;
                values?: any;
            }

            Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

            -

            Type declaration

            • Optional Readonly [unscopables]?: boolean

              Is an object whose properties have the value 'true' +

              Type declaration

              • Optional Readonly[unscopables]?: boolean

                Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

                -
              • Optional length?: boolean

                Gets or sets the length of the array. This is a number one higher than the highest index in the array.

                +
              • Optionallength?: boolean

                Gets or sets the length of the array. This is a number one higher than the highest index in the array.

            length

            length: number

            Gets or sets the length of the array. This is a number one higher than the highest index in the array.

            -

            Settings

            Member Visibility

            Theme

            On This Page

            [iterator]atconcatcopyWithinentrieseveryfillfilterfindfindIndexflatflatMapforEachincludesindexOfjoinkeyslastIndexOfmappoppushreducereduceRightreverseshiftslicesomesortsplicetoLocaleStringtoStringunshiftvalues[unscopables]length
            \ No newline at end of file +

            Settings

            Member Visibility

            On This Page

            Methods
            Properties
            \ No newline at end of file diff --git a/docs/interfaces/_runtime_util_object.JSONObject.html b/docs/interfaces/_runtime_util_object.JSONObject.html index 78c7bf15..5003e139 100644 --- a/docs/interfaces/_runtime_util_object.JSONObject.html +++ b/docs/interfaces/_runtime_util_object.JSONObject.html @@ -1 +1,2 @@ -JSONObject | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface JSONObject

            interface JSONObject {
                [key: string]: JSONValue;
            }

            Indexable

            [key: string]: JSONValue

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +JSONObject | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface JSONObject

            Indexable

            Settings

            Member Visibility
            \ No newline at end of file diff --git a/docs/interfaces/svelte.ComponentConstructorOptions.html b/docs/interfaces/svelte.ComponentConstructorOptions.html index 11d4adf0..2841cbc7 100644 --- a/docs/interfaces/svelte.ComponentConstructorOptions.html +++ b/docs/interfaces/svelte.ComponentConstructorOptions.html @@ -1,8 +1,9 @@ -ComponentConstructorOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface ComponentConstructorOptions<Props>

            interface ComponentConstructorOptions<Props> {
                $$inline?: boolean;
                anchor?: Element;
                context?: Map<any, any>;
                hydrate?: boolean;
                intro?: boolean;
                props?: Props;
                target: Element | Document | ShadowRoot;
            }

            Type Parameters

            Properties

            $$inline? +ComponentConstructorOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface ComponentConstructorOptions<Props>

            interface ComponentConstructorOptions<Props> {
                $$inline?: boolean;
                anchor?: Element;
                context?: Map<any, any>;
                hydrate?: boolean;
                intro?: boolean;
                props?: Props;
                target: Element | Document | ShadowRoot;
            }

            Type Parameters

            Properties

            $$inline? anchor? context? hydrate? intro? props? target -

            Properties

            Optional $$inline

            $$inline?: boolean

            Optional anchor

            anchor?: Element

            Optional context

            context?: Map<any, any>

            Optional hydrate

            hydrate?: boolean

            Optional intro

            intro?: boolean

            Optional props

            props?: Props

            target

            target: Element | Document | ShadowRoot

            Settings

            Member Visibility

            Theme

            On This Page

            $$inlineanchorcontexthydrateintropropstarget
            \ No newline at end of file +

            Properties

            Optional$$inline

            $$inline?: boolean

            Optionalanchor

            anchor?: Element

            Optionalcontext

            context?: Map<any, any>

            Optionalhydrate

            hydrate?: boolean

            Optionalintro

            intro?: boolean

            Optionalprops

            props?: Props

            target

            target: Element | Document | ShadowRoot

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte.DispatchOptions.html b/docs/interfaces/svelte.DispatchOptions.html index 4ea339b3..abc18eaf 100644 --- a/docs/interfaces/svelte.DispatchOptions.html +++ b/docs/interfaces/svelte.DispatchOptions.html @@ -1,2 +1,3 @@ -DispatchOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface DispatchOptions

            interface DispatchOptions {
                cancelable?: boolean;
            }

            Properties

            cancelable? -

            Properties

            Optional cancelable

            cancelable?: boolean

            Settings

            Member Visibility

            Theme

            On This Page

            cancelable
            \ No newline at end of file +DispatchOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface DispatchOptions

            interface DispatchOptions {
                cancelable?: boolean;
            }

            Properties

            cancelable? +

            Properties

            Optionalcancelable

            cancelable?: boolean

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte.EventDispatcher.html b/docs/interfaces/svelte.EventDispatcher.html index 09e51bbd..b194a258 100644 --- a/docs/interfaces/svelte.EventDispatcher.html +++ b/docs/interfaces/svelte.EventDispatcher.html @@ -1 +1,2 @@ -EventDispatcher | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface EventDispatcher<EventMap>

            interface EventDispatcher<EventMap> (<Type>(...args) => boolean)

            Type Parameters

            • EventMap extends Record<string, any>

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +EventDispatcher | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface EventDispatcher<EventMap>

            Type Parameters

            • EventMap extends Record<string, any>

            Settings

            Member Visibility
            \ No newline at end of file diff --git a/docs/interfaces/svelte_action.Action.html b/docs/interfaces/svelte_action.Action.html index fd088bda..79250d50 100644 --- a/docs/interfaces/svelte_action.Action.html +++ b/docs/interfaces/svelte_action.Action.html @@ -1,11 +1,13 @@ -Action | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface Action<Element, Parameter, Attributes>

            Actions are functions that are called when an element is created. +Action | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            +

            Interface Action<Element, Parameter, Attributes>

            Actions are functions that are called when an element is created. You can use this interface to type such actions. The following example defines an action that only works on <div> elements and optionally accepts a parameter which it has a default value for:

            -
            export const myAction: Action<HTMLDivElement, { someProperty: boolean } | undefined> = (node, param = { someProperty: true }) => {
              // ...
            }
-
            +
            export const myAction: Action<HTMLDivElement, { someProperty: boolean } | undefined> = (node, param = { someProperty: true }) => {
              // ...
            }
+
            +

            Action<HTMLDivElement> and Action<HTMLDivElement, undefined> both signal that the action accepts no parameters.

            You can return an object with methods update and destroy from the function and type which additional attributes and events it has. See interface ActionReturn for more details.

            -

            Docs: https://svelte.dev/docs/svelte-action

            -
            interface Action<Element, Parameter, Attributes> (<Node>(...args) => void | ActionReturn<Parameter, Attributes>)

            Type Parameters

            Settings

            Member Visibility

            Theme

            \ No newline at end of file +

            Docs: https://svelte.dev/docs/svelte-action

            +

            Type Parameters

            Settings

            Member Visibility
            \ No newline at end of file diff --git a/docs/interfaces/svelte_action.ActionReturn.html b/docs/interfaces/svelte_action.ActionReturn.html index 1b99fe82..41292729 100644 --- a/docs/interfaces/svelte_action.ActionReturn.html +++ b/docs/interfaces/svelte_action.ActionReturn.html @@ -1,4 +1,5 @@ -ActionReturn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface ActionReturn<Parameter, Attributes>

            Actions can return an object containing the two properties defined in this interface. Both are optional.

            +ActionReturn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface ActionReturn<Parameter, Attributes>

            Actions can return an object containing the two properties defined in this interface. Both are optional.

            • update: An action can have a parameter. This method will be called whenever that parameter changes, immediately after Svelte has applied updates to the markup. ActionReturn and ActionReturn<undefined> both @@ -8,12 +9,13 @@

              Additionally, you can specify which additional attributes and events the action enables on the applied element. This applies to TypeScript typings only and has no effect at runtime.

              Example usage:

              -
              interface Attributes {
                  newprop?: string;
                  'on:event': (e: CustomEvent<boolean>) => void;
              }

              export function myAction(node: HTMLElement, parameter: Parameter): ActionReturn<Parameter, Attributes> {
                  // ...
                  return {
                      update: (updatedParameter) => {...},
                      destroy: () => {...}
                  };
              }
-
              -

              Docs: https://svelte.dev/docs/svelte-action

              -
            interface ActionReturn<Parameter, Attributes> {
                $$_attributes?: Attributes;
                destroy?: (() => void);
                update?: ((parameter) => void);
            }

            Type Parameters

            • Parameter = undefined
            • Attributes extends Record<string, any> = Record<never, any>

            Properties

            $$_attributes? +
            interface Attributes {
            	newprop?: string;
            	'on:event': (e: CustomEvent<boolean>) => void;
            }

            export function myAction(node: HTMLElement, parameter: Parameter): ActionReturn<Parameter, Attributes> {
            	// ...
            	return {
            		update: (updatedParameter) => {...},
            		destroy: () => {...}
            	};
            }
+
            + +

            Docs: https://svelte.dev/docs/svelte-action

            +
            interface ActionReturn<Parameter, Attributes> {
                $$_attributes?: Attributes;
                destroy?: (() => void);
                update?: ((parameter: Parameter) => void);
            }

            Type Parameters

            • Parameter = undefined
            • Attributes extends Record<string, any> = Record<never, any>

            Properties

            $$_attributes? destroy? update? -

            Properties

            Optional $$_attributes

            $$_attributes?: Attributes

            DO NOT USE THIS

            This exists solely for type-checking and has no effect at runtime. +

            Properties

            Optional$$_attributes

            $$_attributes?: Attributes

            DO NOT USE THIS

            This exists solely for type-checking and has no effect at runtime. Set this through the Attributes generic instead.

            -

            Optional destroy

            destroy?: (() => void)

            Type declaration

              • (): void

              • Returns void

            Optional update

            update?: ((parameter) => void)

            Type declaration

              • (parameter): void

              • Parameters

                Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            $$_attributesdestroyupdate
            \ No newline at end of file +

            Optionaldestroy

            destroy?: (() => void)

            Optionalupdate

            update?: ((parameter: Parameter) => void)

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_animate.AnimationConfig.html b/docs/interfaces/svelte_animate.AnimationConfig.html index a9e32192..ead2b76b 100644 --- a/docs/interfaces/svelte_animate.AnimationConfig.html +++ b/docs/interfaces/svelte_animate.AnimationConfig.html @@ -1,6 +1,7 @@ -AnimationConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface AnimationConfig

            interface AnimationConfig {
                css?: ((t, u) => string);
                delay?: number;
                duration?: number;
                easing?: ((t) => number);
                tick?: ((t, u) => void);
            }

            Properties

            css? +AnimationConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface AnimationConfig

            interface AnimationConfig {
                css?: ((t: number, u: number) => string);
                delay?: number;
                duration?: number;
                easing?: ((t: number) => number);
                tick?: ((t: number, u: number) => void);
            }

            Properties

            css? delay? duration? easing? tick? -

            Properties

            Optional css

            css?: ((t, u) => string)

            Type declaration

              • (t, u): string

              • Parameters

                • t: number
                • u: number

                Returns string

            Optional delay

            delay?: number

            Optional duration

            duration?: number

            Optional easing

            easing?: ((t) => number)

            Type declaration

              • (t): number

              • Parameters

                • t: number

                Returns number

            Optional tick

            tick?: ((t, u) => void)

            Type declaration

              • (t, u): void

              • Parameters

                • t: number
                • u: number

                Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            cssdelaydurationeasingtick
            \ No newline at end of file +

            Properties

            Optionalcss

            css?: ((t: number, u: number) => string)

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number

            Optionaleasing

            easing?: ((t: number) => number)

            Optionaltick

            tick?: ((t: number, u: number) => void)

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_animate.FlipParams.html b/docs/interfaces/svelte_animate.FlipParams.html index b9cecd2f..821b46f2 100644 --- a/docs/interfaces/svelte_animate.FlipParams.html +++ b/docs/interfaces/svelte_animate.FlipParams.html @@ -1,4 +1,5 @@ -FlipParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface FlipParams

            interface FlipParams {
                delay?: number;
                duration?: number | ((len) => number);
                easing?: ((t) => number);
            }

            Properties

            delay? +FlipParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface FlipParams

            interface FlipParams {
                delay?: number;
                duration?: number | ((len: number) => number);
                easing?: ((t: number) => number);
            }

            Properties

            delay? duration? easing? -

            Properties

            Optional delay

            delay?: number

            Optional duration

            duration?: number | ((len) => number)

            Type declaration

              • (len): number

              • Parameters

                • len: number

                Returns number

            Optional easing

            easing?: ((t) => number)

            Type declaration

              • (t): number

              • Parameters

                • t: number

                Returns number

            Settings

            Member Visibility

            Theme

            On This Page

            delaydurationeasing
            \ No newline at end of file +

            Properties

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number | ((len: number) => number)

            Optionaleasing

            easing?: ((t: number) => number)

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_motion.Readable.html b/docs/interfaces/svelte_motion.Readable.html index e330f765..a4e729ca 100644 --- a/docs/interfaces/svelte_motion.Readable.html +++ b/docs/interfaces/svelte_motion.Readable.html @@ -1,6 +1,7 @@ -Readable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface Readable<T>

            Readable interface for subscribing.

            -
            interface Readable<T> {
                subscribe(this, run, invalidate?): Unsubscriber;
            }

            Type Parameters

            • T

            Hierarchy (view full)

            Methods

            subscribe -

            Methods

            subscribe

            Returns Unsubscriber

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/svelte_motion.Spring-1.html b/docs/interfaces/svelte_motion.Spring-1.html index d18fac47..8c44c74d 100644 --- a/docs/interfaces/svelte_motion.Spring-1.html +++ b/docs/interfaces/svelte_motion.Spring-1.html @@ -1,11 +1,12 @@ -Spring | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface Spring<T>

            Readable interface for subscribing.

            -
            interface Spring<T> {
                damping: number;
                precision: number;
                set: ((new_value, opts?) => Promise<void>);
                stiffness: number;
                update: ((fn, opts?) => Promise<void>);
                subscribe(this, run, invalidate?): Unsubscriber;
            }

            Type Parameters

            • T

            Hierarchy (view full)

            Methods

            subscribe +Spring | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface Spring<T>

            Readable interface for subscribing.

            +
            interface Spring<T> {
                damping: number;
                precision: number;
                set: ((new_value: T, opts?: SpringUpdateOpts) => Promise<void>);
                stiffness: number;
                update: ((fn: Updater<T>, opts?: SpringUpdateOpts) => Promise<void>);
                subscribe(this: void, run: Subscriber<T>, invalidate?: Invalidator<T>): Unsubscriber;
            }

            Type Parameters

            • T

            Hierarchy (view full)

            Methods

            subscribe

            Properties

            damping precision set stiffness update -

            Methods

            subscribe

            • subscribe(this, run, invalidate?): Unsubscriber

            • Subscribe on value changes.

              +

            Methods

            subscribe

            Properties

            damping

            damping: number

            precision

            precision: number

            set

            set: ((new_value, opts?) => Promise<void>)

            Type declaration

            stiffness

            stiffness: number

            update

            update: ((fn, opts?) => Promise<void>)

            Type declaration

            Settings

            Member Visibility

            Theme

            On This Page

            subscribedampingprecisionsetstiffnessupdate
            \ No newline at end of file +
          • Optionalinvalidate: Invalidator<T>

            cleanup callback

            +

            • Returns Unsubscriber

            Properties

            damping

            damping: number

            precision

            precision: number

            set

            set: ((new_value: T, opts?: SpringUpdateOpts) => Promise<void>)

            stiffness

            stiffness: number

            update

            update: ((fn: Updater<T>, opts?: SpringUpdateOpts) => Promise<void>)

            Settings

            Member Visibility

            On This Page

            Methods
            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_motion.SpringOpts.html b/docs/interfaces/svelte_motion.SpringOpts.html index 986ff6fc..6390c7f4 100644 --- a/docs/interfaces/svelte_motion.SpringOpts.html +++ b/docs/interfaces/svelte_motion.SpringOpts.html @@ -1,4 +1,5 @@ -SpringOpts | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface SpringOpts

            interface SpringOpts {
                damping?: number;
                precision?: number;
                stiffness?: number;
            }

            Properties

            damping? +SpringOpts | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface SpringOpts

            interface SpringOpts {
                damping?: number;
                precision?: number;
                stiffness?: number;
            }

            Properties

            damping? precision? stiffness? -

            Properties

            Optional damping

            damping?: number

            Optional precision

            precision?: number

            Optional stiffness

            stiffness?: number

            Settings

            Member Visibility

            Theme

            On This Page

            dampingprecisionstiffness
            \ No newline at end of file +

            Properties

            Optionaldamping

            damping?: number

            Optionalprecision

            precision?: number

            Optionalstiffness

            stiffness?: number

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_motion.SpringUpdateOpts.html b/docs/interfaces/svelte_motion.SpringUpdateOpts.html index 7fc4b809..7126c76b 100644 --- a/docs/interfaces/svelte_motion.SpringUpdateOpts.html +++ b/docs/interfaces/svelte_motion.SpringUpdateOpts.html @@ -1,3 +1,4 @@ -SpringUpdateOpts | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface SpringUpdateOpts

            interface SpringUpdateOpts {
                hard?: any;
                soft?: string | number | boolean;
            }

            Properties

            hard? +SpringUpdateOpts | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface SpringUpdateOpts

            interface SpringUpdateOpts {
                hard?: any;
                soft?: string | number | boolean;
            }

            Properties

            hard? soft? -

            Properties

            Optional hard

            hard?: any

            Optional soft

            soft?: string | number | boolean

            Settings

            Member Visibility

            Theme

            On This Page

            hardsoft
            \ No newline at end of file +

            Properties

            Optionalhard

            hard?: any

            Optionalsoft

            soft?: string | number | boolean

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_motion.Tweened-1.html b/docs/interfaces/svelte_motion.Tweened-1.html index 403fc009..f1ea9e34 100644 --- a/docs/interfaces/svelte_motion.Tweened-1.html +++ b/docs/interfaces/svelte_motion.Tweened-1.html @@ -1,8 +1,9 @@ -Tweened | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface Tweened<T>

            Readable interface for subscribing.

            -
            interface Tweened<T> {
                set(value, opts?): Promise<void>;
                subscribe(this, run, invalidate?): Unsubscriber;
                update(updater, opts?): Promise<void>;
            }

            Type Parameters

            • T

            Hierarchy (view full)

            Methods

            set +Tweened | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface Tweened<T>

            Readable interface for subscribing.

            +
            interface Tweened<T> {
                set(value: T, opts?: TweenedOptions<T>): Promise<void>;
                subscribe(this: void, run: Subscriber<T>, invalidate?: Invalidator<T>): Unsubscriber;
                update(updater: Updater<T>, opts?: TweenedOptions<T>): Promise<void>;
            }

            Type Parameters

            • T

            Hierarchy (view full)

            Methods

            set subscribe update -

            Methods

            set

            subscribe

            • subscribe(this, run, invalidate?): Unsubscriber

            • Subscribe on value changes.

              +

            Methods

            set

            subscribe

            update

            Settings

            Member Visibility

            Theme

            On This Page

            setsubscribeupdate
            \ No newline at end of file +
          • Optionalinvalidate: Invalidator<T>

            cleanup callback

            +

            • Returns Unsubscriber

            update

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/svelte_motion.TweenedOptions.html b/docs/interfaces/svelte_motion.TweenedOptions.html index d7c26a3d..242010f6 100644 --- a/docs/interfaces/svelte_motion.TweenedOptions.html +++ b/docs/interfaces/svelte_motion.TweenedOptions.html @@ -1,5 +1,6 @@ -TweenedOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TweenedOptions<T>

            interface TweenedOptions<T> {
                delay?: number;
                duration?: number | ((from, to) => number);
                easing?: ((t) => number);
                interpolate?: ((a, b) => ((t) => T));
            }

            Type Parameters

            • T

            Properties

            delay? +TweenedOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface TweenedOptions<T>

            interface TweenedOptions<T> {
                delay?: number;
                duration?: number | ((from: T, to: T) => number);
                easing?: ((t: number) => number);
                interpolate?: ((a: T, b: T) => ((t: number) => T));
            }

            Type Parameters

            • T

            Properties

            delay? duration? easing? interpolate? -

            Properties

            Optional delay

            delay?: number

            Optional duration

            duration?: number | ((from, to) => number)

            Type declaration

              • (from, to): number

              • Parameters

                • from: T
                • to: T

                Returns number

            Optional easing

            easing?: ((t) => number)

            Type declaration

              • (t): number

              • Parameters

                • t: number

                Returns number

            Optional interpolate

            interpolate?: ((a, b) => ((t) => T))

            Type declaration

              • (a, b): ((t) => T)

              • Parameters

                Returns ((t) => T)

                  • (t): T

                  • Parameters

                    • t: number

                    Returns T

            Settings

            Member Visibility

            Theme

            On This Page

            delaydurationeasinginterpolate
            \ No newline at end of file +

            Properties

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number | ((from: T, to: T) => number)

            Optionaleasing

            easing?: ((t: number) => number)

            Optionalinterpolate

            interpolate?: ((a: T, b: T) => ((t: number) => T))

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_store.Readable-1.html b/docs/interfaces/svelte_store.Readable-1.html index 7049b2e7..92e88cad 100644 --- a/docs/interfaces/svelte_store.Readable-1.html +++ b/docs/interfaces/svelte_store.Readable-1.html @@ -1,6 +1,7 @@ -Readable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface Readable<T>

            Readable interface for subscribing.

            -
            interface Readable<T> {
                subscribe(this, run, invalidate?): Unsubscriber;
            }

            Type Parameters

            • T

            Hierarchy (view full)

            Methods

            subscribe -

            Methods

            subscribe

            Returns Unsubscriber

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/svelte_store.Writable-1.html b/docs/interfaces/svelte_store.Writable-1.html index d531f423..61116b25 100644 --- a/docs/interfaces/svelte_store.Writable-1.html +++ b/docs/interfaces/svelte_store.Writable-1.html @@ -1,12 +1,13 @@ -Writable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface Writable<T>

            Writable interface for both updating and subscribing.

            -
            interface Writable<T> {
                set(this, value): void;
                subscribe(this, run, invalidate?): Unsubscriber;
                update(this, updater): void;
            }

            Type Parameters

            • T

            Hierarchy (view full)

            Methods

            set +Writable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface Writable<T>

            Writable interface for both updating and subscribing.

            +
            interface Writable<T> {
                set(this: void, value: T): void;
                subscribe(this: void, run: Subscriber<T>, invalidate?: Invalidator<T>): Unsubscriber;
                update(this: void, updater: Updater<T>): void;
            }

            Type Parameters

            • T

            Hierarchy (view full)

            Methods

            set subscribe update -

            Methods

            set

            • set(this, value): void

            • Set value and inform subscribers.

              +

            Methods

            set

            • set(this, value): void

            • Set value and inform subscribers.

              Parameters

              • this: void
              • value: T

                to set

              Returns void

            subscribe

            update

            • update(this, updater): void

            • Update value using callback and inform subscribers.

              Parameters

              Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            setsubscribeupdate
            \ No newline at end of file +

            Returns void

            Settings

            Member Visibility

            On This Page

            Methods
            \ No newline at end of file diff --git a/docs/interfaces/svelte_transition.BlurParams.html b/docs/interfaces/svelte_transition.BlurParams.html index fa040609..4e080b5a 100644 --- a/docs/interfaces/svelte_transition.BlurParams.html +++ b/docs/interfaces/svelte_transition.BlurParams.html @@ -1,6 +1,7 @@ -BlurParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface BlurParams

            interface BlurParams {
                amount?: string | number;
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
                opacity?: number;
            }

            Properties

            amount? +BlurParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface BlurParams

            interface BlurParams {
                amount?: string | number;
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
                opacity?: number;
            }

            Properties

            amount? delay? duration? easing? opacity? -

            Properties

            Optional amount

            amount?: string | number

            Optional delay

            delay?: number

            Optional duration

            duration?: number

            Optional easing

            easing?: EasingFunction

            Optional opacity

            opacity?: number

            Settings

            Member Visibility

            Theme

            On This Page

            amountdelaydurationeasingopacity
            \ No newline at end of file +

            Properties

            Optionalamount

            amount?: string | number

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number

            Optionaleasing

            easing?: EasingFunction

            Optionalopacity

            opacity?: number

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_transition.CrossfadeParams.html b/docs/interfaces/svelte_transition.CrossfadeParams.html index db1f709a..db01a11f 100644 --- a/docs/interfaces/svelte_transition.CrossfadeParams.html +++ b/docs/interfaces/svelte_transition.CrossfadeParams.html @@ -1,4 +1,5 @@ -CrossfadeParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface CrossfadeParams

            interface CrossfadeParams {
                delay?: number;
                duration?: number | ((len) => number);
                easing?: EasingFunction;
            }

            Properties

            delay? +CrossfadeParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface CrossfadeParams

            interface CrossfadeParams {
                delay?: number;
                duration?: number | ((len: number) => number);
                easing?: EasingFunction;
            }

            Properties

            delay? duration? easing? -

            Properties

            Optional delay

            delay?: number

            Optional duration

            duration?: number | ((len) => number)

            Type declaration

              • (len): number

              • Parameters

                • len: number

                Returns number

            Optional easing

            easing?: EasingFunction

            Settings

            Member Visibility

            Theme

            On This Page

            delaydurationeasing
            \ No newline at end of file +

            Properties

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number | ((len: number) => number)

            Optionaleasing

            easing?: EasingFunction

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_transition.DrawParams.html b/docs/interfaces/svelte_transition.DrawParams.html index 847a5aa0..a75a250b 100644 --- a/docs/interfaces/svelte_transition.DrawParams.html +++ b/docs/interfaces/svelte_transition.DrawParams.html @@ -1,5 +1,6 @@ -DrawParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface DrawParams

            interface DrawParams {
                delay?: number;
                duration?: number | ((len) => number);
                easing?: EasingFunction;
                speed?: number;
            }

            Properties

            delay? +DrawParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface DrawParams

            interface DrawParams {
                delay?: number;
                duration?: number | ((len: number) => number);
                easing?: EasingFunction;
                speed?: number;
            }

            Properties

            delay? duration? easing? speed? -

            Properties

            Optional delay

            delay?: number

            Optional duration

            duration?: number | ((len) => number)

            Type declaration

              • (len): number

              • Parameters

                • len: number

                Returns number

            Optional easing

            easing?: EasingFunction

            Optional speed

            speed?: number

            Settings

            Member Visibility

            Theme

            On This Page

            delaydurationeasingspeed
            \ No newline at end of file +

            Properties

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number | ((len: number) => number)

            Optionaleasing

            easing?: EasingFunction

            Optionalspeed

            speed?: number

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_transition.FadeParams.html b/docs/interfaces/svelte_transition.FadeParams.html index f89f9992..0ae57288 100644 --- a/docs/interfaces/svelte_transition.FadeParams.html +++ b/docs/interfaces/svelte_transition.FadeParams.html @@ -1,4 +1,5 @@ -FadeParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface FadeParams

            interface FadeParams {
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
            }

            Properties

            delay? +FadeParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface FadeParams

            interface FadeParams {
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
            }

            Properties

            delay? duration? easing? -

            Properties

            Optional delay

            delay?: number

            Optional duration

            duration?: number

            Optional easing

            easing?: EasingFunction

            Settings

            Member Visibility

            Theme

            On This Page

            delaydurationeasing
            \ No newline at end of file +

            Properties

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number

            Optionaleasing

            easing?: EasingFunction

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_transition.FlyParams.html b/docs/interfaces/svelte_transition.FlyParams.html index 34176b42..04b8095f 100644 --- a/docs/interfaces/svelte_transition.FlyParams.html +++ b/docs/interfaces/svelte_transition.FlyParams.html @@ -1,7 +1,8 @@ -FlyParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface FlyParams

            interface FlyParams {
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
                opacity?: number;
                x?: string | number;
                y?: string | number;
            }

            Properties

            delay? +FlyParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface FlyParams

            interface FlyParams {
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
                opacity?: number;
                x?: string | number;
                y?: string | number;
            }

            Properties

            delay? duration? easing? opacity? x? y? -

            Properties

            Optional delay

            delay?: number

            Optional duration

            duration?: number

            Optional easing

            easing?: EasingFunction

            Optional opacity

            opacity?: number

            Optional x

            x?: string | number

            Optional y

            y?: string | number

            Settings

            Member Visibility

            Theme

            On This Page

            delaydurationeasingopacityxy
            \ No newline at end of file +

            Properties

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number

            Optionaleasing

            easing?: EasingFunction

            Optionalopacity

            opacity?: number

            Optionalx

            x?: string | number

            Optionaly

            y?: string | number

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_transition.ScaleParams.html b/docs/interfaces/svelte_transition.ScaleParams.html index e45f5027..265ff237 100644 --- a/docs/interfaces/svelte_transition.ScaleParams.html +++ b/docs/interfaces/svelte_transition.ScaleParams.html @@ -1,6 +1,7 @@ -ScaleParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface ScaleParams

            interface ScaleParams {
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
                opacity?: number;
                start?: number;
            }

            Properties

            delay? +ScaleParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface ScaleParams

            interface ScaleParams {
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
                opacity?: number;
                start?: number;
            }

            Properties

            delay? duration? easing? opacity? start? -

            Properties

            Optional delay

            delay?: number

            Optional duration

            duration?: number

            Optional easing

            easing?: EasingFunction

            Optional opacity

            opacity?: number

            Optional start

            start?: number

            Settings

            Member Visibility

            Theme

            On This Page

            delaydurationeasingopacitystart
            \ No newline at end of file +

            Properties

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number

            Optionaleasing

            easing?: EasingFunction

            Optionalopacity

            opacity?: number

            Optionalstart

            start?: number

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_transition.SlideParams.html b/docs/interfaces/svelte_transition.SlideParams.html index a313d409..b0a3fcc8 100644 --- a/docs/interfaces/svelte_transition.SlideParams.html +++ b/docs/interfaces/svelte_transition.SlideParams.html @@ -1,5 +1,6 @@ -SlideParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface SlideParams

            interface SlideParams {
                axis?: "x" | "y";
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
            }

            Properties

            axis? +SlideParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface SlideParams

            interface SlideParams {
                axis?: "x" | "y";
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
            }

            Properties

            axis? delay? duration? easing? -

            Properties

            Optional axis

            axis?: "x" | "y"

            Optional delay

            delay?: number

            Optional duration

            duration?: number

            Optional easing

            easing?: EasingFunction

            Settings

            Member Visibility

            Theme

            On This Page

            axisdelaydurationeasing
            \ No newline at end of file +

            Properties

            Optionalaxis

            axis?: "x" | "y"

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number

            Optionaleasing

            easing?: EasingFunction

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/interfaces/svelte_transition.TransitionConfig.html b/docs/interfaces/svelte_transition.TransitionConfig.html index 0dfe4005..81f939a6 100644 --- a/docs/interfaces/svelte_transition.TransitionConfig.html +++ b/docs/interfaces/svelte_transition.TransitionConfig.html @@ -1,6 +1,7 @@ -TransitionConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

            Interface TransitionConfig

            interface TransitionConfig {
                css?: ((t, u) => string);
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
                tick?: ((t, u) => void);
            }

            Properties

            css? +TransitionConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
            +

            Interface TransitionConfig

            interface TransitionConfig {
                css?: ((t: number, u: number) => string);
                delay?: number;
                duration?: number;
                easing?: EasingFunction;
                tick?: ((t: number, u: number) => void);
            }

            Properties

            css? delay? duration? easing? tick? -

            Properties

            Optional css

            css?: ((t, u) => string)

            Type declaration

              • (t, u): string

              • Parameters

                • t: number
                • u: number

                Returns string

            Optional delay

            delay?: number

            Optional duration

            duration?: number

            Optional easing

            easing?: EasingFunction

            Optional tick

            tick?: ((t, u) => void)

            Type declaration

              • (t, u): void

              • Parameters

                • t: number
                • u: number

                Returns void

            Settings

            Member Visibility

            Theme

            On This Page

            cssdelaydurationeasingtick
            \ No newline at end of file +

            Properties

            Optionalcss

            css?: ((t: number, u: number) => string)

            Optionaldelay

            delay?: number

            Optionalduration

            duration?: number

            Optionaleasing

            easing?: EasingFunction

            Optionaltick

            tick?: ((t: number, u: number) => void)

            Settings

            Member Visibility

            On This Page

            Properties
            \ No newline at end of file diff --git a/docs/modules/_runtime_color_colord.html b/docs/modules/_runtime_color_colord.html index f2a99143..9bd9543e 100644 --- a/docs/modules/_runtime_color_colord.html +++ b/docs/modules/_runtime_color_colord.html @@ -1,7 +1,8 @@ -#runtime/color/colord | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

              Package #runtime/color/colord

              Documentation: https://github.com/omgovich/colord#getting-started

              +#runtime/color/colord | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
              +

                Package #runtime/color/colord

                Documentation: https://github.com/omgovich/colord#getting-started

                Note: For the time being colord provides the best API / support for working with color with Javascript. It however may not be the long term solution for TRL.

                -
                +

                Index @@ -17,17 +18,17 @@

                LchColor XyzColor

                Type Aliases

                AnyColor -HslColor HslaColor -HsvColor +HslColor HsvaColor -HwbColor +HsvColor HwbaColor +HwbColor LabaColor LchaColor Plugin -RgbColor RgbaColor +RgbColor XyzaColor
                -

                Settings

                Member Visibility

                Theme

                \ No newline at end of file +

                Settings

                Member Visibility
                \ No newline at end of file diff --git a/docs/modules/_runtime_color_colord_plugins.html b/docs/modules/_runtime_color_colord_plugins.html index 48c8a898..8a90f2cd 100644 --- a/docs/modules/_runtime_color_colord_plugins.html +++ b/docs/modules/_runtime_color_colord_plugins.html @@ -1,10 +1,12 @@ -#runtime/color/colord/plugins | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                  Package #runtime/color/colord/plugins

                  Documentation: https://github.com/omgovich/colord#plugins

                  +#runtime/color/colord/plugins | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                  +

                    Package #runtime/color/colord/plugins

                    Documentation: https://github.com/omgovich/colord#plugins

                    There are several colord plugins that extend colord for additional color formats. These plugins are available as wildcard imports from this sub-path export. It is worth mentioning that colord does not provide accurate support for advanced color formats as the intermediary internal format is RGBA and a loss of precision occurs internally.

                    Note: For the time being colord provides the best API / support for working with color with Javascript. It however may not be the long term solution for TRL.

                    To extend colord with a particular plugin:

                    -

                    Example

                    import { colord, extend }  from '#runtime/color/colord';
                    import a11yPlugin          from "#runtime/color/colord/plugins/a11y";

                    extend([a11yPlugin]);
-
                    -

                    Settings

                    Member Visibility

                    Theme

                    \ No newline at end of file +

                    Example

                    import { colord, extend }  from '#runtime/color/colord';
                    import a11yPlugin          from "#runtime/color/colord/plugins/a11y";

                    extend([a11yPlugin]);
+
                    + +

                    Settings

                    Member Visibility
                    \ No newline at end of file diff --git a/docs/modules/_runtime_data_compress.html b/docs/modules/_runtime_data_compress.html index ba03a1ac..9fe56bf1 100644 --- a/docs/modules/_runtime_data_compress.html +++ b/docs/modules/_runtime_data_compress.html @@ -1,4 +1,5 @@ -#runtime/data/compress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                      Package #runtime/data/compress

                      Classes

                      AsyncCompress +#runtime/data/compress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                      +

                        Package #runtime/data/compress

                        Classes

                        AsyncCompress AsyncDecompress AsyncDeflate AsyncGunzip @@ -85,7 +86,7 @@ UnzipFileHandler ZippableFile

                        References

                        AsyncGzip -Gzip -gzip +gzip +Gzip gzipSync -

                        References

                        AsyncGzip

                        Renames and re-exports AsyncCompress

                        Gzip

                        Renames and re-exports Compress

                        gzip

                        Renames and re-exports compress

                        gzipSync

                        Renames and re-exports compressSync

                        Settings

                        Member Visibility

                        Theme

                        On This Page

                        AsyncGzipGzipgzipgzipSync
                        \ No newline at end of file +

                        References

                        AsyncGzip

                        Renames and re-exports AsyncCompress

                        gzip

                        Renames and re-exports compress

                        Gzip

                        Renames and re-exports Compress

                        gzipSync

                        Renames and re-exports compressSync

                        Settings

                        Member Visibility

                        On This Page

                        References
                        \ No newline at end of file diff --git a/docs/modules/_runtime_data_format_base64.html b/docs/modules/_runtime_data_format_base64.html index abc53129..8ed84f84 100644 --- a/docs/modules/_runtime_data_format_base64.html +++ b/docs/modules/_runtime_data_format_base64.html @@ -1,4 +1,5 @@ -#runtime/data/format/base64 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                          Package #runtime/data/format/base64

                          Functions

                          atob +#runtime/data/format/base64 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                          +

                            Package #runtime/data/format/base64

                            Functions

                            atob atobPolyfill btoa btoaPolyfill @@ -14,9 +15,9 @@ toUint8Array utob

                            Variables

                            Base64 -VERSION -version +version +VERSION

                            References

                            encodeURL fromBase64 toBase64 -

                            References

                            encodeURL

                            Renames and re-exports encodeURI

                            fromBase64

                            Renames and re-exports decode

                            toBase64

                            Renames and re-exports encode

                            Settings

                            Member Visibility

                            Theme

                            On This Page

                            encodeURLfromBase64toBase64
                            \ No newline at end of file +

                            References

                            encodeURL

                            Renames and re-exports encodeURI

                            fromBase64

                            Renames and re-exports decode

                            toBase64

                            Renames and re-exports encode

                            Settings

                            Member Visibility

                            On This Page

                            References
                            \ No newline at end of file diff --git a/docs/modules/_runtime_data_format_json5.html b/docs/modules/_runtime_data_format_json5.html index 37ba34c8..10964dc1 100644 --- a/docs/modules/_runtime_data_format_json5.html +++ b/docs/modules/_runtime_data_format_json5.html @@ -1,4 +1,5 @@ -#runtime/data/format/json5 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                              Package #runtime/data/format/json5

                              +#runtime/data/format/json5 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                              +

                                Package #runtime/data/format/json5

                                Index @@ -8,4 +9,4 @@

                                Interfaces

                                JSON5

                                Type Aliases

                                StringifyOptions

                                -

                                Settings

                                Member Visibility

                                Theme

                                \ No newline at end of file +

                                Settings

                                Member Visibility
                                \ No newline at end of file diff --git a/docs/modules/_runtime_data_format_msgpack.html b/docs/modules/_runtime_data_format_msgpack.html index 189df5f4..ab320665 100644 --- a/docs/modules/_runtime_data_format_msgpack.html +++ b/docs/modules/_runtime_data_format_msgpack.html @@ -1,4 +1,5 @@ -#runtime/data/format/msgpack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                  Package #runtime/data/format/msgpack

                                  +#runtime/data/format/msgpack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                  +

                                    Package #runtime/data/format/msgpack

                                    Index @@ -24,4 +25,4 @@

                                    Enumerations

                                    FLOAT32_OPTIONS

                                    Interfaces

                                    Options
                                    -

                                    Settings

                                    Member Visibility

                                    Theme

                                    \ No newline at end of file +

                                    Settings

                                    Member Visibility
                                    \ No newline at end of file diff --git a/docs/modules/_runtime_data_format_msgpack_compress.html b/docs/modules/_runtime_data_format_msgpack_compress.html index 25f77aaa..26f07bcc 100644 --- a/docs/modules/_runtime_data_format_msgpack_compress.html +++ b/docs/modules/_runtime_data_format_msgpack_compress.html @@ -1,4 +1,5 @@ -#runtime/data/format/msgpack/compress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                      Package #runtime/data/format/msgpack/compress

                                      +#runtime/data/format/msgpack/compress | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                      +

                                        Package #runtime/data/format/msgpack/compress

                                        Index @@ -10,4 +11,4 @@

                                        packAndDeflate packAndDeflateB64

                                        -

                                        Settings

                                        Member Visibility

                                        Theme

                                        \ No newline at end of file +

                                        Settings

                                        Member Visibility
                                        \ No newline at end of file diff --git a/docs/modules/_runtime_data_format_unicode.html b/docs/modules/_runtime_data_format_unicode.html index 4c2cec17..a0e28355 100644 --- a/docs/modules/_runtime_data_format_unicode.html +++ b/docs/modules/_runtime_data_format_unicode.html @@ -1,4 +1,5 @@ -#runtime/data/format/unicode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                          Package #runtime/data/format/unicode

                                          +#runtime/data/format/unicode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                          +

                                            Package #runtime/data/format/unicode

                                            Index @@ -8,4 +9,4 @@

                                            Functions

                                            graphemeIterator graphemeSplit

                                            -

                                            Settings

                                            Member Visibility

                                            Theme

                                            \ No newline at end of file +

                                            Settings

                                            Member Visibility
                                            \ No newline at end of file diff --git a/docs/modules/_runtime_data_struct_cache_quick_lru.html b/docs/modules/_runtime_data_struct_cache_quick_lru.html index f8fc37f5..5240ab94 100644 --- a/docs/modules/_runtime_data_struct_cache_quick_lru.html +++ b/docs/modules/_runtime_data_struct_cache_quick_lru.html @@ -1,4 +1,5 @@ -#runtime/data/struct/cache/quick-lru | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                              Package #runtime/data/struct/cache/quick-lru

                                              +#runtime/data/struct/cache/quick-lru | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                              +

                                                Package #runtime/data/struct/cache/quick-lru

                                                Index @@ -8,4 +9,4 @@

                                                Classes

                                                QuickLRU

                                                Type Aliases

                                                Options

                                                -

                                                Settings

                                                Member Visibility

                                                Theme

                                                \ No newline at end of file +

                                                Settings

                                                Member Visibility
                                                \ No newline at end of file diff --git a/docs/modules/_runtime_data_struct_hash_array.html b/docs/modules/_runtime_data_struct_hash_array.html index eafa4b26..0d609464 100644 --- a/docs/modules/_runtime_data_struct_hash_array.html +++ b/docs/modules/_runtime_data_struct_hash_array.html @@ -1,4 +1,5 @@ -#runtime/data/struct/hash/array | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                  Package #runtime/data/struct/hash/array

                                                  +#runtime/data/struct/hash/array | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                  +

                                                    Package #runtime/data/struct/hash/array

                                                    Index @@ -12,4 +13,4 @@

                                                    Key KeyFields

                                                    -

                                                    Settings

                                                    Member Visibility

                                                    Theme

                                                    \ No newline at end of file +

                                                    Settings

                                                    Member Visibility
                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_data_struct_search_trie.html b/docs/modules/_runtime_data_struct_search_trie.html index 11bd8033..83e95b27 100644 --- a/docs/modules/_runtime_data_struct_search_trie.html +++ b/docs/modules/_runtime_data_struct_search_trie.html @@ -1,4 +1,5 @@ -#runtime/data/struct/search/trie | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                      Package #runtime/data/struct/search/trie

                                                      Classes

                                                      TrieSearch +#runtime/data/struct/search/trie | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                      +

                                                        Package #runtime/data/struct/search/trie

                                                        Classes

                                                        TrieSearch UnionReducer

                                                        Interfaces

                                                        ITrieSearchReducer

                                                        Type Aliases

                                                        TrieNode @@ -6,7 +7,7 @@ TrieSearchReducerData TrieSearchReducerResetData TrieSearchSubscribeHandler -

                                                        References

                                                        Key +

                                                        References

                                                        getValueFromKey +Key KeyFields -getValueFromKey -

                                                        References

                                                        Key

                                                        Re-exports Key

                                                        KeyFields

                                                        Re-exports KeyFields

                                                        getValueFromKey

                                                        Re-exports getValueFromKey

                                                        Settings

                                                        Member Visibility

                                                        Theme

                                                        On This Page

                                                        KeyKeyFieldsgetValueFromKey
                                                        \ No newline at end of file +

                                                        References

                                                        getValueFromKey

                                                        Re-exports getValueFromKey

                                                        Key

                                                        Re-exports Key

                                                        KeyFields

                                                        Re-exports KeyFields

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        References
                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_data_struct_search_trie_query.html b/docs/modules/_runtime_data_struct_search_trie_query.html index f3d9c335..87d58108 100644 --- a/docs/modules/_runtime_data_struct_search_trie_query.html +++ b/docs/modules/_runtime_data_struct_search_trie_query.html @@ -1,4 +1,5 @@ -#runtime/data/struct/search/trie/query | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                          Package #runtime/data/struct/search/trie/query

                                                          +#runtime/data/struct/search/trie/query | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                          +

                                                            Package #runtime/data/struct/search/trie/query

                                                            Index @@ -8,4 +9,4 @@

                                                            Classes

                                                            TrieSearchQuery

                                                            Type Aliases

                                                            TrieSearchQueryOptions

                                                            -

                                                            Settings

                                                            Member Visibility

                                                            Theme

                                                            \ No newline at end of file +

                                                            Settings

                                                            Member Visibility
                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_math_gl_matrix.html b/docs/modules/_runtime_math_gl_matrix.html index eebf76f0..34f979fa 100644 --- a/docs/modules/_runtime_math_gl_matrix.html +++ b/docs/modules/_runtime_math_gl_matrix.html @@ -1,4 +1,6 @@ -#runtime/math/gl-matrix | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                              Package #runtime/math/gl-matrix

                                                              +#runtime/math/gl-matrix | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                              +

                                                                Package #runtime/math/gl-matrix

                                                                Provides the gl-matrix 32-bit library.

                                                                +

                                                                Index @@ -14,9 +16,9 @@

                                                                Vec2 Vec3 Vec4 -

                                                                Functions

                                                                EnableSwizzles -

                                                                Type Aliases

                                                                Mat2Like +

                                                                Type Aliases

                                                                FloatArray Mat2dLike +Mat2Like Mat3Like Mat4Like Quat2Like @@ -25,4 +27,4 @@

                                                                Vec3Like Vec4Like

                                                                -

                                                                Settings

                                                                Member Visibility

                                                                Theme

                                                                \ No newline at end of file +

                                                                Settings

                                                                Member Visibility
                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_math_interpolate.html b/docs/modules/_runtime_math_interpolate.html index 3f9dbe85..849c4166 100644 --- a/docs/modules/_runtime_math_interpolate.html +++ b/docs/modules/_runtime_math_interpolate.html @@ -1,4 +1,5 @@ -#runtime/math/interpolate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                  Package #runtime/math/interpolate

                                                                  +#runtime/math/interpolate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                  +

                                                                    Package #runtime/math/interpolate

                                                                    Index @@ -9,4 +10,4 @@

                                                                    Interfaces

                                                                    InterpolateFunction

                                                                    Type Aliases

                                                                    InterpolateFunctionName
                                                                    -

                                                                    Settings

                                                                    Member Visibility

                                                                    Theme

                                                                    \ No newline at end of file +

                                                                    Settings

                                                                    Member Visibility
                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_math_physics.html b/docs/modules/_runtime_math_physics.html index f243f104..d242fd05 100644 --- a/docs/modules/_runtime_math_physics.html +++ b/docs/modules/_runtime_math_physics.html @@ -1,4 +1,5 @@ -#runtime/math/physics | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                      Package #runtime/math/physics

                                                                      +#runtime/math/physics | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                      +

                                                                        Package #runtime/math/physics

                                                                        Index @@ -7,4 +8,4 @@

                                                                        Classes

                                                                        TJSVelocityTrack
                                                                        -

                                                                        Settings

                                                                        Member Visibility

                                                                        Theme

                                                                        \ No newline at end of file +

                                                                        Settings

                                                                        Member Visibility
                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_math_util.html b/docs/modules/_runtime_math_util.html index 2cbff4a9..ea132a0a 100644 --- a/docs/modules/_runtime_math_util.html +++ b/docs/modules/_runtime_math_util.html @@ -1,4 +1,5 @@ -#runtime/math/util | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                          Package #runtime/math/util

                                                                          +#runtime/math/util | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                          +

                                                                            Package #runtime/math/util

                                                                            Index @@ -10,4 +11,4 @@

                                                                            degToRad radToDeg

                                                                            -

                                                                            Settings

                                                                            Member Visibility

                                                                            Theme

                                                                            \ No newline at end of file +

                                                                            Settings

                                                                            Member Visibility
                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_plugin_manager.html b/docs/modules/_runtime_plugin_manager.html index fa79b304..b7a6dba5 100644 --- a/docs/modules/_runtime_plugin_manager.html +++ b/docs/modules/_runtime_plugin_manager.html @@ -1,7 +1,8 @@ -#runtime/plugin/manager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                              Package #runtime/plugin/manager

                                                                              Provides a lightweight plugin manager for Node / NPM & the browser with eventbus integration for plugins in a safe +#runtime/plugin/manager | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                              +

                                                                                Package #runtime/plugin/manager

                                                                                Provides a lightweight plugin manager for Node / NPM & the browser with eventbus integration for plugins in a safe and protected manner across NPM modules, local files, and preloaded object instances. This pattern facilitates message passing between modules versus direct dependencies / method invocation.

                                                                                -
                                                                                +

                                                                                Index @@ -23,4 +24,4 @@

                                                                                PluginEventData PluginManagerOptions

                                                                                -

                                                                                Settings

                                                                                Member Visibility

                                                                                Theme

                                                                                \ No newline at end of file +

                                                                                Settings

                                                                                Member Visibility
                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_plugin_manager_eventbus.html b/docs/modules/_runtime_plugin_manager_eventbus.html index 4e470a4f..e5bc0133 100644 --- a/docs/modules/_runtime_plugin_manager_eventbus.html +++ b/docs/modules/_runtime_plugin_manager_eventbus.html @@ -1,10 +1,11 @@ -#runtime/plugin/manager/eventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                  Package #runtime/plugin/manager/eventbus

                                                                                  Provides an in-process eventbus for registering and triggering events. There are three varieties from the main +#runtime/plugin/manager/eventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                  +

                                                                                    Package #runtime/plugin/manager/eventbus

                                                                                    Provides an in-process eventbus for registering and triggering events. There are three varieties from the main Eventbus to the EventbusProxy and EventbusSecure variations. A proxy eventbus tracks local registrations to an associated Eventbus and makes it easy to unregister all events on the main eventbus through the proxy solving the dangling listener issue. Proxy eventbuses are used in the TyphonJS PluginManager to manage plugin access to the manager eventbus. There also is a secure variation that can not have events registered and only is accessible for triggering events.

                                                                                    -
                                                                                    +

                                                                                    Index @@ -14,11 +15,11 @@

                                                                                    Classes

                                                                                    Eventbus EventbusProxy EventbusSecure -

                                                                                    Type Aliases

                                                                                    EventData +

                                                                                    Type Aliases

                                                                                    EventbusEvents +EventbusSecureObj +EventData EventMap EventOptions EventOptionsOut -EventbusEvents -EventbusSecureObj

                                                                                    -

                                                                                    Settings

                                                                                    Member Visibility

                                                                                    Theme

                                                                                    \ No newline at end of file +

                                                                                    Settings

                                                                                    Member Visibility
                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_plugin_manager_eventbus_buses.html b/docs/modules/_runtime_plugin_manager_eventbus_buses.html index 28539e58..eb65d5ef 100644 --- a/docs/modules/_runtime_plugin_manager_eventbus_buses.html +++ b/docs/modules/_runtime_plugin_manager_eventbus_buses.html @@ -1,9 +1,11 @@ -#runtime/plugin/manager/eventbus/buses | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                      Package #runtime/plugin/manager/eventbus/buses

                                                                                      Provides several standard Eventbus instances that are accessible through named exports: mainEventbus, +#runtime/plugin/manager/eventbus/buses | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                      +

                                                                                        Package #runtime/plugin/manager/eventbus/buses

                                                                                        Provides several standard Eventbus instances that are accessible through named exports: mainEventbus, pluginEventbus, and testEventbus. For the most part these instances are useful for testing applications to have easy access across the runtime to consistent instances.

                                                                                        -

                                                                                        Example

                                                                                        import { mainEventbus, pluginEventbus, testEventbus } from '#runtime/plugin/manager/eventbus/buses';
-
                                                                                        -
                                                                                        +

                                                                                        Example

                                                                                        import { mainEventbus, pluginEventbus, testEventbus } from '#runtime/plugin/manager/eventbus/buses';
+
                                                                                        + +

                                                                                        Index @@ -14,4 +16,4 @@

                                                                                        pluginEventbus testEventbus

                                                                                        -

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        Theme

                                                                                        \ No newline at end of file +

                                                                                        Settings

                                                                                        Member Visibility
                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_security_client_dompurify.DOMPurify-1.html b/docs/modules/_runtime_security_client_dompurify.DOMPurify-1.html index 43e6d2ed..8561a636 100644 --- a/docs/modules/_runtime_security_client_dompurify.DOMPurify-1.html +++ b/docs/modules/_runtime_security_client_dompurify.DOMPurify-1.html @@ -1,2 +1,11 @@ -DOMPurify | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                        Namespace DOMPurify

                                                                                        Index

                                                                                        Functions

                                                                                        sanitizeWithVideo -

                                                                                        Settings

                                                                                        Member Visibility

                                                                                        Theme

                                                                                        \ No newline at end of file +DOMPurify | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                        +

                                                                                        Namespace DOMPurify

                                                                                        + +

                                                                                        + Index +

                                                                                        +                                                                                         +
                                                                                        +

                                                                                        Functions

                                                                                        sanitizeWithVideo +
                                                                                        +

                                                                                        Settings

                                                                                        Member Visibility
                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_security_client_dompurify.html b/docs/modules/_runtime_security_client_dompurify.html index 957fd462..cb867396 100644 --- a/docs/modules/_runtime_security_client_dompurify.html +++ b/docs/modules/_runtime_security_client_dompurify.html @@ -1,4 +1,5 @@ -#runtime/security/client/dompurify | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                          Package #runtime/security/client/dompurify

                                                                                          +#runtime/security/client/dompurify | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                          +

                                                                                            Package #runtime/security/client/dompurify

                                                                                            Index @@ -8,4 +9,4 @@

                                                                                            Functions

                                                                                            DOMPurify

                                                                                            Namespaces

                                                                                            DOMPurify

                                                                                            -

                                                                                            Settings

                                                                                            Member Visibility

                                                                                            Theme

                                                                                            \ No newline at end of file +

                                                                                            Settings

                                                                                            Member Visibility
                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_animate.html b/docs/modules/_runtime_svelte_action_animate.html index e1e590f9..131f0c08 100644 --- a/docs/modules/_runtime_svelte_action_animate.html +++ b/docs/modules/_runtime_svelte_action_animate.html @@ -1,4 +1,5 @@ -#runtime/svelte/action/animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                              Package #runtime/svelte/action/animate

                                                                                              +#runtime/svelte/action/animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                              +

                                                                                                Package #runtime/svelte/action/animate

                                                                                                Index @@ -11,4 +12,4 @@

                                                                                                rippleFocus toggleDetails

                                                                                                -

                                                                                                Settings

                                                                                                Member Visibility

                                                                                                Theme

                                                                                                \ No newline at end of file +

                                                                                                Settings

                                                                                                Member Visibility
                                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_dom.html b/docs/modules/_runtime_svelte_action_dom.html index 809c61e7..26bba9a8 100644 --- a/docs/modules/_runtime_svelte_action_dom.html +++ b/docs/modules/_runtime_svelte_action_dom.html @@ -1,4 +1,5 @@ -#runtime/svelte/action/dom | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                  Package #runtime/svelte/action/dom

                                                                                                  +#runtime/svelte/action/dom | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                  +

                                                                                                    Package #runtime/svelte/action/dom

                                                                                                    Index @@ -13,4 +14,4 @@

                                                                                                    resizeObserver

                                                                                                    Namespaces

                                                                                                    resizeObserver
                                                                                                    -

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    Theme

                                                                                                    \ No newline at end of file +

                                                                                                    Settings

                                                                                                    Member Visibility
                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_dom.resizeObserver-1.html b/docs/modules/_runtime_svelte_action_dom.resizeObserver-1.html index cf6f7211..6fc53af7 100644 --- a/docs/modules/_runtime_svelte_action_dom.resizeObserver-1.html +++ b/docs/modules/_runtime_svelte_action_dom.resizeObserver-1.html @@ -1,2 +1,11 @@ -resizeObserver | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                    Namespace resizeObserver

                                                                                                    Index

                                                                                                    Functions

                                                                                                    updateCache -

                                                                                                    Settings

                                                                                                    Member Visibility

                                                                                                    Theme

                                                                                                    \ No newline at end of file +resizeObserver | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                    +

                                                                                                    Namespace resizeObserver

                                                                                                    + +

                                                                                                    + Index +

                                                                                                    +                                                                                                     +
                                                                                                    +

                                                                                                    Functions

                                                                                                    updateCache +
                                                                                                    +

                                                                                                    Settings

                                                                                                    Member Visibility
                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_util.html b/docs/modules/_runtime_svelte_action_util.html index 34280863..a4716e48 100644 --- a/docs/modules/_runtime_svelte_action_util.html +++ b/docs/modules/_runtime_svelte_action_util.html @@ -1,4 +1,5 @@ -#runtime/svelte/action/util | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                      Package #runtime/svelte/action/util

                                                                                                      +#runtime/svelte/action/util | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                      +

                                                                                                        Package #runtime/svelte/action/util

                                                                                                        Index @@ -8,4 +9,4 @@

                                                                                                        Functions

                                                                                                        dynamicAction

                                                                                                        Type Aliases

                                                                                                        DynamicActionOptions

                                                                                                        -

                                                                                                        Settings

                                                                                                        Member Visibility

                                                                                                        Theme

                                                                                                        \ No newline at end of file +

                                                                                                        Settings

                                                                                                        Member Visibility
                                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_animate.html b/docs/modules/_runtime_svelte_animate.html index c46fa2b4..ca73d738 100644 --- a/docs/modules/_runtime_svelte_animate.html +++ b/docs/modules/_runtime_svelte_animate.html @@ -1,4 +1,5 @@ -#runtime/svelte/animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                          Package #runtime/svelte/animate

                                                                                                          +#runtime/svelte/animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                          +

                                                                                                            Package #runtime/svelte/animate

                                                                                                            Index @@ -7,4 +8,4 @@

                                                                                                            Functions

                                                                                                            animateEvents
                                                                                                            -

                                                                                                            Settings

                                                                                                            Member Visibility

                                                                                                            Theme

                                                                                                            \ No newline at end of file +

                                                                                                            Settings

                                                                                                            Member Visibility
                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_application.html b/docs/modules/_runtime_svelte_application.html index 97a24e7e..26696556 100644 --- a/docs/modules/_runtime_svelte_application.html +++ b/docs/modules/_runtime_svelte_application.html @@ -1,4 +1,5 @@ -#runtime/svelte/application | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                              Package #runtime/svelte/application

                                                                                                              +#runtime/svelte/application | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                              +

                                                                                                                Package #runtime/svelte/application

                                                                                                                Index @@ -23,4 +24,4 @@

                                                                                                                TJSDialogOptions TJSDialogTransitionOptions

                                                                                                                -

                                                                                                                Settings

                                                                                                                Member Visibility

                                                                                                                Theme

                                                                                                                \ No newline at end of file +

                                                                                                                Settings

                                                                                                                Member Visibility
                                                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_application_legacy.html b/docs/modules/_runtime_svelte_application_legacy.html index d8125484..65450583 100644 --- a/docs/modules/_runtime_svelte_application_legacy.html +++ b/docs/modules/_runtime_svelte_application_legacy.html @@ -1,8 +1,9 @@ -#runtime/svelte/application/legacy | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                  Package #runtime/svelte/application/legacy

                                                                                                                  Provides legacy support for Handlebars rendering while still gaining aspects of reactivity with a Svelte powered +#runtime/svelte/application/legacy | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                  +

                                                                                                                    Package #runtime/svelte/application/legacy

                                                                                                                    Provides legacy support for Handlebars rendering while still gaining aspects of reactivity with a Svelte powered application shell. You may use the resources in this package in a similar manner as the core Foundry Application / FormApplication classes. This should only be an interim or stepwise solution as you convert your package over to fully using TRL & Svelte.

                                                                                                                    -
                                                                                                                    +

                                                                                                                    Index @@ -13,4 +14,4 @@

                                                                                                                    HandlebarsFormApplication SvelteFormApplication

                                                                                                                    -

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    Theme

                                                                                                                    \ No newline at end of file +

                                                                                                                    Settings

                                                                                                                    Member Visibility
                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_core.ApplicationShell-1.html b/docs/modules/_runtime_svelte_component_core.ApplicationShell-1.html index 323d60b4..3bb76ee6 100644 --- a/docs/modules/_runtime_svelte_component_core.ApplicationShell-1.html +++ b/docs/modules/_runtime_svelte_component_core.ApplicationShell-1.html @@ -1,5 +1,14 @@ -ApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                    Namespace ApplicationShell

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    -

                                                                                                                    Index

                                                                                                                    Type Aliases

                                                                                                                    Events +ApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                    +

                                                                                                                    Namespace ApplicationShell

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    +
                                                                                                                    + +

                                                                                                                    + Index +

                                                                                                                    +                                                                                                                     +
                                                                                                                    +

                                                                                                                    Type Aliases

                                                                                                                    Events Props Slots -

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    Theme

                                                                                                                    \ No newline at end of file +
                                                                                                                    +

                                                                                                                    Settings

                                                                                                                    Member Visibility
                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_core.EmptyApplicationShell-1.html b/docs/modules/_runtime_svelte_component_core.EmptyApplicationShell-1.html index 3a5d3786..ce7b2274 100644 --- a/docs/modules/_runtime_svelte_component_core.EmptyApplicationShell-1.html +++ b/docs/modules/_runtime_svelte_component_core.EmptyApplicationShell-1.html @@ -1,5 +1,14 @@ -EmptyApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                    Namespace EmptyApplicationShell

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    -

                                                                                                                    Index

                                                                                                                    Type Aliases

                                                                                                                    Events +EmptyApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                    +

                                                                                                                    Namespace EmptyApplicationShell

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    +
                                                                                                                    + +

                                                                                                                    + Index +

                                                                                                                    +                                                                                                                     +
                                                                                                                    +

                                                                                                                    Type Aliases

                                                                                                                    Events Props Slots -

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    Theme

                                                                                                                    \ No newline at end of file +
                                                                                                                    +

                                                                                                                    Settings

                                                                                                                    Member Visibility
                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_core.TJSApplicationShell-1.html b/docs/modules/_runtime_svelte_component_core.TJSApplicationShell-1.html index 1af163da..36ff4e32 100644 --- a/docs/modules/_runtime_svelte_component_core.TJSApplicationShell-1.html +++ b/docs/modules/_runtime_svelte_component_core.TJSApplicationShell-1.html @@ -1,5 +1,14 @@ -TJSApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                    Namespace TJSApplicationShell

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    -

                                                                                                                    Index

                                                                                                                    Type Aliases

                                                                                                                    Events +TJSApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                    +

                                                                                                                    Namespace TJSApplicationShell

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    +
                                                                                                                    + +

                                                                                                                    + Index +

                                                                                                                    +                                                                                                                     +
                                                                                                                    +

                                                                                                                    Type Aliases

                                                                                                                    Events Props Slots -

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    Theme

                                                                                                                    \ No newline at end of file +
                                                                                                                    +

                                                                                                                    Settings

                                                                                                                    Member Visibility
                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_core.TJSFocusWrap-1.html b/docs/modules/_runtime_svelte_component_core.TJSFocusWrap-1.html index a7e31d63..56a1a9a7 100644 --- a/docs/modules/_runtime_svelte_component_core.TJSFocusWrap-1.html +++ b/docs/modules/_runtime_svelte_component_core.TJSFocusWrap-1.html @@ -1,5 +1,14 @@ -TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                    Namespace TJSFocusWrap

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    -

                                                                                                                    Index

                                                                                                                    Type Aliases

                                                                                                                    Events +TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                    +

                                                                                                                    Namespace TJSFocusWrap

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    +
                                                                                                                    + +

                                                                                                                    + Index +

                                                                                                                    +                                                                                                                     +
                                                                                                                    +

                                                                                                                    Type Aliases

                                                                                                                    Events Props Slots -

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    Theme

                                                                                                                    \ No newline at end of file +
                                                                                                                    +

                                                                                                                    Settings

                                                                                                                    Member Visibility
                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_core.TJSGlassPane-1.html b/docs/modules/_runtime_svelte_component_core.TJSGlassPane-1.html index a1ce002b..8524f053 100644 --- a/docs/modules/_runtime_svelte_component_core.TJSGlassPane-1.html +++ b/docs/modules/_runtime_svelte_component_core.TJSGlassPane-1.html @@ -1,5 +1,14 @@ -TJSGlassPane | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                    Namespace TJSGlassPane

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    -

                                                                                                                    Index

                                                                                                                    Type Aliases

                                                                                                                    Events +TJSGlassPane | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                    +

                                                                                                                    Namespace TJSGlassPane

                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                    +
                                                                                                                    + +

                                                                                                                    + Index +

                                                                                                                    +                                                                                                                     +
                                                                                                                    +

                                                                                                                    Type Aliases

                                                                                                                    Events Props Slots -

                                                                                                                    Settings

                                                                                                                    Member Visibility

                                                                                                                    Theme

                                                                                                                    \ No newline at end of file +
                                                                                                                    +

                                                                                                                    Settings

                                                                                                                    Member Visibility
                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_core.html b/docs/modules/_runtime_svelte_component_core.html index 7a9c9bac..35377280 100644 --- a/docs/modules/_runtime_svelte_component_core.html +++ b/docs/modules/_runtime_svelte_component_core.html @@ -1,4 +1,5 @@ -#runtime/svelte/component/core | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                      Package #runtime/svelte/component/core

                                                                                                                      +#runtime/svelte/component/core | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                      +

                                                                                                                        Package #runtime/svelte/component/core

                                                                                                                        Index @@ -16,4 +17,4 @@

                                                                                                                        TJSFocusWrap TJSGlassPane

                                                                                                                        -

                                                                                                                        Settings

                                                                                                                        Member Visibility

                                                                                                                        Theme

                                                                                                                        \ No newline at end of file +

                                                                                                                        Settings

                                                                                                                        Member Visibility
                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_easing.html b/docs/modules/_runtime_svelte_easing.html index feb2e6bb..dc31bdfd 100644 --- a/docs/modules/_runtime_svelte_easing.html +++ b/docs/modules/_runtime_svelte_easing.html @@ -1,10 +1,11 @@ -#runtime/svelte/easing | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                          Package #runtime/svelte/easing

                                                                                                                          Defines utility functions to select Svelte 1-dimensional easing functions. Take note that if all Svelte easing +#runtime/svelte/easing | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                          +

                                                                                                                            Package #runtime/svelte/easing

                                                                                                                            Defines utility functions to select Svelte 1-dimensional easing functions. Take note that if all Svelte easing functions need to be imported to reduce duplication use easingFunc instead of import * as easingFunc from '#svelte/easing';.

                                                                                                                            -

                                                                                                                            Functions

                                                                                                                            getEasingFunc +

                                                                                                                            Functions

                                                                                                                            getEasingFunc

                                                                                                                            Variables

                                                                                                                            easingFunc easingList

                                                                                                                            Type Aliases

                                                                                                                            EasingFunctionName EasingReference

                                                                                                                            References

                                                                                                                            EasingFunction -

                                                                                                                            References

                                                                                                                            EasingFunction

                                                                                                                            Re-exports EasingFunction

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            Theme

                                                                                                                            On This Page

                                                                                                                            EasingFunction
                                                                                                                            \ No newline at end of file +

                                                                                                                            References

                                                                                                                            EasingFunction

                                                                                                                            Re-exports EasingFunction

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            On This Page

                                                                                                                            References
                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_gsap.Action.html b/docs/modules/_runtime_svelte_gsap.Action.html index b9e5d496..c8d7aa83 100644 --- a/docs/modules/_runtime_svelte_gsap.Action.html +++ b/docs/modules/_runtime_svelte_gsap.Action.html @@ -1,6 +1,15 @@ -Action | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                            Namespace Action

                                                                                                                            Defines the types for the draggableGsap action.

                                                                                                                            -

                                                                                                                            Index

                                                                                                                            Interfaces

                                                                                                                            DraggableGsapOptionsStore +Action | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                            +

                                                                                                                            Namespace Action

                                                                                                                            Defines the types for the draggableGsap action.

                                                                                                                            +
                                                                                                                            + +

                                                                                                                            + Index +

                                                                                                                            +                                                                                                                             +
                                                                                                                            +

                                                                                                                            Interfaces

                                                                                                                            DraggableGsapOptionsStore

                                                                                                                            Type Aliases

                                                                                                                            DraggableGsapOptions GsapInertiaOptions GsapTweenOptions -

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            Theme

                                                                                                                            \ No newline at end of file +
                                                                                                                            +

                                                                                                                            Settings

                                                                                                                            Member Visibility
                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_gsap.Compose.html b/docs/modules/_runtime_svelte_gsap.Compose.html index 9f7993ba..83f58238 100644 --- a/docs/modules/_runtime_svelte_gsap.Compose.html +++ b/docs/modules/_runtime_svelte_gsap.Compose.html @@ -1,5 +1,14 @@ -Compose | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                            Namespace Compose

                                                                                                                            Defines the types for GsapCompose.

                                                                                                                            -

                                                                                                                            Index

                                                                                                                            Type Aliases

                                                                                                                            GsapData +Compose | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                            +

                                                                                                                            Namespace Compose

                                                                                                                            Defines the types for GsapCompose.

                                                                                                                            +
                                                                                                                            + +

                                                                                                                            + Index +

                                                                                                                            +                                                                                                                             +
                                                                                                                            +

                                                                                                                            Type Aliases

                                                                                                                            GsapData GsapPositionOptions GsapTarget -

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            Theme

                                                                                                                            \ No newline at end of file +
                                                                                                                            +

                                                                                                                            Settings

                                                                                                                            Member Visibility
                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_gsap.draggableGsap-1.html b/docs/modules/_runtime_svelte_gsap.draggableGsap-1.html index 2d91c630..fd562706 100644 --- a/docs/modules/_runtime_svelte_gsap.draggableGsap-1.html +++ b/docs/modules/_runtime_svelte_gsap.draggableGsap-1.html @@ -1,2 +1,11 @@ -draggableGsap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                            Namespace draggableGsap

                                                                                                                            Index

                                                                                                                            Functions

                                                                                                                            options -

                                                                                                                            Settings

                                                                                                                            Member Visibility

                                                                                                                            Theme

                                                                                                                            \ No newline at end of file +draggableGsap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                            +

                                                                                                                            Namespace draggableGsap

                                                                                                                            + +

                                                                                                                            + Index +

                                                                                                                            +                                                                                                                             +
                                                                                                                            +

                                                                                                                            Functions

                                                                                                                            options +
                                                                                                                            +

                                                                                                                            Settings

                                                                                                                            Member Visibility
                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_gsap.html b/docs/modules/_runtime_svelte_gsap.html index 8b057ccc..4c70bbe1 100644 --- a/docs/modules/_runtime_svelte_gsap.html +++ b/docs/modules/_runtime_svelte_gsap.html @@ -1,9 +1,10 @@ -#runtime/svelte/gsap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                              Package #runtime/svelte/gsap

                                                                                                                              Documentation: https://greensock.com/docs/v3

                                                                                                                              +#runtime/svelte/gsap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                              +

                                                                                                                                Package #runtime/svelte/gsap

                                                                                                                                Documentation: https://greensock.com/docs/v3

                                                                                                                                Provides automatic hookup and initialization of GSAP. There are several unique resources available in this sub-path export that makes GSAP even easier to use including support for TJSPosition. In particular, GsapCompose is a powerful way to construct GSAP animations declaratively in a data oriented manner and supports hooking up and controlling TJSPosition. There also is a Svelte action to hook up dragging support draggableGsap.

                                                                                                                                -
                                                                                                                                +

                                                                                                                                Index @@ -22,4 +23,4 @@

                                                                                                                                Type Aliases

                                                                                                                                GsapEasingFunctionName GsapEasingReference
                                                                                                                                -

                                                                                                                                Settings

                                                                                                                                Member Visibility

                                                                                                                                Theme

                                                                                                                                \ No newline at end of file +

                                                                                                                                Settings

                                                                                                                                Member Visibility
                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_gsap_plugin.html b/docs/modules/_runtime_svelte_gsap_plugin.html index c152d3c0..595a5ffa 100644 --- a/docs/modules/_runtime_svelte_gsap_plugin.html +++ b/docs/modules/_runtime_svelte_gsap_plugin.html @@ -1,4 +1,5 @@ -#runtime/svelte/gsap/plugin | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                  Package #runtime/svelte/gsap/plugin

                                                                                                                                  Documentation: https://greensock.com/docs/v3/Plugins

                                                                                                                                  +#runtime/svelte/gsap/plugin | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                  +

                                                                                                                                    Package #runtime/svelte/gsap/plugin

                                                                                                                                    Documentation: https://greensock.com/docs/v3/Plugins

                                                                                                                                    TRL provides all the GSAP plugins available and makes it easy to install them via simply using a side effect import. The plugin will be automatically loaded and enabled in GSAP without any additional hook up concerns.

                                                                                                                                    The following plugins are available from this sub-path export:

                                                                                                                                    @@ -16,6 +17,7 @@
                                                                                                                                  • ScrollTrigger
                                                                                                                                  • TextPlugin
                                                                                                                                    • -

                                                                                                                                    Example

                                                                                                                                    // To load a plugin simply import the plugin and it will be available from `gsap` and `GsapCompose`.
                                                                                                                                    import '#runtime/svelte/gsap/plugin/CustomEase';
                                                                                                                                    import '#runtime/svelte/gsap/plugin/MotionPathPlugin';
-
                                                                                                                                    -

                                                                                                                                    Settings

                                                                                                                                    Member Visibility

                                                                                                                                    Theme

                                                                                                                                    \ No newline at end of file +

                                                                                                                                    Example

                                                                                                                                    // To load a plugin simply import the plugin and it will be available from `gsap` and `GsapCompose`.
                                                                                                                                    import '#runtime/svelte/gsap/plugin/CustomEase';
                                                                                                                                    import '#runtime/svelte/gsap/plugin/MotionPathPlugin';
+
                                                                                                                                    + +

                                                                                                                                    Settings

                                                                                                                                    Member Visibility
                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_gsap_plugin_bonus.html b/docs/modules/_runtime_svelte_gsap_plugin_bonus.html index b73b6506..aec08522 100644 --- a/docs/modules/_runtime_svelte_gsap_plugin_bonus.html +++ b/docs/modules/_runtime_svelte_gsap_plugin_bonus.html @@ -1,4 +1,5 @@ -#runtime/svelte/gsap/plugin/bonus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                      Package #runtime/svelte/gsap/plugin/bonus

                                                                                                                                      Documentation: https://greensock.com/docs/v3/Plugins

                                                                                                                                      +#runtime/svelte/gsap/plugin/bonus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                      +

                                                                                                                                        Package #runtime/svelte/gsap/plugin/bonus

                                                                                                                                        Documentation: https://greensock.com/docs/v3/Plugins

                                                                                                                                        The Foundry version of TRL provides all the GSAP bonus plugins available and makes it easy to install them via simply using a side effect import. The plugin will be automatically loaded and enabled in GSAP without any additional hook up concerns.

                                                                                                                                        @@ -17,6 +18,7 @@
                                                                                                                                      • ScrollSmoother
                                                                                                                                      • SplitText
                                                                                                                                        • -

                                                                                                                                        Example

                                                                                                                                        // To load a plugin simply import the plugin and it will be available from `gsap` and `GsapCompose`.
                                                                                                                                        import '#runtime/svelte/gsap/plugin/bonus/CustomWiggle';
-
                                                                                                                                        -

                                                                                                                                        Settings

                                                                                                                                        Member Visibility

                                                                                                                                        Theme

                                                                                                                                        \ No newline at end of file +

                                                                                                                                        Example

                                                                                                                                        // To load a plugin simply import the plugin and it will be available from `gsap` and `GsapCompose`.
                                                                                                                                        import '#runtime/svelte/gsap/plugin/bonus/CustomWiggle';
+
                                                                                                                                        + +

                                                                                                                                        Settings

                                                                                                                                        Member Visibility
                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_helper.html b/docs/modules/_runtime_svelte_helper.html index 67f741a3..071c53f7 100644 --- a/docs/modules/_runtime_svelte_helper.html +++ b/docs/modules/_runtime_svelte_helper.html @@ -1,4 +1,5 @@ -#runtime/svelte/helper | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                          Package #runtime/svelte/helper

                                                                                                                                          +#runtime/svelte/helper | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                          +

                                                                                                                                            Package #runtime/svelte/helper

                                                                                                                                            Index @@ -9,4 +10,4 @@

                                                                                                                                            radioBoxes selectOptions

                                                                                                                                            -

                                                                                                                                            Settings

                                                                                                                                            Member Visibility

                                                                                                                                            Theme

                                                                                                                                            \ No newline at end of file +

                                                                                                                                            Settings

                                                                                                                                            Member Visibility
                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_dom.html b/docs/modules/_runtime_svelte_store_dom.html index 1664125f..ebf0f62a 100644 --- a/docs/modules/_runtime_svelte_store_dom.html +++ b/docs/modules/_runtime_svelte_store_dom.html @@ -1,4 +1,5 @@ -#runtime/svelte/store/dom | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                              Package #runtime/svelte/store/dom

                                                                                                                                              +#runtime/svelte/store/dom | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                              +

                                                                                                                                                Package #runtime/svelte/store/dom

                                                                                                                                                Index @@ -9,4 +10,4 @@

                                                                                                                                                Functions

                                                                                                                                                keyforward

                                                                                                                                                Type Aliases

                                                                                                                                                KeyStoreOptions
                                                                                                                                                -

                                                                                                                                                Settings

                                                                                                                                                Member Visibility

                                                                                                                                                Theme

                                                                                                                                                \ No newline at end of file +

                                                                                                                                                Settings

                                                                                                                                                Member Visibility
                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_fvtt.html b/docs/modules/_runtime_svelte_store_fvtt.html index 9ee472a2..83368606 100644 --- a/docs/modules/_runtime_svelte_store_fvtt.html +++ b/docs/modules/_runtime_svelte_store_fvtt.html @@ -1,4 +1,5 @@ -#runtime/svelte/store/fvtt | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                  Package #runtime/svelte/store/fvtt

                                                                                                                                                  +#runtime/svelte/store/fvtt | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                  +

                                                                                                                                                    Package #runtime/svelte/store/fvtt

                                                                                                                                                    Index @@ -7,4 +8,4 @@

                                                                                                                                                    Variables

                                                                                                                                                    gameState
                                                                                                                                                    -

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility

                                                                                                                                                    Theme

                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                    Settings

                                                                                                                                                    Member Visibility
                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_fvtt_document.html b/docs/modules/_runtime_svelte_store_fvtt_document.html index 4922dfb7..86292711 100644 --- a/docs/modules/_runtime_svelte_store_fvtt_document.html +++ b/docs/modules/_runtime_svelte_store_fvtt_document.html @@ -1,4 +1,5 @@ -#runtime/svelte/store/fvtt/document | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                      Package #runtime/svelte/store/fvtt/document

                                                                                                                                                      +#runtime/svelte/store/fvtt/document | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                      +

                                                                                                                                                        Package #runtime/svelte/store/fvtt/document

                                                                                                                                                        Index @@ -14,4 +15,4 @@

                                                                                                                                                        TJSDocumentOptions TJSDocumentUpdateOptions

                                                                                                                                                        -

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility

                                                                                                                                                        Theme

                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility
                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_fvtt_settings.html b/docs/modules/_runtime_svelte_store_fvtt_settings.html index a4742bb3..86854d2d 100644 --- a/docs/modules/_runtime_svelte_store_fvtt_settings.html +++ b/docs/modules/_runtime_svelte_store_fvtt_settings.html @@ -1,4 +1,5 @@ -#runtime/svelte/store/fvtt/settings | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                          Package #runtime/svelte/store/fvtt/settings

                                                                                                                                                          +#runtime/svelte/store/fvtt/settings | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                          +

                                                                                                                                                            Package #runtime/svelte/store/fvtt/settings

                                                                                                                                                            Index @@ -16,4 +17,4 @@

                                                                                                                                                            TJSSettingsCustomSectionFolder TJSSettingsUIData

                                                                                                                                                            -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.Action.html b/docs/modules/_runtime_svelte_store_position.Action.html index fdb255e7..d866a43e 100644 --- a/docs/modules/_runtime_svelte_store_position.Action.html +++ b/docs/modules/_runtime_svelte_store_position.Action.html @@ -1,3 +1,12 @@ -Action | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace Action

                                                                                                                                                            Index

                                                                                                                                                            Interfaces

                                                                                                                                                            DraggableOptionsStore +Action | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                            +

                                                                                                                                                            Namespace Action

                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Interfaces

                                                                                                                                                            DraggableOptionsStore

                                                                                                                                                            Type Aliases

                                                                                                                                                            DraggableOptions -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.AnimationAPI-1.html b/docs/modules/_runtime_svelte_store_position.AnimationAPI-1.html index 27cf3d44..8a178303 100644 --- a/docs/modules/_runtime_svelte_store_position.AnimationAPI-1.html +++ b/docs/modules/_runtime_svelte_store_position.AnimationAPI-1.html @@ -1,4 +1,12 @@ -AnimationAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace AnimationAPI

                                                                                                                                                            Index

                                                                                                                                                            Interfaces

                                                                                                                                                            GroupDataCallback +AnimationAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                            +

                                                                                                                                                            Namespace AnimationAPI

                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Interfaces

                                                                                                                                                            GroupDataCallback GroupQuickToCallback GroupQuickTweenOptionsCallback GroupTweenOptionsCallback @@ -8,4 +16,5 @@ QuickTweenOptions ScheduleOptions TweenOptions -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.Data.html b/docs/modules/_runtime_svelte_store_position.Data.html index 6309fa5d..5f0667ae 100644 --- a/docs/modules/_runtime_svelte_store_position.Data.html +++ b/docs/modules/_runtime_svelte_store_position.Data.html @@ -1,6 +1,15 @@ -Data | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace Data

                                                                                                                                                            Defines the data objects / interfaces used by various TJSPosition APIs.

                                                                                                                                                            -

                                                                                                                                                            Index

                                                                                                                                                            Interfaces

                                                                                                                                                            TJSPositionData +Data | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                            +

                                                                                                                                                            Namespace Data

                                                                                                                                                            Defines the data objects / interfaces used by various TJSPosition APIs.

                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Interfaces

                                                                                                                                                            TJSPositionData TJSPositionDataConstructor TJSPositionDataExtra

                                                                                                                                                            Type Aliases

                                                                                                                                                            TJSPositionDataRelative -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.System.Initial.html b/docs/modules/_runtime_svelte_store_position.System.Initial.html index bec64071..5f3c063d 100644 --- a/docs/modules/_runtime_svelte_store_position.System.Initial.html +++ b/docs/modules/_runtime_svelte_store_position.System.Initial.html @@ -1,7 +1,16 @@ -Initial | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace Initial

                                                                                                                                                            Defines the initial position extension point for positioning elements. The default implementation for initial +Initial | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            +

                                                                                                                                                            Namespace Initial

                                                                                                                                                            Defines the initial position extension point for positioning elements. The default implementation for initial Centered positioning is available via TJSPosition.Initial. To

                                                                                                                                                            To create a unique initial position system extend TJSPosition.SystemBase and implement the InitialSystem interface.

                                                                                                                                                            -

                                                                                                                                                            Index

                                                                                                                                                            Interfaces

                                                                                                                                                            InitialSystem +
                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Interfaces

                                                                                                                                                            InitialSystem InitialSystemConstructor -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.System.Validator.html b/docs/modules/_runtime_svelte_store_position.System.Validator.html index de226c37..5a9a6f24 100644 --- a/docs/modules/_runtime_svelte_store_position.System.Validator.html +++ b/docs/modules/_runtime_svelte_store_position.System.Validator.html @@ -1,7 +1,16 @@ -Validator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace Validator

                                                                                                                                                            Defines the position validator extension point for constraining positional changes. The browser window / element +Validator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            +

                                                                                                                                                            Namespace Validator

                                                                                                                                                            Defines the position validator extension point for constraining positional changes. The browser window / element bounds validation with and without transform support is available via TJSPosition.Validators.

                                                                                                                                                            To create a unique validator extend TJSPosition.SystemBase and implement the ValidatorSystem interface.

                                                                                                                                                            -

                                                                                                                                                            Index

                                                                                                                                                            Interfaces

                                                                                                                                                            ValidatorSystem +
                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Interfaces

                                                                                                                                                            ValidatorSystem ValidatorSystemConstructor -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.System.html b/docs/modules/_runtime_svelte_store_position.System.html index 8ffdc09e..efe596ff 100644 --- a/docs/modules/_runtime_svelte_store_position.System.html +++ b/docs/modules/_runtime_svelte_store_position.System.html @@ -1,9 +1,18 @@ -System | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace System

                                                                                                                                                            Defines the extension points that are available to provide custom implementations for initial positioning and +System | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            +

                                                                                                                                                            Namespace System

                                                                                                                                                            Defines the extension points that are available to provide custom implementations for initial positioning and validation of positional movement. There are default implementations for initial Centered positioning available via TJSPosition.Initial and browser window / element bounds validation with and without transform support available via TJSPosition.Validators.

                                                                                                                                                            -

                                                                                                                                                            Index

                                                                                                                                                            Namespaces

                                                                                                                                                            Initial +
                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Namespaces

                                                                                                                                                            Initial Validator

                                                                                                                                                            Interfaces

                                                                                                                                                            SystemBase SystemBaseConstructor -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.TJSPositionTypes.html b/docs/modules/_runtime_svelte_store_position.TJSPositionTypes.html index f6241afc..07495201 100644 --- a/docs/modules/_runtime_svelte_store_position.TJSPositionTypes.html +++ b/docs/modules/_runtime_svelte_store_position.TJSPositionTypes.html @@ -1,5 +1,13 @@ -TJSPositionTypes | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace TJSPositionTypes

                                                                                                                                                            Provides all interfaces and type aliases used by TJSPosition.

                                                                                                                                                            -

                                                                                                                                                            Index

                                                                                                                                                            Interfaces

                                                                                                                                                            Positionable +TJSPositionTypes | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                            +

                                                                                                                                                            Namespace TJSPositionTypes

                                                                                                                                                            Provides all interfaces and type aliases used by TJSPosition.

                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Interfaces

                                                                                                                                                            Positionable TJSPositionWritable

                                                                                                                                                            Type Aliases

                                                                                                                                                            OptionsCtor OptionsCtorAll @@ -10,4 +18,5 @@ PositionParent PositionValidators Stores -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.TransformAPI-1.html b/docs/modules/_runtime_svelte_store_position.TransformAPI-1.html index c3cb87ed..1c3dd646 100644 --- a/docs/modules/_runtime_svelte_store_position.TransformAPI-1.html +++ b/docs/modules/_runtime_svelte_store_position.TransformAPI-1.html @@ -1,6 +1,15 @@ -TransformAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace TransformAPI

                                                                                                                                                            Provides additional interfaces and type aliases for the transform API.

                                                                                                                                                            -

                                                                                                                                                            Index

                                                                                                                                                            Interfaces

                                                                                                                                                            TransformData +TransformAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                            +

                                                                                                                                                            Namespace TransformAPI

                                                                                                                                                            Provides additional interfaces and type aliases for the transform API.

                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Interfaces

                                                                                                                                                            TransformData TransformDataConstructor TransformOriginWritable

                                                                                                                                                            Type Aliases

                                                                                                                                                            TransformOrigin -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.ValidatorAPI-1.html b/docs/modules/_runtime_svelte_store_position.ValidatorAPI-1.html index 9d37f1fe..d893a0e0 100644 --- a/docs/modules/_runtime_svelte_store_position.ValidatorAPI-1.html +++ b/docs/modules/_runtime_svelte_store_position.ValidatorAPI-1.html @@ -1,7 +1,16 @@ -ValidatorAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace ValidatorAPI

                                                                                                                                                            Provides a namespace for all type aliases related to the validator API.

                                                                                                                                                            -

                                                                                                                                                            Index

                                                                                                                                                            Interfaces

                                                                                                                                                            ValidatorFn +ValidatorAPI | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                            +

                                                                                                                                                            Namespace ValidatorAPI

                                                                                                                                                            Provides a namespace for all type aliases related to the validator API.

                                                                                                                                                            +
                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Interfaces

                                                                                                                                                            ValidatorFn

                                                                                                                                                            Type Aliases

                                                                                                                                                            RemoveByCallback ValidationData ValidatorData ValidatorOption -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.draggable-1.html b/docs/modules/_runtime_svelte_store_position.draggable-1.html index bf3f1be7..6327304b 100644 --- a/docs/modules/_runtime_svelte_store_position.draggable-1.html +++ b/docs/modules/_runtime_svelte_store_position.draggable-1.html @@ -1,2 +1,11 @@ -draggable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                            Namespace draggable

                                                                                                                                                            Index

                                                                                                                                                            Functions

                                                                                                                                                            options -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility

                                                                                                                                                            Theme

                                                                                                                                                            \ No newline at end of file +draggable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                            +

                                                                                                                                                            Namespace draggable

                                                                                                                                                            + +

                                                                                                                                                            + Index +

                                                                                                                                                            +                                                                                                                                                             +
                                                                                                                                                            +

                                                                                                                                                            Functions

                                                                                                                                                            options +
                                                                                                                                                            +

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_position.html b/docs/modules/_runtime_svelte_store_position.html index a8ccfed0..9e840f14 100644 --- a/docs/modules/_runtime_svelte_store_position.html +++ b/docs/modules/_runtime_svelte_store_position.html @@ -1,8 +1,9 @@ -#runtime/svelte/store/position | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                              Package #runtime/svelte/store/position

                                                                                                                                                              Provides a reactive compound store and related actions for advanced and optimized positioning of elements including +#runtime/svelte/store/position | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                              +

                                                                                                                                                                Package #runtime/svelte/store/position

                                                                                                                                                                Provides a reactive compound store and related actions for advanced and optimized positioning of elements including essential animation / tweening and validation of positional changes. TJSPosition is the main reactive store along with the applyPosition and draggable actions to respectively attach a TJSPosition instance to an element in a Svelte template and make it draggable.

                                                                                                                                                                -
                                                                                                                                                                +

                                                                                                                                                                Index @@ -15,15 +16,15 @@

                                                                                                                                                                Namespaces

                                                                                                                                                                Action AnimationAPI Data +draggable System TJSPositionTypes TransformAPI ValidatorAPI -draggable

                                                                                                                                                                Interfaces

                                                                                                                                                                AnimationAPI AnimationGroupAPI PositionStateAPI TransformAPI ValidatorAPI
                                                                                                                                                                -

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                Theme

                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility
                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_reducer.html b/docs/modules/_runtime_svelte_store_reducer.html index 90f33fff..598beeff 100644 --- a/docs/modules/_runtime_svelte_store_reducer.html +++ b/docs/modules/_runtime_svelte_store_reducer.html @@ -1,4 +1,5 @@ -#runtime/svelte/store/reducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                  Package #runtime/svelte/store/reducer

                                                                                                                                                                  +#runtime/svelte/store/reducer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                  +

                                                                                                                                                                    Package #runtime/svelte/store/reducer

                                                                                                                                                                    Index @@ -34,4 +35,4 @@

                                                                                                                                                                    DynOptionsDerivedCreate DynOptionsMapCreate

                                                                                                                                                                    -

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility

                                                                                                                                                                    Theme

                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    Settings

                                                                                                                                                                    Member Visibility
                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_reducer_array_object.html b/docs/modules/_runtime_svelte_store_reducer_array_object.html index 30be4fec..d6093b1e 100644 --- a/docs/modules/_runtime_svelte_store_reducer_array_object.html +++ b/docs/modules/_runtime_svelte_store_reducer_array_object.html @@ -1,4 +1,5 @@ -#runtime/svelte/store/reducer/array-object | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                      Package #runtime/svelte/store/reducer/array-object

                                                                                                                                                                      +#runtime/svelte/store/reducer/array-object | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                      +

                                                                                                                                                                        Package #runtime/svelte/store/reducer/array-object

                                                                                                                                                                        Index @@ -15,4 +16,4 @@

                                                                                                                                                                        CrudArrayObjectStoreParams CrudDispatch

                                                                                                                                                                        -

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility

                                                                                                                                                                        Theme

                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility
                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_web_storage.html b/docs/modules/_runtime_svelte_store_web_storage.html index a7ab92c6..1555ef59 100644 --- a/docs/modules/_runtime_svelte_store_web_storage.html +++ b/docs/modules/_runtime_svelte_store_web_storage.html @@ -1,4 +1,5 @@ -#runtime/svelte/store/web-storage | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                          Package #runtime/svelte/store/web-storage

                                                                                                                                                                          +#runtime/svelte/store/web-storage | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                          +

                                                                                                                                                                            Package #runtime/svelte/store/web-storage

                                                                                                                                                                            Index @@ -16,4 +17,4 @@

                                                                                                                                                                            StorageStores StorageWritable

                                                                                                                                                                            -

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility

                                                                                                                                                                            Theme

                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility
                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_web_storage_msgpack.html b/docs/modules/_runtime_svelte_store_web_storage_msgpack.html index fb23d4ec..eea33f59 100644 --- a/docs/modules/_runtime_svelte_store_web_storage_msgpack.html +++ b/docs/modules/_runtime_svelte_store_web_storage_msgpack.html @@ -1,4 +1,5 @@ -#runtime/svelte/store/web-storage/msgpack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                              Package #runtime/svelte/store/web-storage/msgpack

                                                                                                                                                                              +#runtime/svelte/store/web-storage/msgpack | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                              +

                                                                                                                                                                                Package #runtime/svelte/store/web-storage/msgpack

                                                                                                                                                                                Index @@ -10,4 +11,4 @@

                                                                                                                                                                                Variables

                                                                                                                                                                                localStoresBCMP sessionStoresBCMP
                                                                                                                                                                                -

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility

                                                                                                                                                                                Theme

                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility
                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_writable_derived.html b/docs/modules/_runtime_svelte_store_writable_derived.html index 330b4d4a..c40110d0 100644 --- a/docs/modules/_runtime_svelte_store_writable_derived.html +++ b/docs/modules/_runtime_svelte_store_writable_derived.html @@ -1,4 +1,5 @@ -#runtime/svelte/store/writable-derived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                  Package #runtime/svelte/store/writable-derived

                                                                                                                                                                                  +#runtime/svelte/store/writable-derived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                  +

                                                                                                                                                                                    Package #runtime/svelte/store/writable-derived

                                                                                                                                                                                    Index @@ -12,4 +13,4 @@

                                                                                                                                                                                    Stores StoresValues

                                                                                                                                                                                    -

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                    Theme

                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_transition.html b/docs/modules/_runtime_svelte_transition.html index b0fb5734..9409b14e 100644 --- a/docs/modules/_runtime_svelte_transition.html +++ b/docs/modules/_runtime_svelte_transition.html @@ -1,4 +1,5 @@ -#runtime/svelte/transition | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                      Package #runtime/svelte/transition

                                                                                                                                                                                      +#runtime/svelte/transition | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                      +

                                                                                                                                                                                        Package #runtime/svelte/transition

                                                                                                                                                                                        Index @@ -11,4 +12,4 @@

                                                                                                                                                                                        toAnimation

                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                        TransitionFunction
                                                                                                                                                                                        -

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                        Theme

                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_util.html b/docs/modules/_runtime_svelte_util.html index edf3534f..40011fb5 100644 --- a/docs/modules/_runtime_svelte_util.html +++ b/docs/modules/_runtime_svelte_util.html @@ -1,4 +1,5 @@ -#runtime/svelte/util | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                          Package #runtime/svelte/util

                                                                                                                                                                                          +#runtime/svelte/util | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                          +

                                                                                                                                                                                            Package #runtime/svelte/util

                                                                                                                                                                                            Index @@ -9,4 +10,4 @@

                                                                                                                                                                                            TJSSvelteUtil

                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                            TJSSvelteConfig
                                                                                                                                                                                            -

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                            Theme

                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_tinymce.html b/docs/modules/_runtime_tinymce.html index ee8fae33..51245879 100644 --- a/docs/modules/_runtime_tinymce.html +++ b/docs/modules/_runtime_tinymce.html @@ -1,8 +1,9 @@ -#runtime/tinymce | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                              Package #runtime/tinymce

                                                                                                                                                                                              This subpath export loads the TyphonJS oEmbed plugin for TinyMCE allowing video embeds from YouTube and Vimeo.

                                                                                                                                                                                              +#runtime/tinymce | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                              +

                                                                                                                                                                                                Package #runtime/tinymce

                                                                                                                                                                                                This subpath export loads the TyphonJS oEmbed plugin for TinyMCE allowing video embeds from YouTube and Vimeo.

                                                                                                                                                                                                The oEmbed plugin is automatically added to the mceConfig field when you use the TJSTinyMCE Svelte component and select the standard or TJS variants.

                                                                                                                                                                                                You must use import '#runtime/tinymce'; in your main index.js / entry point.

                                                                                                                                                                                                Note: On Foundry VTT there is server side sanitation and video embeds will be stripped. You must store any editor data in flags.

                                                                                                                                                                                                Please see the TJSTinyMCE Svelte component for more information.

                                                                                                                                                                                                -

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                Theme

                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_util.ResizeObserverData.html b/docs/modules/_runtime_util.ResizeObserverData.html deleted file mode 100644 index 6d937a4e..00000000 --- a/docs/modules/_runtime_util.ResizeObserverData.html +++ /dev/null @@ -1,6 +0,0 @@ -ResizeObserverData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                Namespace ResizeObserverData

                                                                                                                                                                                                Provides various type aliases used by ResizeObserverManager.

                                                                                                                                                                                                -

                                                                                                                                                                                                Index

                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                ResizeFunction -ResizeObject -ResizeObjectExtended -ResizeTarget -

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                Theme

                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_util.html b/docs/modules/_runtime_util.html index bced97f3..92c0bf47 100644 --- a/docs/modules/_runtime_util.html +++ b/docs/modules/_runtime_util.html @@ -1,4 +1,5 @@ -#runtime/util | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                  Package #runtime/util

                                                                                                                                                                                                  +#runtime/util | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                  +

                                                                                                                                                                                                    Package #runtime/util

                                                                                                                                                                                                    Index @@ -8,8 +9,5 @@

                                                                                                                                                                                                    Classes

                                                                                                                                                                                                    Hashing Strings Timing -

                                                                                                                                                                                                    Namespaces

                                                                                                                                                                                                    ResizeObserverData -

                                                                                                                                                                                                    Interfaces

                                                                                                                                                                                                    BasicAnimation -

                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                    BasicAnimationState

                                                                                                                                                                                                    -

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                    Theme

                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                    Settings

                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_util_animate.html b/docs/modules/_runtime_util_animate.html index 0efcb2db..cea95ebd 100644 --- a/docs/modules/_runtime_util_animate.html +++ b/docs/modules/_runtime_util_animate.html @@ -1,4 +1,5 @@ -#runtime/util/animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                      Package #runtime/util/animate

                                                                                                                                                                                                      +#runtime/util/animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                      +

                                                                                                                                                                                                        Package #runtime/util/animate

                                                                                                                                                                                                        Index @@ -9,4 +10,4 @@

                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                        BasicAnimation

                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                        BasicAnimationState
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                        Theme

                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_util_async.html b/docs/modules/_runtime_util_async.html index f4d392e5..89ac14c8 100644 --- a/docs/modules/_runtime_util_async.html +++ b/docs/modules/_runtime_util_async.html @@ -1,4 +1,5 @@ -#runtime/util/async | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                          Package #runtime/util/async

                                                                                                                                                                                                          +#runtime/util/async | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                          +

                                                                                                                                                                                                            Package #runtime/util/async

                                                                                                                                                                                                            Index @@ -7,4 +8,4 @@

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            ManagedPromise
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_util_browser.ResizeObserverData.html b/docs/modules/_runtime_util_browser.ResizeObserverData.html index 3b47249b..ff2490cd 100644 --- a/docs/modules/_runtime_util_browser.ResizeObserverData.html +++ b/docs/modules/_runtime_util_browser.ResizeObserverData.html @@ -1,6 +1,15 @@ -ResizeObserverData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                            Namespace ResizeObserverData

                                                                                                                                                                                                            Provides various type aliases used by ResizeObserverManager.

                                                                                                                                                                                                            -

                                                                                                                                                                                                            Index

                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                            ResizeFunction +ResizeObserverData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Namespace ResizeObserverData

                                                                                                                                                                                                            Provides various type aliases used by ResizeObserverManager.

                                                                                                                                                                                                            +
                                                                                                                                                                                                            + +

                                                                                                                                                                                                            + Index +

                                                                                                                                                                                                            +                                                                                                                                                                                                             +
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                            ResizeFunction ResizeObject ResizeObjectExtended ResizeTarget -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                            Theme

                                                                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                                                                            +

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_util_browser.html b/docs/modules/_runtime_util_browser.html index 4b22328e..5bfa4daa 100644 --- a/docs/modules/_runtime_util_browser.html +++ b/docs/modules/_runtime_util_browser.html @@ -1,4 +1,5 @@ -#runtime/util/browser | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                              Package #runtime/util/browser

                                                                                                                                                                                                              +#runtime/util/browser | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                              +

                                                                                                                                                                                                                Package #runtime/util/browser

                                                                                                                                                                                                                Index @@ -19,4 +20,4 @@

                                                                                                                                                                                                                FocusableElement StackingContext

                                                                                                                                                                                                                -

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_runtime_util_loader_module.html b/docs/modules/_runtime_util_loader_module.html index ba75ccd0..11a3afda 100644 --- a/docs/modules/_runtime_util_loader_module.html +++ b/docs/modules/_runtime_util_loader_module.html @@ -1,12 +1,13 @@ -#runtime/util/loader-module | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                  Package #runtime/util/loader-module

                                                                                                                                                                                                                  +#runtime/util/loader-module | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                  +

                                                                                                                                                                                                                    Package #runtime/util/loader-module

                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                    ModuleLoadError -ModuleLoader +

                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                    ModuleLoader +ModuleLoadError

                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                    ModuleLoaderObj
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_runtime_util_object.html b/docs/modules/_runtime_util_object.html index 9292a7c3..f5aeff41 100644 --- a/docs/modules/_runtime_util_object.html +++ b/docs/modules/_runtime_util_object.html @@ -1,4 +1,5 @@ -#runtime/util/object | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                      Package #runtime/util/object

                                                                                                                                                                                                                      +#runtime/util/object | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                      +

                                                                                                                                                                                                                        Package #runtime/util/object

                                                                                                                                                                                                                        Index @@ -36,4 +37,4 @@

                                                                                                                                                                                                                        SafeSetOperation ValidationEntry

                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_util_store.html b/docs/modules/_runtime_util_store.html index 79a469ce..39c42c83 100644 --- a/docs/modules/_runtime_util_store.html +++ b/docs/modules/_runtime_util_store.html @@ -1,4 +1,5 @@ -#runtime/util/store | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                          Package #runtime/util/store

                                                                                                                                                                                                                          +#runtime/util/store | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                          +

                                                                                                                                                                                                                            Package #runtime/util/store

                                                                                                                                                                                                                            Index @@ -12,4 +13,4 @@

                                                                                                                                                                                                                            subscribeFirstRest subscribeIgnoreFirst

                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_standard_application.html b/docs/modules/_standard_application.html index d8b35eaa..792bf44b 100644 --- a/docs/modules/_standard_application.html +++ b/docs/modules/_standard_application.html @@ -1,4 +1,5 @@ -#standard/application | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                              Package #standard/application

                                                                                                                                                                                                                              +#standard/application | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                Package #standard/application

                                                                                                                                                                                                                                Index @@ -15,4 +16,4 @@

                                                                                                                                                                                                                                FVTTSidebarReplaceData TJSContextMenuItemData

                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_standard_application_dialog_document.html b/docs/modules/_standard_application_dialog_document.html index 16194426..ac5cc7cc 100644 --- a/docs/modules/_standard_application_dialog_document.html +++ b/docs/modules/_standard_application_dialog_document.html @@ -1,4 +1,5 @@ -#standard/application/dialog/document | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                  Package #standard/application/dialog/document

                                                                                                                                                                                                                                  +#standard/application/dialog/document | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                    Package #standard/application/dialog/document

                                                                                                                                                                                                                                    Index @@ -16,4 +17,4 @@

                                                                                                                                                                                                                                    TJSFolderRemove TJSFolderRolltable

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSButton-1.html b/docs/modules/_standard_component.TJSButton-1.html index d454421f..784d0d31 100644 --- a/docs/modules/_standard_component.TJSButton-1.html +++ b/docs/modules/_standard_component.TJSButton-1.html @@ -1,5 +1,14 @@ -TJSButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSColordButton-1.html b/docs/modules/_standard_component.TJSColordButton-1.html index d93feebe..a7488667 100644 --- a/docs/modules/_standard_component.TJSColordButton-1.html +++ b/docs/modules/_standard_component.TJSColordButton-1.html @@ -1,5 +1,14 @@ -TJSColordButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSColordButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSColordButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSColordButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSColordPicker-1.html b/docs/modules/_standard_component.TJSColordPicker-1.html index e3c359a7..24b05b12 100644 --- a/docs/modules/_standard_component.TJSColordPicker-1.html +++ b/docs/modules/_standard_component.TJSColordPicker-1.html @@ -1,5 +1,14 @@ -TJSColordPicker | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSColordPicker

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSColordPicker | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSColordPicker

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSContentEdit-1.html b/docs/modules/_standard_component.TJSContentEdit-1.html index 1dde301d..2b5485bf 100644 --- a/docs/modules/_standard_component.TJSContentEdit-1.html +++ b/docs/modules/_standard_component.TJSContentEdit-1.html @@ -1,5 +1,14 @@ -TJSContentEdit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSContentEdit

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSContentEdit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSContentEdit

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSIconButton-1.html b/docs/modules/_standard_component.TJSIconButton-1.html index e0e01abe..61b8915e 100644 --- a/docs/modules/_standard_component.TJSIconButton-1.html +++ b/docs/modules/_standard_component.TJSIconButton-1.html @@ -1,5 +1,14 @@ -TJSIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSIconButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSIconButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSIconFolder-1.html b/docs/modules/_standard_component.TJSIconFolder-1.html index 78574121..611b1b8e 100644 --- a/docs/modules/_standard_component.TJSIconFolder-1.html +++ b/docs/modules/_standard_component.TJSIconFolder-1.html @@ -1,5 +1,14 @@ -TJSIconFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSIconFolder

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSIconFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSIconFolder

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSInput-1.html b/docs/modules/_standard_component.TJSInput-1.html index 39341d68..689e6671 100644 --- a/docs/modules/_standard_component.TJSInput-1.html +++ b/docs/modules/_standard_component.TJSInput-1.html @@ -1,5 +1,14 @@ -TJSInput | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSInput

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSInput | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSInput

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSInputCheckbox-1.html b/docs/modules/_standard_component.TJSInputCheckbox-1.html index 14cfb1d2..4f69c0be 100644 --- a/docs/modules/_standard_component.TJSInputCheckbox-1.html +++ b/docs/modules/_standard_component.TJSInputCheckbox-1.html @@ -1,5 +1,14 @@ -TJSInputCheckbox | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSInputCheckbox

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSInputCheckbox | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSInputCheckbox

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSInputNumber-1.html b/docs/modules/_standard_component.TJSInputNumber-1.html index d1165856..f3f94276 100644 --- a/docs/modules/_standard_component.TJSInputNumber-1.html +++ b/docs/modules/_standard_component.TJSInputNumber-1.html @@ -1,5 +1,14 @@ -TJSInputNumber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSInputNumber

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSInputNumber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSInputNumber

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSInputText-1.html b/docs/modules/_standard_component.TJSInputText-1.html index 117013cf..fb2a58fc 100644 --- a/docs/modules/_standard_component.TJSInputText-1.html +++ b/docs/modules/_standard_component.TJSInputText-1.html @@ -1,5 +1,14 @@ -TJSInputText | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSInputText

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSInputText | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSInputText

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSMenu-1.html b/docs/modules/_standard_component.TJSMenu-1.html index ab0f1164..7597f4eb 100644 --- a/docs/modules/_standard_component.TJSMenu-1.html +++ b/docs/modules/_standard_component.TJSMenu-1.html @@ -1,5 +1,14 @@ -TJSMenu | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSMenu

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSMenu | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSMenu

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSPositionControlLayer-1.html b/docs/modules/_standard_component.TJSPositionControlLayer-1.html index 33c544e5..ff9388c4 100644 --- a/docs/modules/_standard_component.TJSPositionControlLayer-1.html +++ b/docs/modules/_standard_component.TJSPositionControlLayer-1.html @@ -1,5 +1,14 @@ -TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSPositionControlLayer

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSPositionControlLayer

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSProseMirror-1.html b/docs/modules/_standard_component.TJSProseMirror-1.html index a0e16034..11f9fc5c 100644 --- a/docs/modules/_standard_component.TJSProseMirror-1.html +++ b/docs/modules/_standard_component.TJSProseMirror-1.html @@ -1,5 +1,14 @@ -TJSProseMirror | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSProseMirror

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSProseMirror | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSProseMirror

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSScrollContainer-1.html b/docs/modules/_standard_component.TJSScrollContainer-1.html index de86bbf0..838f0ae2 100644 --- a/docs/modules/_standard_component.TJSScrollContainer-1.html +++ b/docs/modules/_standard_component.TJSScrollContainer-1.html @@ -1,5 +1,14 @@ -TJSScrollContainer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSScrollContainer

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSScrollContainer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSScrollContainer

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSSelect-1.html b/docs/modules/_standard_component.TJSSelect-1.html index 1fb0e5ab..7c7435d2 100644 --- a/docs/modules/_standard_component.TJSSelect-1.html +++ b/docs/modules/_standard_component.TJSSelect-1.html @@ -1,5 +1,14 @@ -TJSSelect | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSSelect

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSSelect | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSSelect

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSSettingsEdit-1.html b/docs/modules/_standard_component.TJSSettingsEdit-1.html index ce7739e6..6d93d7b3 100644 --- a/docs/modules/_standard_component.TJSSettingsEdit-1.html +++ b/docs/modules/_standard_component.TJSSettingsEdit-1.html @@ -1,5 +1,14 @@ -TJSSettingsEdit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSSettingsEdit

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSSettingsEdit | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSSettingsEdit

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSSettingsSwap-1.html b/docs/modules/_standard_component.TJSSettingsSwap-1.html index 2789d7b2..3699fefe 100644 --- a/docs/modules/_standard_component.TJSSettingsSwap-1.html +++ b/docs/modules/_standard_component.TJSSettingsSwap-1.html @@ -1,5 +1,14 @@ -TJSSettingsSwap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSSettingsSwap

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSSettingsSwap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSSettingsSwap

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSSideSlideLayer-1.html b/docs/modules/_standard_component.TJSSideSlideLayer-1.html index 3552d79c..721e43ce 100644 --- a/docs/modules/_standard_component.TJSSideSlideLayer-1.html +++ b/docs/modules/_standard_component.TJSSideSlideLayer-1.html @@ -1,5 +1,14 @@ -TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSSideSlideLayer

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSSideSlideLayer

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSSlotButton-1.html b/docs/modules/_standard_component.TJSSlotButton-1.html index d9651f72..52095a30 100644 --- a/docs/modules/_standard_component.TJSSlotButton-1.html +++ b/docs/modules/_standard_component.TJSSlotButton-1.html @@ -1,5 +1,14 @@ -TJSSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSSlotButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSSlotButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSSlotLabel-1.html b/docs/modules/_standard_component.TJSSlotLabel-1.html index 12be33f5..2e581bfb 100644 --- a/docs/modules/_standard_component.TJSSlotLabel-1.html +++ b/docs/modules/_standard_component.TJSSlotLabel-1.html @@ -1,5 +1,14 @@ -TJSSlotLabel | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSSlotLabel

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSSlotLabel | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSSlotLabel

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSSvgFolder-1.html b/docs/modules/_standard_component.TJSSvgFolder-1.html index a2984c45..7142f3c8 100644 --- a/docs/modules/_standard_component.TJSSvgFolder-1.html +++ b/docs/modules/_standard_component.TJSSvgFolder-1.html @@ -1,5 +1,14 @@ -TJSSvgFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSSvgFolder

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSSvgFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSSvgFolder

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSTinyMCE-1.html b/docs/modules/_standard_component.TJSTinyMCE-1.html index 99f3dcba..80ef5679 100644 --- a/docs/modules/_standard_component.TJSTinyMCE-1.html +++ b/docs/modules/_standard_component.TJSTinyMCE-1.html @@ -1,5 +1,14 @@ -TJSTinyMCE | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSTinyMCE

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSTinyMCE | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSTinyMCE

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSToggleIconButton-1.html b/docs/modules/_standard_component.TJSToggleIconButton-1.html index 2442813f..a6919a11 100644 --- a/docs/modules/_standard_component.TJSToggleIconButton-1.html +++ b/docs/modules/_standard_component.TJSToggleIconButton-1.html @@ -1,5 +1,14 @@ -TJSToggleIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSToggleIconButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSToggleIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSToggleIconButton

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.TJSToggleLabel-1.html b/docs/modules/_standard_component.TJSToggleLabel-1.html index 60e82b6b..00d38ca8 100644 --- a/docs/modules/_standard_component.TJSToggleLabel-1.html +++ b/docs/modules/_standard_component.TJSToggleLabel-1.html @@ -1,5 +1,14 @@ -TJSToggleLabel | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                    Namespace TJSToggleLabel

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Index

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events +TJSToggleLabel | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace TJSToggleLabel

                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                    + +

                                                                                                                                                                                                                                    + Index +

                                                                                                                                                                                                                                    +                                                                                                                                                                                                                                     +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    Events Props Slots -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component.html b/docs/modules/_standard_component.html index e3e5630d..947a59f6 100644 --- a/docs/modules/_standard_component.html +++ b/docs/modules/_standard_component.html @@ -1,11 +1,13 @@ -#standard/component | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                      Package #standard/component

                                                                                                                                                                                                                                      +#standard/component | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                        Package #standard/component

                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                        TJSButton +

                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                        TinyMCEHelper +TJSButton TJSColordButton TJSColordPicker TJSColordPickerSavedColors @@ -31,7 +33,6 @@

                                                                                                                                                                                                                                        TJSTinyMCE TJSToggleIconButton TJSToggleLabel -TinyMCEHelper

                                                                                                                                                                                                                                        Namespaces

                                                                                                                                                                                                                                        TJSButton TJSColordButton TJSColordPicker @@ -70,4 +71,4 @@

                                                                                                                                                                                                                                        TJSScrollContainerData TJSTinyMCEOptions

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt.TJSFileButton-1.html b/docs/modules/_standard_component_fvtt.TJSFileButton-1.html index cde2f4cc..1388da65 100644 --- a/docs/modules/_standard_component_fvtt.TJSFileButton-1.html +++ b/docs/modules/_standard_component_fvtt.TJSFileButton-1.html @@ -1,5 +1,14 @@ -TJSFileButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                        Namespace TJSFileButton

                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                        Events +TJSFileButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Namespace TJSFileButton

                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                        + Index +

                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                        Events Props Slots -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt.TJSFileIconButton-1.html b/docs/modules/_standard_component_fvtt.TJSFileIconButton-1.html index 014be426..3fc98e96 100644 --- a/docs/modules/_standard_component_fvtt.TJSFileIconButton-1.html +++ b/docs/modules/_standard_component_fvtt.TJSFileIconButton-1.html @@ -1,5 +1,14 @@ -TJSFileIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                        Namespace TJSFileIconButton

                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                        Events +TJSFileIconButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Namespace TJSFileIconButton

                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                        + Index +

                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                        Events Props Slots -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt.TJSFileSlotButton-1.html b/docs/modules/_standard_component_fvtt.TJSFileSlotButton-1.html index f2753705..08c1964a 100644 --- a/docs/modules/_standard_component_fvtt.TJSFileSlotButton-1.html +++ b/docs/modules/_standard_component_fvtt.TJSFileSlotButton-1.html @@ -1,5 +1,14 @@ -TJSFileSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                        Namespace TJSFileSlotButton

                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                        Events +TJSFileSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Namespace TJSFileSlotButton

                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                        + Index +

                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                        Events Props Slots -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt.TJSMediaContent-1.html b/docs/modules/_standard_component_fvtt.TJSMediaContent-1.html index 667afca4..c0f9206f 100644 --- a/docs/modules/_standard_component_fvtt.TJSMediaContent-1.html +++ b/docs/modules/_standard_component_fvtt.TJSMediaContent-1.html @@ -1,5 +1,14 @@ -TJSMediaContent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                        Namespace TJSMediaContent

                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                        Index

                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                        Events +TJSMediaContent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Namespace TJSMediaContent

                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                        + +

                                                                                                                                                                                                                                        + Index +

                                                                                                                                                                                                                                        +                                                                                                                                                                                                                                         +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                        Events Props Slots -

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt.html b/docs/modules/_standard_component_fvtt.html index 6aa3350b..0d2deae8 100644 --- a/docs/modules/_standard_component_fvtt.html +++ b/docs/modules/_standard_component_fvtt.html @@ -1,4 +1,5 @@ -#standard/component/fvtt | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                          Package #standard/component/fvtt

                                                                                                                                                                                                                                          +#standard/component/fvtt | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                            Package #standard/component/fvtt

                                                                                                                                                                                                                                            Index @@ -14,4 +15,4 @@

                                                                                                                                                                                                                                            TJSFileSlotButton TJSMediaContent

                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_standard_fvtt.html b/docs/modules/_standard_fvtt.html index c6363957..ebb0a7f5 100644 --- a/docs/modules/_standard_fvtt.html +++ b/docs/modules/_standard_fvtt.html @@ -1,12 +1,13 @@ -#standard/fvtt | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                              Package #standard/fvtt

                                                                                                                                                                                                                                              +#standard/fvtt | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                Package #standard/fvtt

                                                                                                                                                                                                                                                Index

                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                FVTTVersion -FontManager +

                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                FontManager FoundryStyles +FVTTVersion
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_standard_prosemirror.html b/docs/modules/_standard_prosemirror.html index 3218db56..051c350f 100644 --- a/docs/modules/_standard_prosemirror.html +++ b/docs/modules/_standard_prosemirror.html @@ -1,4 +1,5 @@ -#standard/prosemirror | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                  Package #standard/prosemirror

                                                                                                                                                                                                                                                  +#standard/prosemirror | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                    Package #standard/prosemirror

                                                                                                                                                                                                                                                    Index @@ -7,4 +8,4 @@

                                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                                    PMImpl
                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_prosemirror_plugins.html b/docs/modules/_standard_prosemirror_plugins.html index 33746cbb..e7617758 100644 --- a/docs/modules/_standard_prosemirror_plugins.html +++ b/docs/modules/_standard_prosemirror_plugins.html @@ -1,4 +1,5 @@ -#standard/prosemirror/plugins | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                      Package #standard/prosemirror/plugins

                                                                                                                                                                                                                                                      +#standard/prosemirror/plugins | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                        Package #standard/prosemirror/plugins

                                                                                                                                                                                                                                                        Index @@ -8,4 +9,4 @@

                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                        TJSKeyMaps TJSPasteUUID

                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_store.html b/docs/modules/_standard_store.html index b3c9b0ed..0fef2453 100644 --- a/docs/modules/_standard_store.html +++ b/docs/modules/_standard_store.html @@ -1,4 +1,5 @@ -#standard/store | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                          Package #standard/store

                                                                                                                                                                                                                                                          +#standard/store | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                            Package #standard/store

                                                                                                                                                                                                                                                            Index @@ -11,4 +12,4 @@

                                                                                                                                                                                                                                                            TJSThemeStoreConfig TJSThemeStoreOptions

                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/svelte.html b/docs/modules/svelte.html index ef843629..54201afb 100644 --- a/docs/modules/svelte.html +++ b/docs/modules/svelte.html @@ -1,6 +1,7 @@ -svelte | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                              Package svelte

                                                                                                                                                                                                                                                              Documentation: https://svelte.dev/docs/svelte

                                                                                                                                                                                                                                                              +svelte | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                Package svelte

                                                                                                                                                                                                                                                                Documentation: https://svelte.dev/docs/svelte

                                                                                                                                                                                                                                                                Interactive Tutorial: https://svelte.dev/tutorial/basics

                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                Index @@ -8,8 +9,8 @@

                                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                                SvelteComponent -SvelteComponentTyped SvelteComponent_1 +SvelteComponentTyped

                                                                                                                                                                                                                                                                Functions

                                                                                                                                                                                                                                                                afterUpdate beforeUpdate createEventDispatcher @@ -28,4 +29,4 @@

                                                                                                                                                                                                                                                                ComponentType NotFunction

                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/svelte_action.html b/docs/modules/svelte_action.html index dffa267a..8b5c9967 100644 --- a/docs/modules/svelte_action.html +++ b/docs/modules/svelte_action.html @@ -1,6 +1,7 @@ -svelte/action | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                  Package svelte/action

                                                                                                                                                                                                                                                                  Documentation: https://svelte.dev/docs/svelte-action

                                                                                                                                                                                                                                                                  +svelte/action | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                    Package svelte/action

                                                                                                                                                                                                                                                                    Documentation: https://svelte.dev/docs/svelte-action

                                                                                                                                                                                                                                                                    Interactive Tutorial: https://svelte.dev/tutorial/actions

                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                    Index @@ -10,4 +11,4 @@

                                                                                                                                                                                                                                                                    Interfaces

                                                                                                                                                                                                                                                                    Action ActionReturn

                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/svelte_animate.html b/docs/modules/svelte_animate.html index 8e847a9d..ace775e3 100644 --- a/docs/modules/svelte_animate.html +++ b/docs/modules/svelte_animate.html @@ -1,6 +1,7 @@ -svelte/animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                      Package svelte/animate

                                                                                                                                                                                                                                                                      Documentation: https://svelte.dev/docs/svelte-animate

                                                                                                                                                                                                                                                                      +svelte/animate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                        Package svelte/animate

                                                                                                                                                                                                                                                                        Documentation: https://svelte.dev/docs/svelte-animate

                                                                                                                                                                                                                                                                        Interactive Tutorial: https://svelte.dev/tutorial/animate

                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                        Index @@ -11,4 +12,4 @@

                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                        AnimationConfig FlipParams
                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/svelte_easing.html b/docs/modules/svelte_easing.html index 39f89f91..e0df2c10 100644 --- a/docs/modules/svelte_easing.html +++ b/docs/modules/svelte_easing.html @@ -1,6 +1,7 @@ -svelte/easing | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                          Package svelte/easing

                                                                                                                                                                                                                                                                          Documentation: https://svelte.dev/docs/svelte-easing

                                                                                                                                                                                                                                                                          +svelte/easing | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                            Package svelte/easing

                                                                                                                                                                                                                                                                            Documentation: https://svelte.dev/docs/svelte-easing

                                                                                                                                                                                                                                                                            Interactive Easing Demo: https://svelte.dev/examples/easing

                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                            Index @@ -39,4 +40,4 @@

                                                                                                                                                                                                                                                                            sineInOut sineOut

                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/svelte_motion.html b/docs/modules/svelte_motion.html index d117eabb..bb76ea4d 100644 --- a/docs/modules/svelte_motion.html +++ b/docs/modules/svelte_motion.html @@ -1,6 +1,7 @@ -svelte/motion | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                              Package svelte/motion

                                                                                                                                                                                                                                                                              Documentation: https://svelte.dev/docs/svelte-motion

                                                                                                                                                                                                                                                                              +svelte/motion | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                Package svelte/motion

                                                                                                                                                                                                                                                                                Documentation: https://svelte.dev/docs/svelte-motion

                                                                                                                                                                                                                                                                                Interactive Tutorial: https://svelte.dev/tutorial/tweened

                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                Index @@ -20,4 +21,4 @@

                                                                                                                                                                                                                                                                                Unsubscriber Updater

                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/svelte_store.html b/docs/modules/svelte_store.html index c87a0134..4fe88a5d 100644 --- a/docs/modules/svelte_store.html +++ b/docs/modules/svelte_store.html @@ -1,6 +1,7 @@ -svelte/store | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                  Package svelte/store

                                                                                                                                                                                                                                                                                  Documentation: https://svelte.dev/docs/svelte-store

                                                                                                                                                                                                                                                                                  +svelte/store | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                    Package svelte/store

                                                                                                                                                                                                                                                                                    Documentation: https://svelte.dev/docs/svelte-store

                                                                                                                                                                                                                                                                                    Interactive Tutorial: https://svelte.dev/tutorial/writable-stores

                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                    Index @@ -22,4 +23,4 @@

                                                                                                                                                                                                                                                                                    Unsubscriber Updater

                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/svelte_transition.html b/docs/modules/svelte_transition.html index 035e3376..ca10b7b7 100644 --- a/docs/modules/svelte_transition.html +++ b/docs/modules/svelte_transition.html @@ -1,6 +1,7 @@ -svelte/transition | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                      Package svelte/transition

                                                                                                                                                                                                                                                                                      Documentation: https://svelte.dev/docs/svelte-transition

                                                                                                                                                                                                                                                                                      +svelte/transition | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                        Package svelte/transition

                                                                                                                                                                                                                                                                                        Documentation: https://svelte.dev/docs/svelte-transition

                                                                                                                                                                                                                                                                                        Interactive Tutorial: https://svelte.dev/tutorial/transition

                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Index @@ -24,4 +25,4 @@

                                                                                                                                                                                                                                                                                        TransitionConfig

                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                        EasingFunction
                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.AnyColor.html b/docs/types/_runtime_color_colord.AnyColor.html index 374e3a20..c5ef411a 100644 --- a/docs/types/_runtime_color_colord.AnyColor.html +++ b/docs/types/_runtime_color_colord.AnyColor.html @@ -1 +1,2 @@ -AnyColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias AnyColor

                                                                                                                                                                                                                                                                                        AnyColor: string | ObjectColor

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +AnyColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias AnyColor

                                                                                                                                                                                                                                                                                        AnyColor: string | ObjectColor

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.HslColor.html b/docs/types/_runtime_color_colord.HslColor.html index fd71be39..e441d3fa 100644 --- a/docs/types/_runtime_color_colord.HslColor.html +++ b/docs/types/_runtime_color_colord.HslColor.html @@ -1 +1,2 @@ -HslColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias HslColor

                                                                                                                                                                                                                                                                                        HslColor: {
                                                                                                                                                                                                                                                                                            h: number;
                                                                                                                                                                                                                                                                                            l: number;
                                                                                                                                                                                                                                                                                            s: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • h: number
                                                                                                                                                                                                                                                                                        • l: number
                                                                                                                                                                                                                                                                                        • s: number

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +HslColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias HslColor

                                                                                                                                                                                                                                                                                        HslColor: {
                                                                                                                                                                                                                                                                                            h: number;
                                                                                                                                                                                                                                                                                            l: number;
                                                                                                                                                                                                                                                                                            s: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.HslaColor.html b/docs/types/_runtime_color_colord.HslaColor.html index 9a9c0754..c9524cdf 100644 --- a/docs/types/_runtime_color_colord.HslaColor.html +++ b/docs/types/_runtime_color_colord.HslaColor.html @@ -1 +1,2 @@ -HslaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias HslaColor

                                                                                                                                                                                                                                                                                        HslaColor: WithAlpha<HslColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +HslaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias HslaColor

                                                                                                                                                                                                                                                                                        HslaColor: WithAlpha<HslColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.HsvColor.html b/docs/types/_runtime_color_colord.HsvColor.html index 2f56ac2e..ba218ee8 100644 --- a/docs/types/_runtime_color_colord.HsvColor.html +++ b/docs/types/_runtime_color_colord.HsvColor.html @@ -1 +1,2 @@ -HsvColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias HsvColor

                                                                                                                                                                                                                                                                                        HsvColor: {
                                                                                                                                                                                                                                                                                            h: number;
                                                                                                                                                                                                                                                                                            s: number;
                                                                                                                                                                                                                                                                                            v: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • h: number
                                                                                                                                                                                                                                                                                        • s: number
                                                                                                                                                                                                                                                                                        • v: number

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +HsvColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias HsvColor

                                                                                                                                                                                                                                                                                        HsvColor: {
                                                                                                                                                                                                                                                                                            h: number;
                                                                                                                                                                                                                                                                                            s: number;
                                                                                                                                                                                                                                                                                            v: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.HsvaColor.html b/docs/types/_runtime_color_colord.HsvaColor.html index e22917bd..4e8a4244 100644 --- a/docs/types/_runtime_color_colord.HsvaColor.html +++ b/docs/types/_runtime_color_colord.HsvaColor.html @@ -1 +1,2 @@ -HsvaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias HsvaColor

                                                                                                                                                                                                                                                                                        HsvaColor: WithAlpha<HsvColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +HsvaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias HsvaColor

                                                                                                                                                                                                                                                                                        HsvaColor: WithAlpha<HsvColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.HwbColor.html b/docs/types/_runtime_color_colord.HwbColor.html index 833dc290..79cd7e88 100644 --- a/docs/types/_runtime_color_colord.HwbColor.html +++ b/docs/types/_runtime_color_colord.HwbColor.html @@ -1 +1,2 @@ -HwbColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias HwbColor

                                                                                                                                                                                                                                                                                        HwbColor: {
                                                                                                                                                                                                                                                                                            b: number;
                                                                                                                                                                                                                                                                                            h: number;
                                                                                                                                                                                                                                                                                            w: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • b: number
                                                                                                                                                                                                                                                                                        • h: number
                                                                                                                                                                                                                                                                                        • w: number

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +HwbColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias HwbColor

                                                                                                                                                                                                                                                                                        HwbColor: {
                                                                                                                                                                                                                                                                                            b: number;
                                                                                                                                                                                                                                                                                            h: number;
                                                                                                                                                                                                                                                                                            w: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.HwbaColor.html b/docs/types/_runtime_color_colord.HwbaColor.html index fb2cac3d..60621bb1 100644 --- a/docs/types/_runtime_color_colord.HwbaColor.html +++ b/docs/types/_runtime_color_colord.HwbaColor.html @@ -1 +1,2 @@ -HwbaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias HwbaColor

                                                                                                                                                                                                                                                                                        HwbaColor: WithAlpha<HwbColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +HwbaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias HwbaColor

                                                                                                                                                                                                                                                                                        HwbaColor: WithAlpha<HwbColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.LabaColor.html b/docs/types/_runtime_color_colord.LabaColor.html index 3911df2f..5e0d164e 100644 --- a/docs/types/_runtime_color_colord.LabaColor.html +++ b/docs/types/_runtime_color_colord.LabaColor.html @@ -1 +1,2 @@ -LabaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias LabaColor

                                                                                                                                                                                                                                                                                        LabaColor: LabColor & {
                                                                                                                                                                                                                                                                                            alpha: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • alpha: number

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +LabaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias LabaColor

                                                                                                                                                                                                                                                                                        LabaColor: LabColor & {
                                                                                                                                                                                                                                                                                            alpha: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.LchaColor.html b/docs/types/_runtime_color_colord.LchaColor.html index a3fcf555..6dfba871 100644 --- a/docs/types/_runtime_color_colord.LchaColor.html +++ b/docs/types/_runtime_color_colord.LchaColor.html @@ -1 +1,2 @@ -LchaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias LchaColor

                                                                                                                                                                                                                                                                                        LchaColor: WithAlpha<LchColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +LchaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias LchaColor

                                                                                                                                                                                                                                                                                        LchaColor: WithAlpha<LchColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.Plugin.html b/docs/types/_runtime_color_colord.Plugin.html index 1865e1a1..1301f157 100644 --- a/docs/types/_runtime_color_colord.Plugin.html +++ b/docs/types/_runtime_color_colord.Plugin.html @@ -1 +1,2 @@ -Plugin | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Plugin

                                                                                                                                                                                                                                                                                        Plugin: ((ColordClass, parsers) => void)

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (ColordClass, parsers): void

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • ColordClass: typeof Colord
                                                                                                                                                                                                                                                                                            • parsers: Parsers

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Plugin | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Plugin

                                                                                                                                                                                                                                                                                        Plugin: ((ColordClass: typeof Colord, parsers: Parsers) => void)

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.RgbColor.html b/docs/types/_runtime_color_colord.RgbColor.html index d79a0012..336fdac1 100644 --- a/docs/types/_runtime_color_colord.RgbColor.html +++ b/docs/types/_runtime_color_colord.RgbColor.html @@ -1 +1,2 @@ -RgbColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias RgbColor

                                                                                                                                                                                                                                                                                        RgbColor: {
                                                                                                                                                                                                                                                                                            b: number;
                                                                                                                                                                                                                                                                                            g: number;
                                                                                                                                                                                                                                                                                            r: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • b: number
                                                                                                                                                                                                                                                                                        • g: number
                                                                                                                                                                                                                                                                                        • r: number

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +RgbColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias RgbColor

                                                                                                                                                                                                                                                                                        RgbColor: {
                                                                                                                                                                                                                                                                                            b: number;
                                                                                                                                                                                                                                                                                            g: number;
                                                                                                                                                                                                                                                                                            r: number;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.RgbaColor.html b/docs/types/_runtime_color_colord.RgbaColor.html index 704b56cb..4cfa603a 100644 --- a/docs/types/_runtime_color_colord.RgbaColor.html +++ b/docs/types/_runtime_color_colord.RgbaColor.html @@ -1 +1,2 @@ -RgbaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias RgbaColor

                                                                                                                                                                                                                                                                                        RgbaColor: WithAlpha<RgbColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +RgbaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias RgbaColor

                                                                                                                                                                                                                                                                                        RgbaColor: WithAlpha<RgbColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_color_colord.XyzaColor.html b/docs/types/_runtime_color_colord.XyzaColor.html index 10d8c5d0..f3b72039 100644 --- a/docs/types/_runtime_color_colord.XyzaColor.html +++ b/docs/types/_runtime_color_colord.XyzaColor.html @@ -1 +1,2 @@ -XyzaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias XyzaColor

                                                                                                                                                                                                                                                                                        XyzaColor: WithAlpha<XyzColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +XyzaColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias XyzaColor

                                                                                                                                                                                                                                                                                        XyzaColor: WithAlpha<XyzColor>

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.AsyncFlateDrainHandler.html b/docs/types/_runtime_data_compress.AsyncFlateDrainHandler.html index fd911931..464f4f31 100644 --- a/docs/types/_runtime_data_compress.AsyncFlateDrainHandler.html +++ b/docs/types/_runtime_data_compress.AsyncFlateDrainHandler.html @@ -1,4 +1,5 @@ -AsyncFlateDrainHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias AsyncFlateDrainHandler

                                                                                                                                                                                                                                                                                        AsyncFlateDrainHandler: ((size) => void)

                                                                                                                                                                                                                                                                                        Handler for the asynchronous completion of (de)compression for a data chunk

                                                                                                                                                                                                                                                                                        +AsyncFlateDrainHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias AsyncFlateDrainHandler

                                                                                                                                                                                                                                                                                        AsyncFlateDrainHandler: ((size: number) => void)

                                                                                                                                                                                                                                                                                        Handler for the asynchronous completion of (de)compression for a data chunk

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (size): void

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • size: number

                                                                                                                                                                                                                                                                                              The number of bytes that were processed. This is measured in terms of the input (i.e. compressed bytes for decompression, uncompressed bytes for compression.)

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.AsyncFlateStreamHandler.html b/docs/types/_runtime_data_compress.AsyncFlateStreamHandler.html index 5114b4b9..b4dcdb1a 100644 --- a/docs/types/_runtime_data_compress.AsyncFlateStreamHandler.html +++ b/docs/types/_runtime_data_compress.AsyncFlateStreamHandler.html @@ -1,5 +1,6 @@ -AsyncFlateStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias AsyncFlateStreamHandler

                                                                                                                                                                                                                                                                                        AsyncFlateStreamHandler: ((err, data, final) => void)

                                                                                                                                                                                                                                                                                        Handler for asynchronous data (de)compression streams

                                                                                                                                                                                                                                                                                        +AsyncFlateStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias AsyncFlateStreamHandler

                                                                                                                                                                                                                                                                                        AsyncFlateStreamHandler: ((err: FlateError | null, data: Uint8Array, final: boolean) => void)

                                                                                                                                                                                                                                                                                        Handler for asynchronous data (de)compression streams

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (err, data, final): void

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • err: FlateError | null

                                                                                                                                                                                                                                                                                              Any error that occurred

                                                                                                                                                                                                                                                                                            • data: Uint8Array

                                                                                                                                                                                                                                                                                              The data output from the stream processor

                                                                                                                                                                                                                                                                                            • final: boolean

                                                                                                                                                                                                                                                                                              Whether this is the final block

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.AsyncZippableFile.html b/docs/types/_runtime_data_compress.AsyncZippableFile.html index 662fe1de..b9107537 100644 --- a/docs/types/_runtime_data_compress.AsyncZippableFile.html +++ b/docs/types/_runtime_data_compress.AsyncZippableFile.html @@ -1,2 +1,3 @@ -AsyncZippableFile | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias AsyncZippableFile

                                                                                                                                                                                                                                                                                        AsyncZippableFile: Uint8Array | AsyncZippable | [Uint8Array | AsyncZippable, AsyncZipOptions]

                                                                                                                                                                                                                                                                                        A file that can be used to asynchronously create a ZIP archive

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +AsyncZippableFile | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias AsyncZippableFile

                                                                                                                                                                                                                                                                                        AsyncZippableFile: Uint8Array | AsyncZippable | [Uint8Array | AsyncZippable, AsyncZipOptions]

                                                                                                                                                                                                                                                                                        A file that can be used to asynchronously create a ZIP archive

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.FlateCallback.html b/docs/types/_runtime_data_compress.FlateCallback.html index 3cc99fb1..daf2c4e5 100644 --- a/docs/types/_runtime_data_compress.FlateCallback.html +++ b/docs/types/_runtime_data_compress.FlateCallback.html @@ -1,4 +1,5 @@ -FlateCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias FlateCallback

                                                                                                                                                                                                                                                                                        FlateCallback: ((err, data) => void)

                                                                                                                                                                                                                                                                                        Callback for asynchronous (de)compression methods

                                                                                                                                                                                                                                                                                        +FlateCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias FlateCallback

                                                                                                                                                                                                                                                                                        FlateCallback: ((err: FlateError | null, data: Uint8Array) => void)

                                                                                                                                                                                                                                                                                        Callback for asynchronous (de)compression methods

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (err, data): void

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • err: FlateError | null

                                                                                                                                                                                                                                                                                              Any error that occurred

                                                                                                                                                                                                                                                                                            • data: Uint8Array

                                                                                                                                                                                                                                                                                              The resulting data. Only present if err is null

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.FlateStreamHandler.html b/docs/types/_runtime_data_compress.FlateStreamHandler.html index c679cb68..edb61aea 100644 --- a/docs/types/_runtime_data_compress.FlateStreamHandler.html +++ b/docs/types/_runtime_data_compress.FlateStreamHandler.html @@ -1,4 +1,5 @@ -FlateStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias FlateStreamHandler

                                                                                                                                                                                                                                                                                        FlateStreamHandler: ((data, final) => void)

                                                                                                                                                                                                                                                                                        Handler for data (de)compression streams

                                                                                                                                                                                                                                                                                        +FlateStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias FlateStreamHandler

                                                                                                                                                                                                                                                                                        FlateStreamHandler: ((data: Uint8Array, final: boolean) => void)

                                                                                                                                                                                                                                                                                        Handler for data (de)compression streams

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (data, final): void

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • data: Uint8Array

                                                                                                                                                                                                                                                                                              The data output from the stream processor

                                                                                                                                                                                                                                                                                            • final: boolean

                                                                                                                                                                                                                                                                                              Whether this is the final block

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.GunzipMemberHandler.html b/docs/types/_runtime_data_compress.GunzipMemberHandler.html index e0a2e2a4..d211179a 100644 --- a/docs/types/_runtime_data_compress.GunzipMemberHandler.html +++ b/docs/types/_runtime_data_compress.GunzipMemberHandler.html @@ -1,3 +1,4 @@ -GunzipMemberHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias GunzipMemberHandler

                                                                                                                                                                                                                                                                                        GunzipMemberHandler: ((offset) => void)

                                                                                                                                                                                                                                                                                        Handler for new GZIP members in concatenated GZIP streams. Useful for building indices used to perform random-access reads on compressed files.

                                                                                                                                                                                                                                                                                        +GunzipMemberHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias GunzipMemberHandler

                                                                                                                                                                                                                                                                                        GunzipMemberHandler: ((offset: number) => void)

                                                                                                                                                                                                                                                                                        Handler for new GZIP members in concatenated GZIP streams. Useful for building indices used to perform random-access reads on compressed files.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (offset): void

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • offset: number

                                                                                                                                                                                                                                                                                              The offset of the new member relative to the start of the stream

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.StringStreamHandler.html b/docs/types/_runtime_data_compress.StringStreamHandler.html index 6ade5dc0..2b113e98 100644 --- a/docs/types/_runtime_data_compress.StringStreamHandler.html +++ b/docs/types/_runtime_data_compress.StringStreamHandler.html @@ -1,4 +1,5 @@ -StringStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias StringStreamHandler

                                                                                                                                                                                                                                                                                        StringStreamHandler: ((data, final) => void)

                                                                                                                                                                                                                                                                                        Handler for string generation streams

                                                                                                                                                                                                                                                                                        +StringStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias StringStreamHandler

                                                                                                                                                                                                                                                                                        StringStreamHandler: ((data: string, final: boolean) => void)

                                                                                                                                                                                                                                                                                        Handler for string generation streams

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (data, final): void

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • data: string

                                                                                                                                                                                                                                                                                              The string output from the stream processor

                                                                                                                                                                                                                                                                                            • final: boolean

                                                                                                                                                                                                                                                                                              Whether this is the final block

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.UnzipCallback.html b/docs/types/_runtime_data_compress.UnzipCallback.html index ce924627..b2f1f18e 100644 --- a/docs/types/_runtime_data_compress.UnzipCallback.html +++ b/docs/types/_runtime_data_compress.UnzipCallback.html @@ -1,4 +1,5 @@ -UnzipCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias UnzipCallback

                                                                                                                                                                                                                                                                                        UnzipCallback: ((err, data) => void)

                                                                                                                                                                                                                                                                                        Callback for asynchronous ZIP decompression

                                                                                                                                                                                                                                                                                        +UnzipCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias UnzipCallback

                                                                                                                                                                                                                                                                                        UnzipCallback: ((err: FlateError | null, data: Unzipped) => void)

                                                                                                                                                                                                                                                                                        Callback for asynchronous ZIP decompression

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (err, data): void

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • err: FlateError | null

                                                                                                                                                                                                                                                                                              Any error that occurred

                                                                                                                                                                                                                                                                                            • data: Unzipped

                                                                                                                                                                                                                                                                                              The decompressed ZIP archive

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.UnzipFileFilter.html b/docs/types/_runtime_data_compress.UnzipFileFilter.html index d74b56c1..f0a48123 100644 --- a/docs/types/_runtime_data_compress.UnzipFileFilter.html +++ b/docs/types/_runtime_data_compress.UnzipFileFilter.html @@ -1,4 +1,5 @@ -UnzipFileFilter | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias UnzipFileFilter

                                                                                                                                                                                                                                                                                        UnzipFileFilter: ((file) => boolean)

                                                                                                                                                                                                                                                                                        A filter for files to be extracted during the unzipping process

                                                                                                                                                                                                                                                                                        +UnzipFileFilter | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias UnzipFileFilter

                                                                                                                                                                                                                                                                                        UnzipFileFilter: ((file: UnzipFileInfo) => boolean)

                                                                                                                                                                                                                                                                                        A filter for files to be extracted during the unzipping process

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (file): boolean

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • file: UnzipFileInfo

                                                                                                                                                                                                                                                                                              The info for the current file being processed

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns boolean

                                                                                                                                                                                                                                                                                        Returns

                                                                                                                                                                                                                                                                                        Whether or not to extract the current file

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Returns boolean

                                                                                                                                                                                                                                                                                        Whether or not to extract the current file

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.UnzipFileHandler.html b/docs/types/_runtime_data_compress.UnzipFileHandler.html index 2c452221..2e8a1968 100644 --- a/docs/types/_runtime_data_compress.UnzipFileHandler.html +++ b/docs/types/_runtime_data_compress.UnzipFileHandler.html @@ -1,3 +1,4 @@ -UnzipFileHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias UnzipFileHandler

                                                                                                                                                                                                                                                                                        UnzipFileHandler: ((file) => void)

                                                                                                                                                                                                                                                                                        Handler for streaming ZIP decompression

                                                                                                                                                                                                                                                                                        +UnzipFileHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias UnzipFileHandler

                                                                                                                                                                                                                                                                                        UnzipFileHandler: ((file: UnzipFile) => void)

                                                                                                                                                                                                                                                                                        Handler for streaming ZIP decompression

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • (file): void

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • file: UnzipFile

                                                                                                                                                                                                                                                                                              The file that was found in the archive

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_compress.ZippableFile.html b/docs/types/_runtime_data_compress.ZippableFile.html index a77da9e0..bab591e4 100644 --- a/docs/types/_runtime_data_compress.ZippableFile.html +++ b/docs/types/_runtime_data_compress.ZippableFile.html @@ -1,2 +1,3 @@ -ZippableFile | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias ZippableFile

                                                                                                                                                                                                                                                                                        ZippableFile: Uint8Array | Zippable | [Uint8Array | Zippable, ZipOptions]

                                                                                                                                                                                                                                                                                        A file that can be used to create a ZIP archive

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +ZippableFile | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias ZippableFile

                                                                                                                                                                                                                                                                                        ZippableFile: Uint8Array | Zippable | [Uint8Array | Zippable, ZipOptions]

                                                                                                                                                                                                                                                                                        A file that can be used to create a ZIP archive

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_format_json5.StringifyOptions.html b/docs/types/_runtime_data_format_json5.StringifyOptions.html index 5dd5656c..40d72b5f 100644 --- a/docs/types/_runtime_data_format_json5.StringifyOptions.html +++ b/docs/types/_runtime_data_format_json5.StringifyOptions.html @@ -1,11 +1,12 @@ -StringifyOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias StringifyOptions

                                                                                                                                                                                                                                                                                        StringifyOptions: {
                                                                                                                                                                                                                                                                                            quote?: string | null;
                                                                                                                                                                                                                                                                                            replacer?: ((this, key, value) => any) | (string | number)[] | null;
                                                                                                                                                                                                                                                                                            space?: string | number | null;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional quote?: string | null

                                                                                                                                                                                                                                                                                          A String representing the quote character to use when serializing +StringifyOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Alias StringifyOptions

                                                                                                                                                                                                                                                                                          StringifyOptions: {
                                                                                                                                                                                                                                                                                              quote?: string | null;
                                                                                                                                                                                                                                                                                              replacer?: ((this: any, key: string, value: any) => any) | (string | number)[] | null;
                                                                                                                                                                                                                                                                                              space?: string | number | null;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • Optionalquote?: string | null

                                                                                                                                                                                                                                                                                            A String representing the quote character to use when serializing strings.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional replacer?: ((this, key, value) => any) | (string | number)[] | null

                                                                                                                                                                                                                                                                                            A function that alters the behavior of the stringification process, or an +

                                                                                                                                                                                                                                                                                          • Optionalreplacer?: ((this: any, key: string, value: any) => any) | (string | number)[] | null

                                                                                                                                                                                                                                                                                            A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a allowlist for selecting/filtering the properties of the value object to be included in the JSON5 string. If this value is null or not provided, all properties of the object are included in the resulting JSON5 string.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional space?: string | number | null

                                                                                                                                                                                                                                                                                            A String or Number object that's used to insert white space into the +

                                                                                                                                                                                                                                                                                          • Optionalspace?: string | number | null

                                                                                                                                                                                                                                                                                            A String or Number object that's used to insert white space into the output JSON5 string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space; this number is capped at 10 (if it is greater, the value is just 10). Values @@ -14,4 +15,4 @@ that) is used as white space. If this parameter is not provided (or is null), no white space is used. If white space is used, trailing commas will be used in objects and arrays.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_cache_quick_lru.Options.html b/docs/types/_runtime_data_struct_cache_quick_lru.Options.html index ada8a1cf..fc6dde66 100644 --- a/docs/types/_runtime_data_struct_cache_quick_lru.Options.html +++ b/docs/types/_runtime_data_struct_cache_quick_lru.Options.html @@ -1,9 +1,10 @@ -Options | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Options<KeyType, ValueType>

                                                                                                                                                                                                                                                                                        Options<KeyType, ValueType>: {
                                                                                                                                                                                                                                                                                            maxAge?: number;
                                                                                                                                                                                                                                                                                            maxSize: number;
                                                                                                                                                                                                                                                                                            onEviction?: ((key, value) => void);
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • KeyType
                                                                                                                                                                                                                                                                                        • ValueType

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional Readonly maxAge?: number

                                                                                                                                                                                                                                                                                          The maximum number of milliseconds an item should remain in the cache.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Default

                                                                                                                                                                                                                                                                                          Infinity

                                                                                                                                                                                                                                                                                          +Options | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Alias Options<KeyType, ValueType>

                                                                                                                                                                                                                                                                                          Options<KeyType, ValueType>: {
                                                                                                                                                                                                                                                                                              maxAge?: number;
                                                                                                                                                                                                                                                                                              maxSize: number;
                                                                                                                                                                                                                                                                                              onEviction?: ((key: KeyType, value: ValueType) => void);
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                          • KeyType
                                                                                                                                                                                                                                                                                          • ValueType

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • Optional ReadonlymaxAge?: number

                                                                                                                                                                                                                                                                                            The maximum number of milliseconds an item should remain in the cache.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Default

                                                                                                                                                                                                                                                                                            Infinity

                                                                                                                                                                                                                                                                                            By default, maxAge will be Infinity, which means that items will never expire. Lazy expiration upon the next write or read call.

                                                                                                                                                                                                                                                                                            Individual expiration of an item can be specified by the set(key, value, maxAge) method.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Readonly maxSize: number

                                                                                                                                                                                                                                                                                            The maximum number of items before evicting the least recently used items.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional onEviction?: ((key, value) => void)

                                                                                                                                                                                                                                                                                            Called right before an item is evicted from the cache.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • ReadonlymaxSize: number

                                                                                                                                                                                                                                                                                            The maximum number of items before evicting the least recently used items.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalonEviction?: ((key: KeyType, value: ValueType) => void)

                                                                                                                                                                                                                                                                                            Called right before an item is evicted from the cache.

                                                                                                                                                                                                                                                                                            Useful for side effects or for items like object URLs that need explicit cleanup (revokeObjectURL).

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_hash_array.HashArrayOptions.html b/docs/types/_runtime_data_struct_hash_array.HashArrayOptions.html index 6d32fbde..89833e44 100644 --- a/docs/types/_runtime_data_struct_hash_array.HashArrayOptions.html +++ b/docs/types/_runtime_data_struct_hash_array.HashArrayOptions.html @@ -1,4 +1,5 @@ -HashArrayOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias HashArrayOptions<T>

                                                                                                                                                                                                                                                                                        HashArrayOptions<T>: {
                                                                                                                                                                                                                                                                                            ignoreDuplicates?: boolean;
                                                                                                                                                                                                                                                                                            list?: T[];
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Options for HashArray.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional ignoreDuplicates?: boolean

                                                                                                                                                                                                                                                                                          When true, any attempt to add items that collide with any items in the HashArray will be ignored.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional list?: T[]

                                                                                                                                                                                                                                                                                          An external array that is used for the list backing this HashArray allowing any owner direct access to the list.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +HashArrayOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias HashArrayOptions<T>

                                                                                                                                                                                                                                                                                        HashArrayOptions<T>: {
                                                                                                                                                                                                                                                                                            ignoreDuplicates?: boolean;
                                                                                                                                                                                                                                                                                            list?: T[];
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Options for HashArray.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • OptionalignoreDuplicates?: boolean

                                                                                                                                                                                                                                                                                          When true, any attempt to add items that collide with any items in the HashArray will be ignored.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • Optionallist?: T[]

                                                                                                                                                                                                                                                                                          An external array that is used for the list backing this HashArray allowing any owner direct access to the list.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_hash_array.Key.html b/docs/types/_runtime_data_struct_hash_array.Key.html index c0a50f16..96e3482c 100644 --- a/docs/types/_runtime_data_struct_hash_array.Key.html +++ b/docs/types/_runtime_data_struct_hash_array.Key.html @@ -1,2 +1,3 @@ -Key | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Key

                                                                                                                                                                                                                                                                                        Key: string | string[]

                                                                                                                                                                                                                                                                                        A single key entry defined as a direct key / single string or array of strings for deep lookups.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Key | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Key

                                                                                                                                                                                                                                                                                        Key: string | string[]

                                                                                                                                                                                                                                                                                        A single key entry defined as a direct key / single string or array of strings for deep lookups.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_hash_array.KeyFields.html b/docs/types/_runtime_data_struct_hash_array.KeyFields.html index ed32810d..8018ca38 100644 --- a/docs/types/_runtime_data_struct_hash_array.KeyFields.html +++ b/docs/types/_runtime_data_struct_hash_array.KeyFields.html @@ -1,3 +1,4 @@ -KeyFields | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias KeyFields

                                                                                                                                                                                                                                                                                        KeyFields: Key[]

                                                                                                                                                                                                                                                                                        A single string or an array of strings / arrays representing what fields on added objects are to be used as keys for +KeyFields | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias KeyFields

                                                                                                                                                                                                                                                                                        KeyFields: Key[]

                                                                                                                                                                                                                                                                                        A single string or an array of strings / arrays representing what fields on added objects are to be used as keys for the trie search / HashArray.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_search_trie.TrieNode.html b/docs/types/_runtime_data_struct_search_trie.TrieNode.html index 18652297..b073f954 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieNode.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieNode.html @@ -1,3 +1,4 @@ -TrieNode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TrieNode<T>

                                                                                                                                                                                                                                                                                        TrieNode<T>: {
                                                                                                                                                                                                                                                                                            [K in string]?: TrieNode<T>
                                                                                                                                                                                                                                                                                        } & {
                                                                                                                                                                                                                                                                                            value?: T[];
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines the trie data structure. The value key is a specific list of items; all other string keys may refer to +TrieNode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias TrieNode<T>

                                                                                                                                                                                                                                                                                        TrieNode<T>: {
                                                                                                                                                                                                                                                                                            [K in string]?: TrieNode<T>
                                                                                                                                                                                                                                                                                        } & {
                                                                                                                                                                                                                                                                                            value?: T[];
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines the trie data structure. The value key is a specific list of items; all other string keys may refer to another TrieNode.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T extends object

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional value?: T[]

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T extends object

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_search_trie.TrieSearchOptions.html b/docs/types/_runtime_data_struct_search_trie.TrieSearchOptions.html index e3de7fd0..a75bc221 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieSearchOptions.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieSearchOptions.html @@ -1,16 +1,17 @@ -TrieSearchOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TrieSearchOptions

                                                                                                                                                                                                                                                                                        TrieSearchOptions: {
                                                                                                                                                                                                                                                                                            cache?: boolean;
                                                                                                                                                                                                                                                                                            expandRegexes?: [{
                                                                                                                                                                                                                                                                                                alternate: string;
                                                                                                                                                                                                                                                                                                regex: RegExp;
                                                                                                                                                                                                                                                                                            }];
                                                                                                                                                                                                                                                                                            ignoreCase?: boolean;
                                                                                                                                                                                                                                                                                            insertFullUnsplitKey?: boolean;
                                                                                                                                                                                                                                                                                            maxCacheSize?: number;
                                                                                                                                                                                                                                                                                            min?: number;
                                                                                                                                                                                                                                                                                            splitOnGetRegEx?: RegExp | false;
                                                                                                                                                                                                                                                                                            splitOnRegEx?: RegExp | false;
                                                                                                                                                                                                                                                                                            tokenizer?: ((str) => IterableIterator<string>);
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Options for TrieSearch.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional cache?: boolean

                                                                                                                                                                                                                                                                                          Is caching enabled; default: true.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional expandRegexes?: [{
                                                                                                                                                                                                                                                                                              alternate: string;
                                                                                                                                                                                                                                                                                              regex: RegExp;
                                                                                                                                                                                                                                                                                          }]

                                                                                                                                                                                                                                                                                          By default, this is set to an array of international vowels expansions, allowing searches for vowels like 'a' to +TrieSearchOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Alias TrieSearchOptions

                                                                                                                                                                                                                                                                                          TrieSearchOptions: {
                                                                                                                                                                                                                                                                                              cache?: boolean;
                                                                                                                                                                                                                                                                                              expandRegexes?: [{
                                                                                                                                                                                                                                                                                                  alternate: string;
                                                                                                                                                                                                                                                                                                  regex: RegExp;
                                                                                                                                                                                                                                                                                              }];
                                                                                                                                                                                                                                                                                              ignoreCase?: boolean;
                                                                                                                                                                                                                                                                                              insertFullUnsplitKey?: boolean;
                                                                                                                                                                                                                                                                                              maxCacheSize?: number;
                                                                                                                                                                                                                                                                                              min?: number;
                                                                                                                                                                                                                                                                                              splitOnGetRegEx?: RegExp | false;
                                                                                                                                                                                                                                                                                              splitOnRegEx?: RegExp | false;
                                                                                                                                                                                                                                                                                              tokenizer?: ((str: string) => IterableIterator<string>);
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Options for TrieSearch.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • Optionalcache?: boolean

                                                                                                                                                                                                                                                                                            Is caching enabled; default: true.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalexpandRegexes?: [{
                                                                                                                                                                                                                                                                                                alternate: string;
                                                                                                                                                                                                                                                                                                regex: RegExp;
                                                                                                                                                                                                                                                                                            }]

                                                                                                                                                                                                                                                                                            By default, this is set to an array of international vowels expansions, allowing searches for vowels like 'a' to return matches on 'å' or 'ä' etc. Set this to an empty array / [] if you want to disable it. See the top of src/trie/TrieSearch.js file for examples.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional ignoreCase?: boolean

                                                                                                                                                                                                                                                                                            Ignores case in lookups; default: true.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional insertFullUnsplitKey?: boolean

                                                                                                                                                                                                                                                                                            In TrieSearch.map when splitOnRegEx is defined and insertFullUnsplitKey is true the full key will also be +

                                                                                                                                                                                                                                                                                          • OptionalignoreCase?: boolean

                                                                                                                                                                                                                                                                                            Ignores case in lookups; default: true.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalinsertFullUnsplitKey?: boolean

                                                                                                                                                                                                                                                                                            In TrieSearch.map when splitOnRegEx is defined and insertFullUnsplitKey is true the full key will also be mapped; default: false.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional maxCacheSize?: number

                                                                                                                                                                                                                                                                                            The max cache size before removing entries in a LRU manner; default: 64.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional min?: number

                                                                                                                                                                                                                                                                                            The size of the prefix for keys; minimum length of a key to store and search. By default, this is 1, but you +

                                                                                                                                                                                                                                                                                          • OptionalmaxCacheSize?: number

                                                                                                                                                                                                                                                                                            The max cache size before removing entries in a LRU manner; default: 64.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionalmin?: number

                                                                                                                                                                                                                                                                                            The size of the prefix for keys; minimum length of a key to store and search. By default, this is 1, but you might improve performance by using 2 or 3.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional splitOnGetRegEx?: RegExp | false

                                                                                                                                                                                                                                                                                            How phrases are split on retrieval / get; default: /\s/g.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional splitOnRegEx?: RegExp | false

                                                                                                                                                                                                                                                                                            How phrases are split on search; default: /\s/g. By default, this is any whitespace. Set to false if you have +

                                                                                                                                                                                                                                                                                          • OptionalsplitOnGetRegEx?: RegExp | false

                                                                                                                                                                                                                                                                                            How phrases are split on retrieval / get; default: /\s/g.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalsplitOnRegEx?: RegExp | false

                                                                                                                                                                                                                                                                                            How phrases are split on search; default: /\s/g. By default, this is any whitespace. Set to false if you have whitespace in your keys! Set it to something else to split along other boundaries.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional tokenizer?: ((str) => IterableIterator<string>)

                                                                                                                                                                                                                                                                                            Provide a custom tokenizer that is used to split keys. IE a Grapheme / Unicode tokenizer.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                                                        • Optionaltokenizer?: ((str: string) => IterableIterator<string>)

                                                                                                                                                                                                                                                                                          Provide a custom tokenizer that is used to split keys. IE a Grapheme / Unicode tokenizer.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerData.html b/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerData.html index e96e8f7d..81308ffe 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerData.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerData.html @@ -1,7 +1,8 @@ -TrieSearchReducerData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TrieSearchReducerData<T>

                                                                                                                                                                                                                                                                                        TrieSearchReducerData<T>: {
                                                                                                                                                                                                                                                                                            ignoreCasePhrase: string;
                                                                                                                                                                                                                                                                                            index: number;
                                                                                                                                                                                                                                                                                            matches: T[];
                                                                                                                                                                                                                                                                                            phrase: string;
                                                                                                                                                                                                                                                                                            words: string[];
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Data provided when reducing a batch of matches.

                                                                                                                                                                                                                                                                                        +TrieSearchReducerData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias TrieSearchReducerData<T>

                                                                                                                                                                                                                                                                                        TrieSearchReducerData<T>: {
                                                                                                                                                                                                                                                                                            ignoreCasePhrase: string;
                                                                                                                                                                                                                                                                                            index: number;
                                                                                                                                                                                                                                                                                            matches: T[];
                                                                                                                                                                                                                                                                                            phrase: string;
                                                                                                                                                                                                                                                                                            words: string[];
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Data provided when reducing a batch of matches.

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • ignoreCasePhrase: string

                                                                                                                                                                                                                                                                                          The phrase after TrieSearchOptions.ignoreCase applied.

                                                                                                                                                                                                                                                                                        • index: number

                                                                                                                                                                                                                                                                                          The current phrase index.

                                                                                                                                                                                                                                                                                        • matches: T[]

                                                                                                                                                                                                                                                                                          Matches found from the current phrase.

                                                                                                                                                                                                                                                                                        • phrase: string

                                                                                                                                                                                                                                                                                          The original phrase.

                                                                                                                                                                                                                                                                                        • words: string[]

                                                                                                                                                                                                                                                                                          The split words from the phrase.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerResetData.html b/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerResetData.html index 89ad8e29..f93202a2 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerResetData.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerResetData.html @@ -1,6 +1,7 @@ -TrieSearchReducerResetData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TrieSearchReducerResetData<T>

                                                                                                                                                                                                                                                                                        TrieSearchReducerResetData<T>: {
                                                                                                                                                                                                                                                                                            keyFields: KeyFields;
                                                                                                                                                                                                                                                                                            list: T[];
                                                                                                                                                                                                                                                                                            options: TrieSearchOptions;
                                                                                                                                                                                                                                                                                            phrases: string | Iterable<string>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Data provided when resetting reducers.

                                                                                                                                                                                                                                                                                        +TrieSearchReducerResetData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias TrieSearchReducerResetData<T>

                                                                                                                                                                                                                                                                                        TrieSearchReducerResetData<T>: {
                                                                                                                                                                                                                                                                                            keyFields: KeyFields;
                                                                                                                                                                                                                                                                                            list: T[];
                                                                                                                                                                                                                                                                                            options: TrieSearchOptions;
                                                                                                                                                                                                                                                                                            phrases: string | Iterable<string>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Data provided when resetting reducers.

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_search_trie.TrieSearchSubscribeHandler.html b/docs/types/_runtime_data_struct_search_trie.TrieSearchSubscribeHandler.html index d4268a50..8d74c069 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieSearchSubscribeHandler.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieSearchSubscribeHandler.html @@ -1,2 +1,3 @@ -TrieSearchSubscribeHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TrieSearchSubscribeHandler<T>

                                                                                                                                                                                                                                                                                        TrieSearchSubscribeHandler<T>: (({ action, trieSearch }) => unknown)

                                                                                                                                                                                                                                                                                        Defines the readable store subscriber / handler function.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T extends object

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                          • ({ action, trieSearch }): unknown

                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                            • { action, trieSearch }: {
                                                                                                                                                                                                                                                                                                  action?: "add" | "clear" | "destroy" | "subscribe";
                                                                                                                                                                                                                                                                                                  trieSearch?: TrieSearch<T>;
                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                              • Optional action?: "add" | "clear" | "destroy" | "subscribe"
                                                                                                                                                                                                                                                                                              • Optional trieSearch?: TrieSearch<T>

                                                                                                                                                                                                                                                                                            Returns unknown

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +TrieSearchSubscribeHandler | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias TrieSearchSubscribeHandler<T>

                                                                                                                                                                                                                                                                                        TrieSearchSubscribeHandler<T>: (({ action, trieSearch }: {
                                                                                                                                                                                                                                                                                            action?:
                                                                                                                                                                                                                                                                                                | "add"
                                                                                                                                                                                                                                                                                                | "clear"
                                                                                                                                                                                                                                                                                                | "destroy"
                                                                                                                                                                                                                                                                                                | "subscribe";
                                                                                                                                                                                                                                                                                            trieSearch?: TrieSearch<T>;
                                                                                                                                                                                                                                                                                        }) => unknown)

                                                                                                                                                                                                                                                                                        Defines the readable store subscriber / handler function.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T extends object

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_data_struct_search_trie_query.TrieSearchQueryOptions.html b/docs/types/_runtime_data_struct_search_trie_query.TrieSearchQueryOptions.html index 20cdddad..3c3236a7 100644 --- a/docs/types/_runtime_data_struct_search_trie_query.TrieSearchQueryOptions.html +++ b/docs/types/_runtime_data_struct_search_trie_query.TrieSearchQueryOptions.html @@ -1,4 +1,5 @@ -TrieSearchQueryOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TrieSearchQueryOptions<T>

                                                                                                                                                                                                                                                                                        TrieSearchQueryOptions<T>: {
                                                                                                                                                                                                                                                                                            limit?: number;
                                                                                                                                                                                                                                                                                            trieReducer?: ITrieSearchReducer<T>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Options for TrieSearchQuery.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T extends object

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional limit?: number

                                                                                                                                                                                                                                                                                          The initial limit on search results.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional trieReducer?: ITrieSearchReducer<T>

                                                                                                                                                                                                                                                                                          An initial trie reducer instance to set.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +TrieSearchQueryOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias TrieSearchQueryOptions<T>

                                                                                                                                                                                                                                                                                        TrieSearchQueryOptions<T>: {
                                                                                                                                                                                                                                                                                            limit?: number;
                                                                                                                                                                                                                                                                                            trieReducer?: ITrieSearchReducer<T>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Options for TrieSearchQuery.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Parameters

                                                                                                                                                                                                                                                                                        • T extends object

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optionallimit?: number

                                                                                                                                                                                                                                                                                          The initial limit on search results.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • OptionaltrieReducer?: ITrieSearchReducer<T>

                                                                                                                                                                                                                                                                                          An initial trie reducer instance to set.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.FloatArray.html b/docs/types/_runtime_math_gl_matrix.FloatArray.html new file mode 100644 index 00000000..9b04eba1 --- /dev/null +++ b/docs/types/_runtime_math_gl_matrix.FloatArray.html @@ -0,0 +1,3 @@ +FloatArray | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias FloatArray

                                                                                                                                                                                                                                                                                        FloatArray: Float32Array | Float64Array

                                                                                                                                                                                                                                                                                        The floating-point typed arrays that can be used in place of a vector, matrix, or quaternion.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.Mat2Like.html b/docs/types/_runtime_math_gl_matrix.Mat2Like.html index fa447d25..83d7dcf6 100644 --- a/docs/types/_runtime_math_gl_matrix.Mat2Like.html +++ b/docs/types/_runtime_math_gl_matrix.Mat2Like.html @@ -1,3 +1,3 @@ -Mat2Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Mat2Like

                                                                                                                                                                                                                                                                                        Mat2Like: [number, number, number, number] | Float32Array

                                                                                                                                                                                                                                                                                        A 2x2 Matrix given as a Mat2, a 4-element Float32Array, or an array -of 4 numbers.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Mat2Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Mat2Like

                                                                                                                                                                                                                                                                                        Mat2Like: [number, number, number, number] | FloatArray

                                                                                                                                                                                                                                                                                        A 2x2 Matrix given as a Mat2, a 4-element floating-point TypedArray, or an array of 4 numbers.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.Mat2dLike.html b/docs/types/_runtime_math_gl_matrix.Mat2dLike.html index 4ed5b716..08977132 100644 --- a/docs/types/_runtime_math_gl_matrix.Mat2dLike.html +++ b/docs/types/_runtime_math_gl_matrix.Mat2dLike.html @@ -1,3 +1,3 @@ -Mat2dLike | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Mat2dLike

                                                                                                                                                                                                                                                                                        Mat2dLike: [number, number, number, number, number, number] | Float32Array

                                                                                                                                                                                                                                                                                        A 2x3 Matrix given as a Mat2d, a 6-element Float32Array, or an array -of 6 numbers.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Mat2dLike | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Mat2dLike

                                                                                                                                                                                                                                                                                        Mat2dLike: [number, number, number, number, number, number] | FloatArray

                                                                                                                                                                                                                                                                                        A 2x3 Matrix given as a Mat2d, a 6-element floating-point TypedArray, or an array of 6 numbers.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.Mat3Like.html b/docs/types/_runtime_math_gl_matrix.Mat3Like.html index 26aa8103..b13e9042 100644 --- a/docs/types/_runtime_math_gl_matrix.Mat3Like.html +++ b/docs/types/_runtime_math_gl_matrix.Mat3Like.html @@ -1,3 +1,3 @@ -Mat3Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Mat3Like

                                                                                                                                                                                                                                                                                        Mat3Like: [number, number, number, number, number, number, number, number, number] | Float32Array

                                                                                                                                                                                                                                                                                        A 3x3 Matrix given as a Mat3, a 9-element Float32Array, or an array -of 9 numbers.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Mat3Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Mat3Like

                                                                                                                                                                                                                                                                                        Mat3Like: [number, number, number, number, number, number, number, number, number] | FloatArray

                                                                                                                                                                                                                                                                                        A 3x3 Matrix given as a Mat3, a 9-element floating-point TypedArray, or an array of 9 numbers.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.Mat4Like.html b/docs/types/_runtime_math_gl_matrix.Mat4Like.html index 21509055..014b9a6b 100644 --- a/docs/types/_runtime_math_gl_matrix.Mat4Like.html +++ b/docs/types/_runtime_math_gl_matrix.Mat4Like.html @@ -1,3 +1,3 @@ -Mat4Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Mat4Like

                                                                                                                                                                                                                                                                                        Mat4Like: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number] | Float32Array

                                                                                                                                                                                                                                                                                        A 4x4 Matrix given as a Mat4, a 16-element Float32Array, or an array -of 16 numbers.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Mat4Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Mat4Like

                                                                                                                                                                                                                                                                                        Mat4Like: [number, number, number, number, number, number, number, number, number, number, number, number, number, number, number, number] | FloatArray

                                                                                                                                                                                                                                                                                        A 4x4 Matrix given as a Mat4, a 16-element floating-point TypedArray, or an array of 16 numbers.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.Quat2Like.html b/docs/types/_runtime_math_gl_matrix.Quat2Like.html index b67ad779..523c0e86 100644 --- a/docs/types/_runtime_math_gl_matrix.Quat2Like.html +++ b/docs/types/_runtime_math_gl_matrix.Quat2Like.html @@ -1,3 +1,3 @@ -Quat2Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Quat2Like

                                                                                                                                                                                                                                                                                        Quat2Like: [number, number, number, number, number, number, number, number] | Float32Array

                                                                                                                                                                                                                                                                                        A Dual Quaternion given as a Quat2, an 8-element Float32Array, or -an array of 8 numbers.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Quat2Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Quat2Like

                                                                                                                                                                                                                                                                                        Quat2Like: [number, number, number, number, number, number, number, number] | FloatArray

                                                                                                                                                                                                                                                                                        A Dual Quaternion given as a Quat2, an 8-element floating-point TypedArray, or an array of 8 numbers.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.QuatLike.html b/docs/types/_runtime_math_gl_matrix.QuatLike.html index b6ecac2c..43ab5491 100644 --- a/docs/types/_runtime_math_gl_matrix.QuatLike.html +++ b/docs/types/_runtime_math_gl_matrix.QuatLike.html @@ -1,3 +1,3 @@ -QuatLike | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias QuatLike

                                                                                                                                                                                                                                                                                        QuatLike: Vec4Like

                                                                                                                                                                                                                                                                                        A Quaternion given as a Quat, a 4-element Float32Array, or -an array of 4 numbers.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +QuatLike | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias QuatLike

                                                                                                                                                                                                                                                                                        QuatLike: Vec4Like

                                                                                                                                                                                                                                                                                        A Quaternion given as a Quat, a 4-element floating-point TypedArray, or an array of 4 numbers.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.Vec2Like.html b/docs/types/_runtime_math_gl_matrix.Vec2Like.html index 35040caf..fb199a0e 100644 --- a/docs/types/_runtime_math_gl_matrix.Vec2Like.html +++ b/docs/types/_runtime_math_gl_matrix.Vec2Like.html @@ -1,3 +1,3 @@ -Vec2Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Vec2Like

                                                                                                                                                                                                                                                                                        Vec2Like: [number, number] | Float32Array

                                                                                                                                                                                                                                                                                        A 2 dimensional vector given as a Vec2, a 2-element Float32Array, or -an array of 2 numbers.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Vec2Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Vec2Like

                                                                                                                                                                                                                                                                                        Vec2Like: [number, number] | FloatArray

                                                                                                                                                                                                                                                                                        A 2-dimensional vector given as a Vec2, a 2-element floating-point TypedArray, or an array of 2 numbers.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.Vec3Like.html b/docs/types/_runtime_math_gl_matrix.Vec3Like.html index f202dffd..bca870cd 100644 --- a/docs/types/_runtime_math_gl_matrix.Vec3Like.html +++ b/docs/types/_runtime_math_gl_matrix.Vec3Like.html @@ -1,3 +1,3 @@ -Vec3Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Vec3Like

                                                                                                                                                                                                                                                                                        Vec3Like: [number, number, number] | Float32Array

                                                                                                                                                                                                                                                                                        A 3 dimensional vector given as a Vec3, a 3-element Float32Array, or -an array of 3 numbers.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Vec3Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Vec3Like

                                                                                                                                                                                                                                                                                        Vec3Like: [number, number, number] | FloatArray

                                                                                                                                                                                                                                                                                        A 3-dimensional vector given as a Vec3, a 3-element floating-point TypedArray, or an array of 3 numbers.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_gl_matrix.Vec4Like.html b/docs/types/_runtime_math_gl_matrix.Vec4Like.html index 637d3275..23b27356 100644 --- a/docs/types/_runtime_math_gl_matrix.Vec4Like.html +++ b/docs/types/_runtime_math_gl_matrix.Vec4Like.html @@ -1,3 +1,3 @@ -Vec4Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Vec4Like

                                                                                                                                                                                                                                                                                        Vec4Like: [number, number, number, number] | Float32Array

                                                                                                                                                                                                                                                                                        A 4 dimensional vector given as a Vec4, a 4-element Float32Array, or -an array of 4 numbers.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Vec4Like | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Vec4Like

                                                                                                                                                                                                                                                                                        Vec4Like: [number, number, number, number] | FloatArray

                                                                                                                                                                                                                                                                                        A 4-dimensional vector given as a Vec4, a 4-element floating-point TypedArray, or an array of 4 numbers.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_math_interpolate.InterpolateFunctionName.html b/docs/types/_runtime_math_interpolate.InterpolateFunctionName.html index 260ab0ce..4d61e367 100644 --- a/docs/types/_runtime_math_interpolate.InterpolateFunctionName.html +++ b/docs/types/_runtime_math_interpolate.InterpolateFunctionName.html @@ -1,2 +1,3 @@ -InterpolateFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias InterpolateFunctionName

                                                                                                                                                                                                                                                                                        InterpolateFunctionName: "lerp"

                                                                                                                                                                                                                                                                                        Defines the supported interpolation function names.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +InterpolateFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias InterpolateFunctionName

                                                                                                                                                                                                                                                                                        InterpolateFunctionName: "lerp"

                                                                                                                                                                                                                                                                                        Defines the supported interpolation function names.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager.DataOutPluginEnabled.html b/docs/types/_runtime_plugin_manager.DataOutPluginEnabled.html index 4afe50d2..2972f14e 100644 --- a/docs/types/_runtime_plugin_manager.DataOutPluginEnabled.html +++ b/docs/types/_runtime_plugin_manager.DataOutPluginEnabled.html @@ -1,5 +1,6 @@ -DataOutPluginEnabled | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias DataOutPluginEnabled

                                                                                                                                                                                                                                                                                        DataOutPluginEnabled: {
                                                                                                                                                                                                                                                                                            enabled: boolean;
                                                                                                                                                                                                                                                                                            loaded: boolean;
                                                                                                                                                                                                                                                                                            plugin: string;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager 'getEnabled' return object format.

                                                                                                                                                                                                                                                                                        +DataOutPluginEnabled | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias DataOutPluginEnabled

                                                                                                                                                                                                                                                                                        DataOutPluginEnabled: {
                                                                                                                                                                                                                                                                                            enabled: boolean;
                                                                                                                                                                                                                                                                                            loaded: boolean;
                                                                                                                                                                                                                                                                                            plugin: string;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager 'getEnabled' return object format.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • enabled: boolean

                                                                                                                                                                                                                                                                                          The enabled state of the plugin.

                                                                                                                                                                                                                                                                                        • loaded: boolean

                                                                                                                                                                                                                                                                                          True if the plugin is actually loaded.

                                                                                                                                                                                                                                                                                        • plugin: string

                                                                                                                                                                                                                                                                                          The plugin name.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager.DataOutPluginEvents.html b/docs/types/_runtime_plugin_manager.DataOutPluginEvents.html index c8ee4a76..411f42a4 100644 --- a/docs/types/_runtime_plugin_manager.DataOutPluginEvents.html +++ b/docs/types/_runtime_plugin_manager.DataOutPluginEvents.html @@ -1,4 +1,5 @@ -DataOutPluginEvents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias DataOutPluginEvents

                                                                                                                                                                                                                                                                                        DataOutPluginEvents: {
                                                                                                                                                                                                                                                                                            events: string[];
                                                                                                                                                                                                                                                                                            plugin: string;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager 'getPluginEvents' / 'getPluginByEvent' return object format.

                                                                                                                                                                                                                                                                                        +DataOutPluginEvents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias DataOutPluginEvents

                                                                                                                                                                                                                                                                                        DataOutPluginEvents: {
                                                                                                                                                                                                                                                                                            events: string[];
                                                                                                                                                                                                                                                                                            plugin: string;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager 'getPluginEvents' / 'getPluginByEvent' return object format.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • events: string[]

                                                                                                                                                                                                                                                                                          The event names registered.

                                                                                                                                                                                                                                                                                        • plugin: string

                                                                                                                                                                                                                                                                                          The plugin name.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager.DataOutPluginRemoved.html b/docs/types/_runtime_plugin_manager.DataOutPluginRemoved.html index b2ce062d..6c7c99c5 100644 --- a/docs/types/_runtime_plugin_manager.DataOutPluginRemoved.html +++ b/docs/types/_runtime_plugin_manager.DataOutPluginRemoved.html @@ -1,5 +1,6 @@ -DataOutPluginRemoved | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias DataOutPluginRemoved

                                                                                                                                                                                                                                                                                        DataOutPluginRemoved: {
                                                                                                                                                                                                                                                                                            errors: Error[];
                                                                                                                                                                                                                                                                                            plugin: string;
                                                                                                                                                                                                                                                                                            success: boolean;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager 'remove' return object format.

                                                                                                                                                                                                                                                                                        +DataOutPluginRemoved | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias DataOutPluginRemoved

                                                                                                                                                                                                                                                                                        DataOutPluginRemoved: {
                                                                                                                                                                                                                                                                                            errors: Error[];
                                                                                                                                                                                                                                                                                            plugin: string;
                                                                                                                                                                                                                                                                                            success: boolean;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager 'remove' return object format.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • errors: Error[]

                                                                                                                                                                                                                                                                                          A list of errors that may have been thrown during removal.

                                                                                                                                                                                                                                                                                        • plugin: string

                                                                                                                                                                                                                                                                                          The plugin name.

                                                                                                                                                                                                                                                                                        • success: boolean

                                                                                                                                                                                                                                                                                          The success state for removal.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager.PluginConfig.html b/docs/types/_runtime_plugin_manager.PluginConfig.html index 44a75713..cb6e98dc 100644 --- a/docs/types/_runtime_plugin_manager.PluginConfig.html +++ b/docs/types/_runtime_plugin_manager.PluginConfig.html @@ -1,8 +1,9 @@ -PluginConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias PluginConfig

                                                                                                                                                                                                                                                                                        PluginConfig: {
                                                                                                                                                                                                                                                                                            instance?: object;
                                                                                                                                                                                                                                                                                            name: string;
                                                                                                                                                                                                                                                                                            options?: object;
                                                                                                                                                                                                                                                                                            target?: string | URL;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager 'add' / 'isValidConfig' plugin configuration.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional instance?: object

                                                                                                                                                                                                                                                                                          Defines an existing object instance to use as the plugin.

                                                                                                                                                                                                                                                                                          +PluginConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Alias PluginConfig

                                                                                                                                                                                                                                                                                          PluginConfig: {
                                                                                                                                                                                                                                                                                              instance?: object;
                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                              options?: object;
                                                                                                                                                                                                                                                                                              target?: string | URL;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          PluginManager 'add' / 'isValidConfig' plugin configuration.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • Optionalinstance?: object

                                                                                                                                                                                                                                                                                            Defines an existing object instance to use as the plugin.

                                                                                                                                                                                                                                                                                          • name: string

                                                                                                                                                                                                                                                                                            Defines the name of the plugin; if no target entry is present the name doubles as the target (please see target).

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional options?: object

                                                                                                                                                                                                                                                                                            Defines an object of options for the plugin.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional target?: string | URL

                                                                                                                                                                                                                                                                                            Defines the target Node module to load or defines a local file (full path or +

                                                                                                                                                                                                                                                                                          • Optionaloptions?: object

                                                                                                                                                                                                                                                                                            Defines an object of options for the plugin.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionaltarget?: string | URL

                                                                                                                                                                                                                                                                                            Defines the target Node module to load or defines a local file (full path or relative to current working directory to load. Target may also be a file URL / string or in the browser a web URL.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager.PluginData.html b/docs/types/_runtime_plugin_manager.PluginData.html index a94fd882..e997ae06 100644 --- a/docs/types/_runtime_plugin_manager.PluginData.html +++ b/docs/types/_runtime_plugin_manager.PluginData.html @@ -1,5 +1,6 @@ -PluginData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias PluginData

                                                                                                                                                                                                                                                                                        PluginData: {
                                                                                                                                                                                                                                                                                            manager: {
                                                                                                                                                                                                                                                                                                eventPrepend: string;
                                                                                                                                                                                                                                                                                                scopedName: string;
                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                            module: object;
                                                                                                                                                                                                                                                                                            plugin: {
                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                options: object;
                                                                                                                                                                                                                                                                                                target: string;
                                                                                                                                                                                                                                                                                                targetEscaped: string;
                                                                                                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager plugin data object describes a loaded plugin.

                                                                                                                                                                                                                                                                                        +PluginData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias PluginData

                                                                                                                                                                                                                                                                                        PluginData: {
                                                                                                                                                                                                                                                                                            manager: {
                                                                                                                                                                                                                                                                                                eventPrepend: string;
                                                                                                                                                                                                                                                                                                scopedName: string;
                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                            module: object;
                                                                                                                                                                                                                                                                                            plugin: {
                                                                                                                                                                                                                                                                                                name: string;
                                                                                                                                                                                                                                                                                                options: object;
                                                                                                                                                                                                                                                                                                target: string;
                                                                                                                                                                                                                                                                                                targetEscaped: string;
                                                                                                                                                                                                                                                                                                type: string;
                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager plugin data object describes a loaded plugin.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • manager: {
                                                                                                                                                                                                                                                                                              eventPrepend: string;
                                                                                                                                                                                                                                                                                              scopedName: string;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Data about the plugin manager.

                                                                                                                                                                                                                                                                                          • eventPrepend: string
                                                                                                                                                                                                                                                                                          • scopedName: string
                                                                                                                                                                                                                                                                                        • module: object

                                                                                                                                                                                                                                                                                          Optional object hash to associate with plugin.

                                                                                                                                                                                                                                                                                        • plugin: {
                                                                                                                                                                                                                                                                                              name: string;
                                                                                                                                                                                                                                                                                              options: object;
                                                                                                                                                                                                                                                                                              target: string;
                                                                                                                                                                                                                                                                                              targetEscaped: string;
                                                                                                                                                                                                                                                                                              type: string;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Data about the plugin.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          • name: string
                                                                                                                                                                                                                                                                                          • options: object
                                                                                                                                                                                                                                                                                          • target: string
                                                                                                                                                                                                                                                                                          • targetEscaped: string
                                                                                                                                                                                                                                                                                          • type: string

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                                                                        • name: string
                                                                                                                                                                                                                                                                                        • options: object
                                                                                                                                                                                                                                                                                        • target: string
                                                                                                                                                                                                                                                                                        • targetEscaped: string
                                                                                                                                                                                                                                                                                        • type: string

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager.PluginEventData.html b/docs/types/_runtime_plugin_manager.PluginEventData.html index 513f055d..55cdba1e 100644 --- a/docs/types/_runtime_plugin_manager.PluginEventData.html +++ b/docs/types/_runtime_plugin_manager.PluginEventData.html @@ -1,3 +1,4 @@ -PluginEventData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias PluginEventData

                                                                                                                                                                                                                                                                                        PluginEventData: object

                                                                                                                                                                                                                                                                                        Provides the unified event data including any pass through data to the +PluginEventData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias PluginEventData

                                                                                                                                                                                                                                                                                        PluginEventData: object

                                                                                                                                                                                                                                                                                        Provides the unified event data including any pass through data to the copied data supplied. Invoked functions may add to or modify this data.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager.PluginManagerOptions.html b/docs/types/_runtime_plugin_manager.PluginManagerOptions.html index 999466e5..1398a06a 100644 --- a/docs/types/_runtime_plugin_manager.PluginManagerOptions.html +++ b/docs/types/_runtime_plugin_manager.PluginManagerOptions.html @@ -1,16 +1,17 @@ -PluginManagerOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias PluginManagerOptions

                                                                                                                                                                                                                                                                                        PluginManagerOptions: {
                                                                                                                                                                                                                                                                                            noEventAdd?: boolean;
                                                                                                                                                                                                                                                                                            noEventDestroy?: boolean;
                                                                                                                                                                                                                                                                                            noEventRemoval?: boolean;
                                                                                                                                                                                                                                                                                            noEventSetEnabled?: boolean;
                                                                                                                                                                                                                                                                                            noEventSetOptions?: boolean;
                                                                                                                                                                                                                                                                                            throwNoMethod?: boolean;
                                                                                                                                                                                                                                                                                            throwNoPlugin?: boolean;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        PluginManager options.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional noEventAdd?: boolean

                                                                                                                                                                                                                                                                                          If true this prevents plugins from being added by plugins:add and +PluginManagerOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Alias PluginManagerOptions

                                                                                                                                                                                                                                                                                          PluginManagerOptions: {
                                                                                                                                                                                                                                                                                              noEventAdd?: boolean;
                                                                                                                                                                                                                                                                                              noEventDestroy?: boolean;
                                                                                                                                                                                                                                                                                              noEventRemoval?: boolean;
                                                                                                                                                                                                                                                                                              noEventSetEnabled?: boolean;
                                                                                                                                                                                                                                                                                              noEventSetOptions?: boolean;
                                                                                                                                                                                                                                                                                              throwNoMethod?: boolean;
                                                                                                                                                                                                                                                                                              throwNoPlugin?: boolean;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          PluginManager options.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • OptionalnoEventAdd?: boolean

                                                                                                                                                                                                                                                                                            If true this prevents plugins from being added by plugins:add and plugins:add:all events forcing direct method invocation for addition.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional noEventDestroy?: boolean

                                                                                                                                                                                                                                                                                            If true this prevents the plugin manager from being destroyed by +

                                                                                                                                                                                                                                                                                          • OptionalnoEventDestroy?: boolean

                                                                                                                                                                                                                                                                                            If true this prevents the plugin manager from being destroyed by plugins:destroy:manager forcing direct method invocation for destruction.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional noEventRemoval?: boolean

                                                                                                                                                                                                                                                                                            If true this prevents plugins from being removed by plugins:remove and +

                                                                                                                                                                                                                                                                                          • OptionalnoEventRemoval?: boolean

                                                                                                                                                                                                                                                                                            If true this prevents plugins from being removed by plugins:remove and plugins:remove:all events forcing direct method invocation for removal.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional noEventSetEnabled?: boolean

                                                                                                                                                                                                                                                                                            If true this prevents the plugins from being enabled / disabled +

                                                                                                                                                                                                                                                                                          • OptionalnoEventSetEnabled?: boolean

                                                                                                                                                                                                                                                                                            If true this prevents the plugins from being enabled / disabled from the eventbus via plugins:set:enabled.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional noEventSetOptions?: boolean

                                                                                                                                                                                                                                                                                            If true this prevents setting options for the plugin manager by +

                                                                                                                                                                                                                                                                                          • OptionalnoEventSetOptions?: boolean

                                                                                                                                                                                                                                                                                            If true this prevents setting options for the plugin manager by plugins:set:options forcing direct method invocation for setting options.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional throwNoMethod?: boolean

                                                                                                                                                                                                                                                                                            If true then when a method fails to be invoked by any plugin an exception +

                                                                                                                                                                                                                                                                                          • OptionalthrowNoMethod?: boolean

                                                                                                                                                                                                                                                                                            If true then when a method fails to be invoked by any plugin an exception will be thrown.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional throwNoPlugin?: boolean

                                                                                                                                                                                                                                                                                            If true then when no plugin is matched to be invoked an exception will be +

                                                                                                                                                                                                                                                                                          • OptionalthrowNoPlugin?: boolean

                                                                                                                                                                                                                                                                                            If true then when no plugin is matched to be invoked an exception will be thrown.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager_eventbus.EventData.html b/docs/types/_runtime_plugin_manager_eventbus.EventData.html index 672ef7ff..ccf0a1e6 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventData.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventData.html @@ -1,8 +1,9 @@ -EventData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias EventData

                                                                                                                                                                                                                                                                                        EventData: {
                                                                                                                                                                                                                                                                                            callback: Function;
                                                                                                                                                                                                                                                                                            context: object;
                                                                                                                                                                                                                                                                                            ctx: object;
                                                                                                                                                                                                                                                                                            listening?: object;
                                                                                                                                                                                                                                                                                            options: EventOptionsOut;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        The callback data for an event.

                                                                                                                                                                                                                                                                                        +EventData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias EventData

                                                                                                                                                                                                                                                                                        EventData: {
                                                                                                                                                                                                                                                                                            callback: Function;
                                                                                                                                                                                                                                                                                            context: object;
                                                                                                                                                                                                                                                                                            ctx: object;
                                                                                                                                                                                                                                                                                            listening?: object;
                                                                                                                                                                                                                                                                                            options: EventOptionsOut;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        The callback data for an event.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • callback: Function

                                                                                                                                                                                                                                                                                          Callback function

                                                                                                                                                                                                                                                                                        • context: object

                                                                                                                                                                                                                                                                                          Event context

                                                                                                                                                                                                                                                                                        • ctx: object

                                                                                                                                                                                                                                                                                          Event context or local eventbus instance.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional listening?: object

                                                                                                                                                                                                                                                                                          Any associated listening instance.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • Optionallistening?: object

                                                                                                                                                                                                                                                                                          Any associated listening instance.

                                                                                                                                                                                                                                                                                        • options: EventOptionsOut

                                                                                                                                                                                                                                                                                          Holds options for this event registration, One such option is 'guarded' which prevents multiple registrations.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager_eventbus.EventMap.html b/docs/types/_runtime_plugin_manager_eventbus.EventMap.html index 27cf5dd0..3f083061 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventMap.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventMap.html @@ -1,3 +1,4 @@ -EventMap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias EventMap

                                                                                                                                                                                                                                                                                        EventMap: {
                                                                                                                                                                                                                                                                                            [key: string]: Function;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines multiple events that can be used to registered in one API +EventMap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias EventMap

                                                                                                                                                                                                                                                                                        EventMap: {
                                                                                                                                                                                                                                                                                            [key: string]: Function;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines multiple events that can be used to registered in one API call.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager_eventbus.EventOptions.html b/docs/types/_runtime_plugin_manager_eventbus.EventOptions.html index 406102b0..0bbdb9d9 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventOptions.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventOptions.html @@ -1,7 +1,8 @@ -EventOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias EventOptions

                                                                                                                                                                                                                                                                                        EventOptions: {
                                                                                                                                                                                                                                                                                            guard?: boolean;
                                                                                                                                                                                                                                                                                            type?: "sync" | "async";
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Event registration options.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional guard?: boolean

                                                                                                                                                                                                                                                                                          When set to true this registration is guarded. Further attempts to register an +EventOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Alias EventOptions

                                                                                                                                                                                                                                                                                          EventOptions: {
                                                                                                                                                                                                                                                                                              guard?: boolean;
                                                                                                                                                                                                                                                                                              type?: "sync" | "async";
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Event registration options.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • Optionalguard?: boolean

                                                                                                                                                                                                                                                                                            When set to true this registration is guarded. Further attempts to register an event by the same name will not be possible as long as a guarded event exists with the same name.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional type?: "sync" | "async"

                                                                                                                                                                                                                                                                                            Provides a hint on the trigger type. It may be a string 'sync' or 'async'. +

                                                                                                                                                                                                                                                                                          • Optionaltype?: "sync" | "async"

                                                                                                                                                                                                                                                                                            Provides a hint on the trigger type. It may be a string 'sync' or 'async'. Any other value is not recognized and internally type will be set to undefined. If the callback is a function defined with the async modifier it will automatically be detected as async.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager_eventbus.EventOptionsOut.html b/docs/types/_runtime_plugin_manager_eventbus.EventOptionsOut.html index 80c31f12..1c39d8e1 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventOptionsOut.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventOptionsOut.html @@ -1,4 +1,5 @@ -EventOptionsOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias EventOptionsOut

                                                                                                                                                                                                                                                                                        EventOptionsOut: {
                                                                                                                                                                                                                                                                                            guard: boolean;
                                                                                                                                                                                                                                                                                            type: "async" | "sync" | void;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        The complete options for an event name returned from entries, etc.

                                                                                                                                                                                                                                                                                        +EventOptionsOut | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias EventOptionsOut

                                                                                                                                                                                                                                                                                        EventOptionsOut: {
                                                                                                                                                                                                                                                                                            guard: boolean;
                                                                                                                                                                                                                                                                                            type: "async" | "sync" | void;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        The complete options for an event name returned from entries, etc.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • guard: boolean

                                                                                                                                                                                                                                                                                          The guarded option.

                                                                                                                                                                                                                                                                                        • type: "async" | "sync" | void

                                                                                                                                                                                                                                                                                          The type option.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager_eventbus.EventbusEvents.html b/docs/types/_runtime_plugin_manager_eventbus.EventbusEvents.html index 8cd14fa6..178e4742 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventbusEvents.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventbusEvents.html @@ -1,2 +1,3 @@ -EventbusEvents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias EventbusEvents

                                                                                                                                                                                                                                                                                        EventbusEvents: {
                                                                                                                                                                                                                                                                                            [key: string]: EventData[];
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Event data stored by event name.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +EventbusEvents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias EventbusEvents

                                                                                                                                                                                                                                                                                        EventbusEvents: {
                                                                                                                                                                                                                                                                                            [key: string]: EventData[];
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Event data stored by event name.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_plugin_manager_eventbus.EventbusSecureObj.html b/docs/types/_runtime_plugin_manager_eventbus.EventbusSecureObj.html index 8be9323e..b431cfe5 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventbusSecureObj.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventbusSecureObj.html @@ -1,6 +1,7 @@ -EventbusSecureObj | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias EventbusSecureObj

                                                                                                                                                                                                                                                                                        EventbusSecureObj: {
                                                                                                                                                                                                                                                                                            destroy: Function;
                                                                                                                                                                                                                                                                                            eventbusSecure: EventbusSecure;
                                                                                                                                                                                                                                                                                            setEventbus: ((eventbus, name?) => void);
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        The control object returned by EventbusSecure.initialize.

                                                                                                                                                                                                                                                                                        +EventbusSecureObj | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias EventbusSecureObj

                                                                                                                                                                                                                                                                                        EventbusSecureObj: {
                                                                                                                                                                                                                                                                                            destroy: Function;
                                                                                                                                                                                                                                                                                            eventbusSecure: EventbusSecure;
                                                                                                                                                                                                                                                                                            setEventbus: ((eventbus: Eventbus | EventbusProxy, name?: string) => void);
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        The control object returned by EventbusSecure.initialize.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • destroy: Function

                                                                                                                                                                                                                                                                                          A function which destroys the underlying Eventbus reference.

                                                                                                                                                                                                                                                                                        • eventbusSecure: EventbusSecure

                                                                                                                                                                                                                                                                                          The EventbusSecure instance.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • setEventbus: ((eventbus, name?) => void)

                                                                                                                                                                                                                                                                                          A +

                                                                                                                                                                                                                                                                                        • setEventbus: ((eventbus: Eventbus | EventbusProxy, name?: string) => void)

                                                                                                                                                                                                                                                                                          A function to set the underlying Eventbus reference.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_action_util.DynamicActionOptions.html b/docs/types/_runtime_svelte_action_util.DynamicActionOptions.html index d670814a..8f93bffe 100644 --- a/docs/types/_runtime_svelte_action_util.DynamicActionOptions.html +++ b/docs/types/_runtime_svelte_action_util.DynamicActionOptions.html @@ -1,3 +1,4 @@ -DynamicActionOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias DynamicActionOptions

                                                                                                                                                                                                                                                                                        DynamicActionOptions: undefined | {
                                                                                                                                                                                                                                                                                            action: Action<HTMLElement, unknown>;
                                                                                                                                                                                                                                                                                            data?: unknown;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Options for dynamicAction. Provide the hosted action and any associated data that is passed to the action. +DynamicActionOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias DynamicActionOptions

                                                                                                                                                                                                                                                                                        DynamicActionOptions: undefined | {
                                                                                                                                                                                                                                                                                            action: Action<HTMLElement, unknown>;
                                                                                                                                                                                                                                                                                            data?: unknown;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Options for dynamicAction. Provide the hosted action and any associated data that is passed to the action. You may update the action or data dynamically to apply new actions.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.ApplicationStateData.html b/docs/types/_runtime_svelte_application.ApplicationStateData.html index 4658d54a..18812190 100644 --- a/docs/types/_runtime_svelte_application.ApplicationStateData.html +++ b/docs/types/_runtime_svelte_application.ApplicationStateData.html @@ -1,6 +1,7 @@ -ApplicationStateData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias ApplicationStateData

                                                                                                                                                                                                                                                                                        ApplicationStateData: {
                                                                                                                                                                                                                                                                                            beforeMinimized?: TJSPositionData & {
                                                                                                                                                                                                                                                                                                constraints: {
                                                                                                                                                                                                                                                                                                    maxHeight: string;
                                                                                                                                                                                                                                                                                                    paddingBottom: string;
                                                                                                                                                                                                                                                                                                    paddingTop: string;
                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                            options: SvelteReactiveData;
                                                                                                                                                                                                                                                                                            position: TJSPositionData;
                                                                                                                                                                                                                                                                                            ui: {
                                                                                                                                                                                                                                                                                                minimized: boolean;
                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines common application state including positional data and options generated by the ApplicationState API.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional beforeMinimized?: TJSPositionData & {
                                                                                                                                                                                                                                                                                              constraints: {
                                                                                                                                                                                                                                                                                                  maxHeight: string;
                                                                                                                                                                                                                                                                                                  paddingBottom: string;
                                                                                                                                                                                                                                                                                                  paddingTop: string;
                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Any application saved position state for #beforeMinimized including maximized constraints.

                                                                                                                                                                                                                                                                                          +ApplicationStateData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Alias ApplicationStateData

                                                                                                                                                                                                                                                                                          ApplicationStateData: {
                                                                                                                                                                                                                                                                                              beforeMinimized?: TJSPositionData & {
                                                                                                                                                                                                                                                                                                  constraints: {
                                                                                                                                                                                                                                                                                                      maxHeight: string;
                                                                                                                                                                                                                                                                                                      paddingBottom: string;
                                                                                                                                                                                                                                                                                                      paddingTop: string;
                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                              options: SvelteReactiveData;
                                                                                                                                                                                                                                                                                              position: TJSPositionData;
                                                                                                                                                                                                                                                                                              ui: {
                                                                                                                                                                                                                                                                                                  minimized: boolean;
                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Defines common application state including positional data and options generated by the ApplicationState API.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • OptionalbeforeMinimized?: TJSPositionData & {
                                                                                                                                                                                                                                                                                                constraints: {
                                                                                                                                                                                                                                                                                                    maxHeight: string;
                                                                                                                                                                                                                                                                                                    paddingBottom: string;
                                                                                                                                                                                                                                                                                                    paddingTop: string;
                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Any application saved position state for #beforeMinimized including maximized constraints.

                                                                                                                                                                                                                                                                                          • options: SvelteReactiveData

                                                                                                                                                                                                                                                                                            Common SvelteApplication options.

                                                                                                                                                                                                                                                                                          • position: TJSPositionData

                                                                                                                                                                                                                                                                                            Application position.

                                                                                                                                                                                                                                                                                          • ui: {
                                                                                                                                                                                                                                                                                                minimized: boolean;
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Application UI state.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                            • minimized: boolean

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                                                          • minimized: boolean

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.MountedAppShell.html b/docs/types/_runtime_svelte_application.MountedAppShell.html index 54df1b45..dda72c54 100644 --- a/docs/types/_runtime_svelte_application.MountedAppShell.html +++ b/docs/types/_runtime_svelte_application.MountedAppShell.html @@ -1,5 +1,6 @@ -MountedAppShell | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias MountedAppShell

                                                                                                                                                                                                                                                                                        MountedAppShell: {
                                                                                                                                                                                                                                                                                            elementContent?: HTMLElement;
                                                                                                                                                                                                                                                                                            elementRoot: HTMLElement;
                                                                                                                                                                                                                                                                                            elementTarget?: HTMLElement;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Application shell contract for Svelte components.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.StoreAppOptions.html b/docs/types/_runtime_svelte_application.StoreAppOptions.html index c0552d4c..ad516058 100644 --- a/docs/types/_runtime_svelte_application.StoreAppOptions.html +++ b/docs/types/_runtime_svelte_application.StoreAppOptions.html @@ -1,4 +1,5 @@ -StoreAppOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias StoreAppOptions

                                                                                                                                                                                                                                                                                        StoreAppOptions: {
                                                                                                                                                                                                                                                                                            draggable: Writable<boolean>;
                                                                                                                                                                                                                                                                                            focusAuto: Writable<boolean>;
                                                                                                                                                                                                                                                                                            focusKeep: Writable<boolean>;
                                                                                                                                                                                                                                                                                            focusTrap: Writable<boolean>;
                                                                                                                                                                                                                                                                                            headerButtonNoClose: Writable<boolean>;
                                                                                                                                                                                                                                                                                            headerButtonNoLabel: Writable<boolean>;
                                                                                                                                                                                                                                                                                            headerIcon: Writable<string>;
                                                                                                                                                                                                                                                                                            headerNoTitleMinimized: Writable<boolean>;
                                                                                                                                                                                                                                                                                            minimizable: Writable<boolean>;
                                                                                                                                                                                                                                                                                            popOut: Writable<boolean>;
                                                                                                                                                                                                                                                                                            positionable: Writable<boolean>;
                                                                                                                                                                                                                                                                                            resizable: Writable<boolean>;
                                                                                                                                                                                                                                                                                            subscribe: Readable<object>;
                                                                                                                                                                                                                                                                                            title: Writable<string>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Provides a custom readable Svelte store for Application options state.

                                                                                                                                                                                                                                                                                        +StoreAppOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias StoreAppOptions

                                                                                                                                                                                                                                                                                        StoreAppOptions: {
                                                                                                                                                                                                                                                                                            draggable: Writable<boolean>;
                                                                                                                                                                                                                                                                                            focusAuto: Writable<boolean>;
                                                                                                                                                                                                                                                                                            focusKeep: Writable<boolean>;
                                                                                                                                                                                                                                                                                            focusTrap: Writable<boolean>;
                                                                                                                                                                                                                                                                                            headerButtonNoClose: Writable<boolean>;
                                                                                                                                                                                                                                                                                            headerButtonNoLabel: Writable<boolean>;
                                                                                                                                                                                                                                                                                            headerIcon: Writable<string>;
                                                                                                                                                                                                                                                                                            headerNoTitleMinimized: Writable<boolean>;
                                                                                                                                                                                                                                                                                            minimizable: Writable<boolean>;
                                                                                                                                                                                                                                                                                            popOut: Writable<boolean>;
                                                                                                                                                                                                                                                                                            positionable: Writable<boolean>;
                                                                                                                                                                                                                                                                                            resizable: Writable<boolean>;
                                                                                                                                                                                                                                                                                            subscribe: Readable<object>;
                                                                                                                                                                                                                                                                                            title: Writable<string>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Provides a custom readable Svelte store for Application options state.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • draggable: Writable<boolean>

                                                                                                                                                                                                                                                                                          Derived store for draggable updates.

                                                                                                                                                                                                                                                                                        • focusAuto: Writable<boolean>

                                                                                                                                                                                                                                                                                          Derived store for focusAuto updates.

                                                                                                                                                                                                                                                                                        • focusKeep: Writable<boolean>

                                                                                                                                                                                                                                                                                          Derived store for focusKeep updates.

                                                                                                                                                                                                                                                                                          @@ -13,4 +14,4 @@
                                                                                                                                                                                                                                                                                        • resizable: Writable<boolean>

                                                                                                                                                                                                                                                                                          Derived store for resizable updates.

                                                                                                                                                                                                                                                                                        • subscribe: Readable<object>

                                                                                                                                                                                                                                                                                          Subscribe to all app options updates.

                                                                                                                                                                                                                                                                                        • title: Writable<string>

                                                                                                                                                                                                                                                                                          Derived store for title updates.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.StoreUIOptions.html b/docs/types/_runtime_svelte_application.StoreUIOptions.html index 9154d12a..22809a10 100644 --- a/docs/types/_runtime_svelte_application.StoreUIOptions.html +++ b/docs/types/_runtime_svelte_application.StoreUIOptions.html @@ -1,7 +1,8 @@ -StoreUIOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias StoreUIOptions

                                                                                                                                                                                                                                                                                        StoreUIOptions: {
                                                                                                                                                                                                                                                                                            dragging: Writable<boolean>;
                                                                                                                                                                                                                                                                                            headerButtons: Readable<globalThis.ApplicationHeaderButton[]>;
                                                                                                                                                                                                                                                                                            minimized: Readable<boolean>;
                                                                                                                                                                                                                                                                                            resizing: Writable<boolean>;
                                                                                                                                                                                                                                                                                            subscribe: Readable<object>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Provides a custom readable Svelte store for UI options state.

                                                                                                                                                                                                                                                                                        +StoreUIOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias StoreUIOptions

                                                                                                                                                                                                                                                                                        StoreUIOptions: {
                                                                                                                                                                                                                                                                                            dragging: Writable<boolean>;
                                                                                                                                                                                                                                                                                            headerButtons: Readable<globalThis.ApplicationHeaderButton[]>;
                                                                                                                                                                                                                                                                                            minimized: Readable<boolean>;
                                                                                                                                                                                                                                                                                            resizing: Writable<boolean>;
                                                                                                                                                                                                                                                                                            subscribe: Readable<object>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Provides a custom readable Svelte store for UI options state.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.SvelteApplicationOptions.html b/docs/types/_runtime_svelte_application.SvelteApplicationOptions.html index 64e4798a..372e8e0a 100644 --- a/docs/types/_runtime_svelte_application.SvelteApplicationOptions.html +++ b/docs/types/_runtime_svelte_application.SvelteApplicationOptions.html @@ -1,32 +1,33 @@ -SvelteApplicationOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias SvelteApplicationOptions

                                                                                                                                                                                                                                                                                        SvelteApplicationOptions: {
                                                                                                                                                                                                                                                                                            defaultCloseAnimation?: boolean;
                                                                                                                                                                                                                                                                                            draggable?: boolean;
                                                                                                                                                                                                                                                                                            focusAuto?: boolean;
                                                                                                                                                                                                                                                                                            focusKeep?: boolean;
                                                                                                                                                                                                                                                                                            focusSource?: A11yFocusSource;
                                                                                                                                                                                                                                                                                            focusTrap?: boolean;
                                                                                                                                                                                                                                                                                            headerButtonNoClose?: boolean;
                                                                                                                                                                                                                                                                                            headerButtonNoLabel?: boolean;
                                                                                                                                                                                                                                                                                            headerIcon?: string;
                                                                                                                                                                                                                                                                                            headerNoTitleMinimized?: boolean;
                                                                                                                                                                                                                                                                                            minHeight?: number;
                                                                                                                                                                                                                                                                                            minWidth?: number;
                                                                                                                                                                                                                                                                                            positionInitial?: InitialSystem;
                                                                                                                                                                                                                                                                                            positionOrtho?: boolean;
                                                                                                                                                                                                                                                                                            positionValidator?: any;
                                                                                                                                                                                                                                                                                            positionable?: boolean;
                                                                                                                                                                                                                                                                                            sessionStorage?: TJSWebStorage;
                                                                                                                                                                                                                                                                                            svelte?: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                            transformOrigin?: TransformOrigin;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Options for SvelteApplication. Note: that this extends the Foundry +SvelteApplicationOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias SvelteApplicationOptions

                                                                                                                                                                                                                                                                                        SvelteApplicationOptions: {
                                                                                                                                                                                                                                                                                            defaultCloseAnimation?: boolean;
                                                                                                                                                                                                                                                                                            draggable?: boolean;
                                                                                                                                                                                                                                                                                            focusAuto?: boolean;
                                                                                                                                                                                                                                                                                            focusKeep?: boolean;
                                                                                                                                                                                                                                                                                            focusSource?: A11yFocusSource;
                                                                                                                                                                                                                                                                                            focusTrap?: boolean;
                                                                                                                                                                                                                                                                                            headerButtonNoClose?: boolean;
                                                                                                                                                                                                                                                                                            headerButtonNoLabel?: boolean;
                                                                                                                                                                                                                                                                                            headerIcon?: string;
                                                                                                                                                                                                                                                                                            headerNoTitleMinimized?: boolean;
                                                                                                                                                                                                                                                                                            minHeight?: number;
                                                                                                                                                                                                                                                                                            minWidth?: number;
                                                                                                                                                                                                                                                                                            positionable?: boolean;
                                                                                                                                                                                                                                                                                            positionInitial?: InitialSystem;
                                                                                                                                                                                                                                                                                            positionOrtho?: boolean;
                                                                                                                                                                                                                                                                                            positionValidator?: any;
                                                                                                                                                                                                                                                                                            sessionStorage?: TJSWebStorage;
                                                                                                                                                                                                                                                                                            svelte?: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                            transformOrigin?: TransformOrigin;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Options for SvelteApplication. Note: that this extends the Foundry ApplicationOptions.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional defaultCloseAnimation?: boolean

                                                                                                                                                                                                                                                                                          If false the default slide close animation is not run.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional draggable?: boolean

                                                                                                                                                                                                                                                                                          If true then application shells are draggable.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional focusAuto?: boolean

                                                                                                                                                                                                                                                                                          When true auto-management of app focus is enabled.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional focusKeep?: boolean

                                                                                                                                                                                                                                                                                          When focusAuto and focusKeep is true; keeps internal focus.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional focusSource?: A11yFocusSource
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • OptionaldefaultCloseAnimation?: boolean

                                                                                                                                                                                                                                                                                            If false the default slide close animation is not run.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionaldraggable?: boolean

                                                                                                                                                                                                                                                                                            If true then application shells are draggable.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalfocusAuto?: boolean

                                                                                                                                                                                                                                                                                            When true auto-management of app focus is enabled.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalfocusKeep?: boolean

                                                                                                                                                                                                                                                                                            When focusAuto and focusKeep is true; keeps internal focus.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalfocusSource?: A11yFocusSource
                                                                                                                                                                                                                                                                                            • Defines A11yHelper focus source to apply when application closes.
                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional focusTrap?: boolean

                                                                                                                                                                                                                                                                                            When true focus trapping / wrapping is enabled keeping focus inside app.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional headerButtonNoClose?: boolean

                                                                                                                                                                                                                                                                                            If true then the close header button is removed.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional headerButtonNoLabel?: boolean

                                                                                                                                                                                                                                                                                            If true then header button labels are removed.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional headerIcon?: string

                                                                                                                                                                                                                                                                                            Sets a header icon given an image URL.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional headerNoTitleMinimized?: boolean

                                                                                                                                                                                                                                                                                            If true then header title is hidden when minimized.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional minHeight?: number

                                                                                                                                                                                                                                                                                            Assigned to position. Number specifying minimum +

                                                                                                                                                                                                                                                                                          • OptionalfocusTrap?: boolean

                                                                                                                                                                                                                                                                                            When true focus trapping / wrapping is enabled keeping focus inside app.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalheaderButtonNoClose?: boolean

                                                                                                                                                                                                                                                                                            If true then the close header button is removed.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalheaderButtonNoLabel?: boolean

                                                                                                                                                                                                                                                                                            If true then header button labels are removed.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalheaderIcon?: string

                                                                                                                                                                                                                                                                                            Sets a header icon given an image URL.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalheaderNoTitleMinimized?: boolean

                                                                                                                                                                                                                                                                                            If true then header title is hidden when minimized.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalminHeight?: number

                                                                                                                                                                                                                                                                                            Assigned to position. Number specifying minimum window height.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional minWidth?: number

                                                                                                                                                                                                                                                                                            Assigned to position. Number specifying minimum +

                                                                                                                                                                                                                                                                                          • OptionalminWidth?: number

                                                                                                                                                                                                                                                                                            Assigned to position. Number specifying minimum window width.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional positionInitial?: InitialSystem

                                                                                                                                                                                                                                                                                            A helper for +

                                                                                                                                                                                                                                                                                          • Optionalpositionable?: boolean

                                                                                                                                                                                                                                                                                            If false then position.set does not take effect.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalpositionInitial?: InitialSystem

                                                                                                                                                                                                                                                                                            A helper for initial position placement.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional positionOrtho?: boolean

                                                                                                                                                                                                                                                                                            When true TJSPosition is optimized for orthographic use.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional positionValidator?: any

                                                                                                                                                                                                                                                                                            A validator +

                                                                                                                                                                                                                                                                                          • OptionalpositionOrtho?: boolean

                                                                                                                                                                                                                                                                                            When true TJSPosition is optimized for orthographic use.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalpositionValidator?: any

                                                                                                                                                                                                                                                                                            A validator function or data or list of validators.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional positionable?: boolean

                                                                                                                                                                                                                                                                                            If false then position.set does not take effect.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional sessionStorage?: TJSWebStorage

                                                                                                                                                                                                                                                                                            An instance of +

                                                                                                                                                                                                                                                                                          • OptionalsessionStorage?: TJSWebStorage

                                                                                                                                                                                                                                                                                            An instance of TJSWebStorage (session) to share across SvelteApplications.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional svelte?: TJSSvelteConfig

                                                                                                                                                                                                                                                                                            A Svelte configuration object defining +

                                                                                                                                                                                                                                                                                          • Optionalsvelte?: TJSSvelteConfig

                                                                                                                                                                                                                                                                                            A Svelte configuration object defining the main component.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional transformOrigin?: TransformOrigin

                                                                                                                                                                                                                                                                                            By +

                                                                                                                                                                                                                                                                                          • OptionaltransformOrigin?: TransformOrigin

                                                                                                                                                                                                                                                                                            By default, 'top / left' respects rotation when minimizing.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.SvelteData.html b/docs/types/_runtime_svelte_application.SvelteData.html index 2d7faf5e..9818a823 100644 --- a/docs/types/_runtime_svelte_application.SvelteData.html +++ b/docs/types/_runtime_svelte_application.SvelteData.html @@ -1,5 +1,6 @@ -SvelteData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias SvelteData

                                                                                                                                                                                                                                                                                        SvelteData: {
                                                                                                                                                                                                                                                                                            component: SvelteComponent;
                                                                                                                                                                                                                                                                                            config: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                            element: HTMLElement;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Provides access to a mounted Svelte component.

                                                                                                                                                                                                                                                                                        +SvelteData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias SvelteData

                                                                                                                                                                                                                                                                                        SvelteData: {
                                                                                                                                                                                                                                                                                            component: SvelteComponent;
                                                                                                                                                                                                                                                                                            config: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                            element: HTMLElement;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Provides access to a mounted Svelte component.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.SvelteReactiveData.html b/docs/types/_runtime_svelte_application.SvelteReactiveData.html index fb8e8e5a..e0488eaf 100644 --- a/docs/types/_runtime_svelte_application.SvelteReactiveData.html +++ b/docs/types/_runtime_svelte_application.SvelteReactiveData.html @@ -1,4 +1,5 @@ -SvelteReactiveData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias SvelteReactiveData

                                                                                                                                                                                                                                                                                        SvelteReactiveData: {
                                                                                                                                                                                                                                                                                            draggable: boolean;
                                                                                                                                                                                                                                                                                            focusAuto: boolean;
                                                                                                                                                                                                                                                                                            focusKeep: boolean;
                                                                                                                                                                                                                                                                                            focusTrap: boolean;
                                                                                                                                                                                                                                                                                            headerButtonNoClose: boolean;
                                                                                                                                                                                                                                                                                            headerButtonNoLabel: boolean;
                                                                                                                                                                                                                                                                                            headerNoTitleMinimized: boolean;
                                                                                                                                                                                                                                                                                            minimizable: boolean;
                                                                                                                                                                                                                                                                                            positionable: boolean;
                                                                                                                                                                                                                                                                                            resizable: boolean;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines the bulk serializable data from SvelteReactive.toJSON for common application state.

                                                                                                                                                                                                                                                                                        +SvelteReactiveData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias SvelteReactiveData

                                                                                                                                                                                                                                                                                        SvelteReactiveData: {
                                                                                                                                                                                                                                                                                            draggable: boolean;
                                                                                                                                                                                                                                                                                            focusAuto: boolean;
                                                                                                                                                                                                                                                                                            focusKeep: boolean;
                                                                                                                                                                                                                                                                                            focusTrap: boolean;
                                                                                                                                                                                                                                                                                            headerButtonNoClose: boolean;
                                                                                                                                                                                                                                                                                            headerButtonNoLabel: boolean;
                                                                                                                                                                                                                                                                                            headerNoTitleMinimized: boolean;
                                                                                                                                                                                                                                                                                            minimizable: boolean;
                                                                                                                                                                                                                                                                                            positionable: boolean;
                                                                                                                                                                                                                                                                                            resizable: boolean;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines the bulk serializable data from SvelteReactive.toJSON for common application state.

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • draggable: boolean

                                                                                                                                                                                                                                                                                          If true then application shells are draggable.

                                                                                                                                                                                                                                                                                        • focusAuto: boolean

                                                                                                                                                                                                                                                                                          When true auto-management of app focus is enabled.

                                                                                                                                                                                                                                                                                        • focusKeep: boolean

                                                                                                                                                                                                                                                                                          When focusAuto and focusKeep is true; keeps internal focus.

                                                                                                                                                                                                                                                                                          @@ -9,4 +10,4 @@
                                                                                                                                                                                                                                                                                        • minimizable: boolean

                                                                                                                                                                                                                                                                                          If true then application shells are minimizable.

                                                                                                                                                                                                                                                                                        • positionable: boolean

                                                                                                                                                                                                                                                                                          If false then position.set does not take effect.

                                                                                                                                                                                                                                                                                        • resizable: boolean

                                                                                                                                                                                                                                                                                          If true then application shells are resizable.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.TJSDialogButtonData.html b/docs/types/_runtime_svelte_application.TJSDialogButtonData.html index 8b395daf..4719a176 100644 --- a/docs/types/_runtime_svelte_application.TJSDialogButtonData.html +++ b/docs/types/_runtime_svelte_application.TJSDialogButtonData.html @@ -1,9 +1,10 @@ -TJSDialogButtonData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TJSDialogButtonData

                                                                                                                                                                                                                                                                                        TJSDialogButtonData: {
                                                                                                                                                                                                                                                                                            autoClose?: boolean;
                                                                                                                                                                                                                                                                                            condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                            icon?: string;
                                                                                                                                                                                                                                                                                            label?: string;
                                                                                                                                                                                                                                                                                            onPress?: string | ((data?) => any);
                                                                                                                                                                                                                                                                                            styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        TJSDialog button data.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional autoClose?: boolean

                                                                                                                                                                                                                                                                                          When false the dialog does not automatically close when button selected; default: true.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional condition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                          Determines if the button is accessible providing a truthy value.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional icon?: string

                                                                                                                                                                                                                                                                                          Button icon; you should supply the direct Font Awesome class names: IE "fas fa-check".

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional label?: string

                                                                                                                                                                                                                                                                                          Button label; will be localized.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional onPress?: string | ((data?) => any)

                                                                                                                                                                                                                                                                                          Callback for button press. When defined as a string any matching function by name exported from content Svelte +TJSDialogButtonData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Alias TJSDialogButtonData

                                                                                                                                                                                                                                                                                          TJSDialogButtonData: {
                                                                                                                                                                                                                                                                                              autoClose?: boolean;
                                                                                                                                                                                                                                                                                              condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                              icon?: string;
                                                                                                                                                                                                                                                                                              label?: string;
                                                                                                                                                                                                                                                                                              onPress?: string | ((data?: {
                                                                                                                                                                                                                                                                                                  application?: TJSDialog;
                                                                                                                                                                                                                                                                                              }) => any);
                                                                                                                                                                                                                                                                                              styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          TJSDialog button data.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • OptionalautoClose?: boolean

                                                                                                                                                                                                                                                                                            When false the dialog does not automatically close when button selected; default: true.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionalcondition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                            Determines if the button is accessible providing a truthy value.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionalicon?: string

                                                                                                                                                                                                                                                                                            Button icon; you should supply the direct Font Awesome class names: IE "fas fa-check".

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionallabel?: string

                                                                                                                                                                                                                                                                                            Button label; will be localized.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalonPress?: string | ((data?: {
                                                                                                                                                                                                                                                                                                application?: TJSDialog;
                                                                                                                                                                                                                                                                                            }) => any)

                                                                                                                                                                                                                                                                                            Callback for button press. When defined as a string any matching function by name exported from content Svelte component is invoked.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional styles?: Record<string, string>

                                                                                                                                                                                                                                                                                            Inline styles to apply to the button.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          \ No newline at end of file +
                                                                                                                                                                                                                                                                                        • Optionalstyles?: Record<string, string>

                                                                                                                                                                                                                                                                                          Inline styles to apply to the button.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.TJSDialogModalOptions.html b/docs/types/_runtime_svelte_application.TJSDialogModalOptions.html index 891c2350..f20414bd 100644 --- a/docs/types/_runtime_svelte_application.TJSDialogModalOptions.html +++ b/docs/types/_runtime_svelte_application.TJSDialogModalOptions.html @@ -1,8 +1,9 @@ -TJSDialogModalOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TJSDialogModalOptions

                                                                                                                                                                                                                                                                                        TJSDialogModalOptions: {
                                                                                                                                                                                                                                                                                            background?: string;
                                                                                                                                                                                                                                                                                            closeOnInput?: boolean;
                                                                                                                                                                                                                                                                                            slotSeparate?: boolean;
                                                                                                                                                                                                                                                                                            styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                            transition?: TJSDialogTransitionOptions;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines additional modal options to control the display of the modal dialog and glasspane.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional background?: string

                                                                                                                                                                                                                                                                                          CSS background style for glasspane.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional closeOnInput?: boolean

                                                                                                                                                                                                                                                                                          When true modal dialog is closed on any click / pointer down event on the glasspane.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional slotSeparate?: boolean

                                                                                                                                                                                                                                                                                          Creates a separate DIV element container for slot content.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional styles?: Record<string, string>

                                                                                                                                                                                                                                                                                          Custom styles applied to glasspane. Provide an object with CSS style properties with keys in kebab case.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          See

                                                                                                                                                                                                                                                                                          https://www.w3.org/Style/CSS/all-properties.en.html

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional transition?: TJSDialogTransitionOptions

                                                                                                                                                                                                                                                                                          Custom transition options for modal background / glasspane.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +TJSDialogModalOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias TJSDialogModalOptions

                                                                                                                                                                                                                                                                                        TJSDialogModalOptions: {
                                                                                                                                                                                                                                                                                            background?: string;
                                                                                                                                                                                                                                                                                            closeOnInput?: boolean;
                                                                                                                                                                                                                                                                                            slotSeparate?: boolean;
                                                                                                                                                                                                                                                                                            styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                            transition?: TJSDialogTransitionOptions;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines additional modal options to control the display of the modal dialog and glasspane.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optionalbackground?: string

                                                                                                                                                                                                                                                                                          CSS background style for glasspane.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • OptionalcloseOnInput?: boolean

                                                                                                                                                                                                                                                                                          When true modal dialog is closed on any click / pointer down event on the glasspane.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • OptionalslotSeparate?: boolean

                                                                                                                                                                                                                                                                                          Creates a separate DIV element container for slot content.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • Optionalstyles?: Record<string, string>

                                                                                                                                                                                                                                                                                          Custom styles applied to glasspane. Provide an object with CSS style properties with keys in kebab case.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          See

                                                                                                                                                                                                                                                                                          https://www.w3.org/Style/CSS/all-properties.en.html

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • Optionaltransition?: TJSDialogTransitionOptions

                                                                                                                                                                                                                                                                                          Custom transition options for modal background / glasspane.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.TJSDialogOptions.html b/docs/types/_runtime_svelte_application.TJSDialogOptions.html index 74722744..749a667f 100644 --- a/docs/types/_runtime_svelte_application.TJSDialogOptions.html +++ b/docs/types/_runtime_svelte_application.TJSDialogOptions.html @@ -1,26 +1,27 @@ -TJSDialogOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TJSDialogOptions

                                                                                                                                                                                                                                                                                        TJSDialogOptions: {
                                                                                                                                                                                                                                                                                            buttons?: Record<string, TJSDialogButtonData>;
                                                                                                                                                                                                                                                                                            content?: TJSSvelteConfig | string;
                                                                                                                                                                                                                                                                                            default?: string;
                                                                                                                                                                                                                                                                                            draggable?: boolean;
                                                                                                                                                                                                                                                                                            focusAuto?: boolean;
                                                                                                                                                                                                                                                                                            focusFirst?: boolean;
                                                                                                                                                                                                                                                                                            focusKeep?: boolean;
                                                                                                                                                                                                                                                                                            focusTrap?: boolean;
                                                                                                                                                                                                                                                                                            minimizable?: boolean;
                                                                                                                                                                                                                                                                                            modal?: boolean;
                                                                                                                                                                                                                                                                                            modalOptions?: TJSDialogModalOptions;
                                                                                                                                                                                                                                                                                            notifyError?: boolean;
                                                                                                                                                                                                                                                                                            onClose?: string | ((data?) => any);
                                                                                                                                                                                                                                                                                            rejectClose?: boolean;
                                                                                                                                                                                                                                                                                            resizable?: boolean;
                                                                                                                                                                                                                                                                                            resolveId?: boolean;
                                                                                                                                                                                                                                                                                            title?: string;
                                                                                                                                                                                                                                                                                            transition?: TJSDialogTransitionOptions;
                                                                                                                                                                                                                                                                                            zIndex?: number | null;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Defines the common dialog configuration data.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional buttons?: Record<string, TJSDialogButtonData>

                                                                                                                                                                                                                                                                                          Provides configuration of the dialog button bar.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional content?: TJSSvelteConfig | string

                                                                                                                                                                                                                                                                                          A Svelte configuration object or HTML string content.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional default?: string

                                                                                                                                                                                                                                                                                          The default button ID to focus initially.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional draggable?: boolean

                                                                                                                                                                                                                                                                                          The dialog is draggable when true; default: true.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional focusAuto?: boolean

                                                                                                                                                                                                                                                                                          When true auto-management of app focus is enabled; default: true.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional focusFirst?: boolean

                                                                                                                                                                                                                                                                                          When true the first focusable element that isn't a button is focused; default: false.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional focusKeep?: boolean

                                                                                                                                                                                                                                                                                          When focusAuto and focusKeep is true; keeps internal focus; default: false.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional focusTrap?: boolean

                                                                                                                                                                                                                                                                                          When true focus trapping / wrapping is enabled keeping focus inside app; default: true.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional minimizable?: boolean

                                                                                                                                                                                                                                                                                          When true the dialog is minimizable; default: true.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional modal?: boolean

                                                                                                                                                                                                                                                                                          When true a modal dialog is displayed; default: false.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional modalOptions?: TJSDialogModalOptions

                                                                                                                                                                                                                                                                                          Additional options for modal dialog display.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional notifyError?: boolean

                                                                                                                                                                                                                                                                                          When true and an error is thrown in dialog callback functions post a UI error notification; default: false.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional onClose?: string | ((data?) => any)

                                                                                                                                                                                                                                                                                          Callback invoked when dialog is closed; no button option selected. When defined as a string any matching function +TJSDialogOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Alias TJSDialogOptions

                                                                                                                                                                                                                                                                                          TJSDialogOptions: {
                                                                                                                                                                                                                                                                                              buttons?: Record<string, TJSDialogButtonData>;
                                                                                                                                                                                                                                                                                              content?: TJSSvelteConfig | string;
                                                                                                                                                                                                                                                                                              default?: string;
                                                                                                                                                                                                                                                                                              draggable?: boolean;
                                                                                                                                                                                                                                                                                              focusAuto?: boolean;
                                                                                                                                                                                                                                                                                              focusFirst?: boolean;
                                                                                                                                                                                                                                                                                              focusKeep?: boolean;
                                                                                                                                                                                                                                                                                              focusTrap?: boolean;
                                                                                                                                                                                                                                                                                              minimizable?: boolean;
                                                                                                                                                                                                                                                                                              modal?: boolean;
                                                                                                                                                                                                                                                                                              modalOptions?: TJSDialogModalOptions;
                                                                                                                                                                                                                                                                                              notifyError?: boolean;
                                                                                                                                                                                                                                                                                              onClose?: string | ((data?: {
                                                                                                                                                                                                                                                                                                  application: TJSDialog;
                                                                                                                                                                                                                                                                                              }) => any);
                                                                                                                                                                                                                                                                                              rejectClose?: boolean;
                                                                                                                                                                                                                                                                                              resizable?: boolean;
                                                                                                                                                                                                                                                                                              resolveId?: boolean;
                                                                                                                                                                                                                                                                                              title?: string;
                                                                                                                                                                                                                                                                                              transition?: TJSDialogTransitionOptions;
                                                                                                                                                                                                                                                                                              zIndex?: number | null;
                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                          Defines the common dialog configuration data.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                          • Optionalbuttons?: Record<string, TJSDialogButtonData>

                                                                                                                                                                                                                                                                                            Provides configuration of the dialog button bar.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionalcontent?: TJSSvelteConfig | string

                                                                                                                                                                                                                                                                                            A Svelte configuration object or HTML string content.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionaldefault?: string

                                                                                                                                                                                                                                                                                            The default button ID to focus initially.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionaldraggable?: boolean

                                                                                                                                                                                                                                                                                            The dialog is draggable when true; default: true.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalfocusAuto?: boolean

                                                                                                                                                                                                                                                                                            When true auto-management of app focus is enabled; default: true.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalfocusFirst?: boolean

                                                                                                                                                                                                                                                                                            When true the first focusable element that isn't a button is focused; default: false.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalfocusKeep?: boolean

                                                                                                                                                                                                                                                                                            When focusAuto and focusKeep is true; keeps internal focus; default: false.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalfocusTrap?: boolean

                                                                                                                                                                                                                                                                                            When true focus trapping / wrapping is enabled keeping focus inside app; default: true.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionalminimizable?: boolean

                                                                                                                                                                                                                                                                                            When true the dialog is minimizable; default: true.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionalmodal?: boolean

                                                                                                                                                                                                                                                                                            When true a modal dialog is displayed; default: false.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalmodalOptions?: TJSDialogModalOptions

                                                                                                                                                                                                                                                                                            Additional options for modal dialog display.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalnotifyError?: boolean

                                                                                                                                                                                                                                                                                            When true and an error is thrown in dialog callback functions post a UI error notification; default: false.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalonClose?: string | ((data?: {
                                                                                                                                                                                                                                                                                                application: TJSDialog;
                                                                                                                                                                                                                                                                                            }) => any)

                                                                                                                                                                                                                                                                                            Callback invoked when dialog is closed; no button option selected. When defined as a string any matching function by name exported from content Svelte component is invoked.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional rejectClose?: boolean

                                                                                                                                                                                                                                                                                            When true and a Promise has been created by TJSDialog.wait and the Promise is not in the process of being +

                                                                                                                                                                                                                                                                                          • OptionalrejectClose?: boolean

                                                                                                                                                                                                                                                                                            When true and a Promise has been created by TJSDialog.wait and the Promise is not in the process of being resolved or rejected on close of the dialog any onClose function is invoked and any result that is undefined will cause the Promise to then be rejected; default: false.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional resizable?: boolean

                                                                                                                                                                                                                                                                                            When true the dialog is resizable; default: false.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional resolveId?: boolean

                                                                                                                                                                                                                                                                                            When true and resolving any Promises and there are undefined results from any button callbacks the button ID is +

                                                                                                                                                                                                                                                                                          • Optionalresizable?: boolean

                                                                                                                                                                                                                                                                                            When true the dialog is resizable; default: false.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalresolveId?: boolean

                                                                                                                                                                                                                                                                                            When true and resolving any Promises and there are undefined results from any button callbacks the button ID is resolved; default: false.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional title?: string

                                                                                                                                                                                                                                                                                            The dialog window title.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional transition?: TJSDialogTransitionOptions

                                                                                                                                                                                                                                                                                            Transition options for the dialog.

                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                          • Optional zIndex?: number | null

                                                                                                                                                                                                                                                                                            A specific z-index for the dialog. Pass null for the dialog to act like other applications in regard bringing to +

                                                                                                                                                                                                                                                                                          • Optionaltitle?: string

                                                                                                                                                                                                                                                                                            The dialog window title.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • Optionaltransition?: TJSDialogTransitionOptions

                                                                                                                                                                                                                                                                                            Transition options for the dialog.

                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                          • OptionalzIndex?: number | null

                                                                                                                                                                                                                                                                                            A specific z-index for the dialog. Pass null for the dialog to act like other applications in regard bringing to top when activated.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_application.TJSDialogTransitionOptions.html b/docs/types/_runtime_svelte_application.TJSDialogTransitionOptions.html index 44555da9..8a4af2fb 100644 --- a/docs/types/_runtime_svelte_application.TJSDialogTransitionOptions.html +++ b/docs/types/_runtime_svelte_application.TJSDialogTransitionOptions.html @@ -1,7 +1,8 @@ -TJSDialogTransitionOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias TJSDialogTransitionOptions

                                                                                                                                                                                                                                                                                        TJSDialogTransitionOptions: {
                                                                                                                                                                                                                                                                                            inTransition?: TransitionFunction;
                                                                                                                                                                                                                                                                                            inTransitionOptions?: Record<string, any>;
                                                                                                                                                                                                                                                                                            outTransition?: TransitionFunction;
                                                                                                                                                                                                                                                                                            outTransitionOptions?: Record<string, any>;
                                                                                                                                                                                                                                                                                            transition?: TransitionFunction;
                                                                                                                                                                                                                                                                                            transitionOptions?: Record<string, any>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional inTransition?: TransitionFunction

                                                                                                                                                                                                                                                                                          A Svelte transition applied to the in transition.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional inTransitionOptions?: Record<string, any>

                                                                                                                                                                                                                                                                                          Additional transition options applied to the in transition.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional outTransition?: TransitionFunction

                                                                                                                                                                                                                                                                                          A Svelte transition applied to tbe out transition.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional outTransitionOptions?: Record<string, any>

                                                                                                                                                                                                                                                                                          Additional transition options applied to the out transition.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional transition?: TransitionFunction

                                                                                                                                                                                                                                                                                          A Svelte transition function applied to both in / out transitions.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                        • Optional transitionOptions?: Record<string, any>

                                                                                                                                                                                                                                                                                          Additional transition options applied to both in / out transitions.

                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +TJSDialogTransitionOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias TJSDialogTransitionOptions

                                                                                                                                                                                                                                                                                        TJSDialogTransitionOptions: {
                                                                                                                                                                                                                                                                                            inTransition?: TransitionFunction;
                                                                                                                                                                                                                                                                                            inTransitionOptions?: Record<string, any>;
                                                                                                                                                                                                                                                                                            outTransition?: TransitionFunction;
                                                                                                                                                                                                                                                                                            outTransitionOptions?: Record<string, any>;
                                                                                                                                                                                                                                                                                            transition?: TransitionFunction;
                                                                                                                                                                                                                                                                                            transitionOptions?: Record<string, any>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • OptionalinTransition?: TransitionFunction

                                                                                                                                                                                                                                                                                          A Svelte transition applied to the in transition.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • OptionalinTransitionOptions?: Record<string, any>

                                                                                                                                                                                                                                                                                          Additional transition options applied to the in transition.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • OptionaloutTransition?: TransitionFunction

                                                                                                                                                                                                                                                                                          A Svelte transition applied to tbe out transition.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • OptionaloutTransitionOptions?: Record<string, any>

                                                                                                                                                                                                                                                                                          Additional transition options applied to the out transition.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • Optionaltransition?: TransitionFunction

                                                                                                                                                                                                                                                                                          A Svelte transition function applied to both in / out transitions.

                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                        • OptionaltransitionOptions?: Record<string, any>

                                                                                                                                                                                                                                                                                          Additional transition options applied to both in / out transitions.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Events.html b/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Events.html index 771b1dc8..6d98156b 100644 --- a/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Events.html +++ b/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Events

                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                        \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Type Alias Events

                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Props.html b/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Props.html index 6fc17059..754afbc5 100644 --- a/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Props.html +++ b/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                        Type alias Props

                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                            appOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                            appOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                            contentOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                            contentOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                            draggable?: any;
                                                                                                                                                                                                                                                                                            draggableOptions?: any;
                                                                                                                                                                                                                                                                                            elementContent?: any;
                                                                                                                                                                                                                                                                                            elementRoot?: any;
                                                                                                                                                                                                                                                                                            inTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                            inTransitionOptions?: {};
                                                                                                                                                                                                                                                                                            outTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                            outTransitionOptions?: {};
                                                                                                                                                                                                                                                                                            stylesApp?: any;
                                                                                                                                                                                                                                                                                            stylesContent?: any;
                                                                                                                                                                                                                                                                                            transition?: (() => undefined);
                                                                                                                                                                                                                                                                                            transitionOptions?: any;
                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                        • Optional appOffsetHeight?: boolean
                                                                                                                                                                                                                                                                                        • Optional appOffsetWidth?: boolean
                                                                                                                                                                                                                                                                                        • Optional contentOffsetHeight?: boolean
                                                                                                                                                                                                                                                                                        • Optional contentOffsetWidth?: boolean
                                                                                                                                                                                                                                                                                        • Optional draggable?: any
                                                                                                                                                                                                                                                                                        • Optional draggableOptions?: any
                                                                                                                                                                                                                                                                                        • Optional elementContent?: any
                                                                                                                                                                                                                                                                                        • Optional elementRoot?: any
                                                                                                                                                                                                                                                                                        • Optional inTransition?: (() => undefined)
                                                                                                                                                                                                                                                                                            • (): undefined

                                                                                                                                                                                                                                                                                            • Returns undefined

                                                                                                                                                                                                                                                                                        • Optional inTransitionOptions?: {}
                                                                                                                                                                                                                                                                                          • Optional outTransition?: (() => undefined)
                                                                                                                                                                                                                                                                                              • (): undefined

                                                                                                                                                                                                                                                                                              • Returns undefined

                                                                                                                                                                                                                                                                                          • Optional outTransitionOptions?: {}
                                                                                                                                                                                                                                                                                            • Optional stylesApp?: any
                                                                                                                                                                                                                                                                                            • Optional stylesContent?: any
                                                                                                                                                                                                                                                                                            • Optional transition?: (() => undefined)
                                                                                                                                                                                                                                                                                                • (): undefined

                                                                                                                                                                                                                                                                                                • Returns undefined

                                                                                                                                                                                                                                                                                            • Optional transitionOptions?: any

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                            \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Type Alias Props

                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                appOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                                appOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                                contentOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                                contentOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                                draggable?: any;
                                                                                                                                                                                                                                                                                                draggableOptions?: any;
                                                                                                                                                                                                                                                                                                elementContent?: any;
                                                                                                                                                                                                                                                                                                elementRoot?: any;
                                                                                                                                                                                                                                                                                                inTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                inTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                outTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                outTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                stylesApp?: any;
                                                                                                                                                                                                                                                                                                stylesContent?: any;
                                                                                                                                                                                                                                                                                                transition?: (() => undefined);
                                                                                                                                                                                                                                                                                                transitionOptions?: any;
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Slots.html b/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Slots.html index ce9b6322..a6c1d745 100644 --- a/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Slots.html +++ b/docs/types/_runtime_svelte_component_core.ApplicationShell-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                            Type alias Slots

                                                                                                                                                                                                                                                                                            Slots: {
                                                                                                                                                                                                                                                                                                default: {};
                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                            • default: {}

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                              \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Type Alias Slots

                                                                                                                                                                                                                                                                                              Slots: {
                                                                                                                                                                                                                                                                                                  default: {};
                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Events.html b/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Events.html index da08a762..fb4d509c 100644 --- a/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Events.html +++ b/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                              Type alias Events

                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                              \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Type Alias Events

                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Props.html b/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Props.html index 6ba5c46f..03cdbb11 100644 --- a/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Props.html +++ b/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                              Type alias Props

                                                                                                                                                                                                                                                                                              Props: {
                                                                                                                                                                                                                                                                                                  appOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                                  appOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                                  elementContent?: any;
                                                                                                                                                                                                                                                                                                  elementRoot?: any;
                                                                                                                                                                                                                                                                                                  inTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                  inTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                  outTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                  outTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                  stylesApp?: any;
                                                                                                                                                                                                                                                                                                  transition?: (() => undefined);
                                                                                                                                                                                                                                                                                                  transitionOptions?: any;
                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                              Props type alias for associated component.

                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                              • Optional appOffsetHeight?: boolean
                                                                                                                                                                                                                                                                                              • Optional appOffsetWidth?: boolean
                                                                                                                                                                                                                                                                                              • Optional elementContent?: any
                                                                                                                                                                                                                                                                                              • Optional elementRoot?: any
                                                                                                                                                                                                                                                                                              • Optional inTransition?: (() => undefined)
                                                                                                                                                                                                                                                                                                  • (): undefined

                                                                                                                                                                                                                                                                                                  • Returns undefined

                                                                                                                                                                                                                                                                                              • Optional inTransitionOptions?: {}
                                                                                                                                                                                                                                                                                                • Optional outTransition?: (() => undefined)
                                                                                                                                                                                                                                                                                                    • (): undefined

                                                                                                                                                                                                                                                                                                    • Returns undefined

                                                                                                                                                                                                                                                                                                • Optional outTransitionOptions?: {}
                                                                                                                                                                                                                                                                                                  • Optional stylesApp?: any
                                                                                                                                                                                                                                                                                                  • Optional transition?: (() => undefined)
                                                                                                                                                                                                                                                                                                      • (): undefined

                                                                                                                                                                                                                                                                                                      • Returns undefined

                                                                                                                                                                                                                                                                                                  • Optional transitionOptions?: any

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                  \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Type Alias Props

                                                                                                                                                                                                                                                                                                  Props: {
                                                                                                                                                                                                                                                                                                      appOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                                      appOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                                      elementContent?: any;
                                                                                                                                                                                                                                                                                                      elementRoot?: any;
                                                                                                                                                                                                                                                                                                      inTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                      inTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                      outTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                      outTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                      stylesApp?: any;
                                                                                                                                                                                                                                                                                                      transition?: (() => undefined);
                                                                                                                                                                                                                                                                                                      transitionOptions?: any;
                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                  Props type alias for associated component.

                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Slots.html b/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Slots.html index 3bd17583..2fe3938d 100644 --- a/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Slots.html +++ b/docs/types/_runtime_svelte_component_core.EmptyApplicationShell-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                  Type alias Slots

                                                                                                                                                                                                                                                                                                  Slots: {
                                                                                                                                                                                                                                                                                                      default: {};
                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                  Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                  • default: {}

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Type Alias Slots

                                                                                                                                                                                                                                                                                                    Slots: {
                                                                                                                                                                                                                                                                                                        default: {};
                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                    Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Events.html b/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Events.html index 204717fb..18f61621 100644 --- a/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Events.html +++ b/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                    Type alias Events

                                                                                                                                                                                                                                                                                                    Events: {
                                                                                                                                                                                                                                                                                                        [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                    Events type alias for associated component.

                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Type Alias Events

                                                                                                                                                                                                                                                                                                    Events: {
                                                                                                                                                                                                                                                                                                        [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                    Events type alias for associated component.

                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Props.html b/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Props.html index 6b1fbba8..34811668 100644 --- a/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Props.html +++ b/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                    Type alias Props

                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                        appOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                                        appOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                                        contentOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                                        contentOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                                        draggable?: any;
                                                                                                                                                                                                                                                                                                        draggableOptions?: any;
                                                                                                                                                                                                                                                                                                        elementContent?: any;
                                                                                                                                                                                                                                                                                                        elementRoot?: any;
                                                                                                                                                                                                                                                                                                        inTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                        inTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                        outTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                        outTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                        stylesApp?: any;
                                                                                                                                                                                                                                                                                                        stylesContent?: any;
                                                                                                                                                                                                                                                                                                        transition?: (() => undefined);
                                                                                                                                                                                                                                                                                                        transitionOptions?: any;
                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                    • Optional appOffsetHeight?: boolean
                                                                                                                                                                                                                                                                                                    • Optional appOffsetWidth?: boolean
                                                                                                                                                                                                                                                                                                    • Optional contentOffsetHeight?: boolean
                                                                                                                                                                                                                                                                                                    • Optional contentOffsetWidth?: boolean
                                                                                                                                                                                                                                                                                                    • Optional draggable?: any
                                                                                                                                                                                                                                                                                                    • Optional draggableOptions?: any
                                                                                                                                                                                                                                                                                                    • Optional elementContent?: any
                                                                                                                                                                                                                                                                                                    • Optional elementRoot?: any
                                                                                                                                                                                                                                                                                                    • Optional inTransition?: (() => undefined)
                                                                                                                                                                                                                                                                                                        • (): undefined

                                                                                                                                                                                                                                                                                                        • Returns undefined

                                                                                                                                                                                                                                                                                                    • Optional inTransitionOptions?: {}
                                                                                                                                                                                                                                                                                                      • Optional outTransition?: (() => undefined)
                                                                                                                                                                                                                                                                                                          • (): undefined

                                                                                                                                                                                                                                                                                                          • Returns undefined

                                                                                                                                                                                                                                                                                                      • Optional outTransitionOptions?: {}
                                                                                                                                                                                                                                                                                                        • Optional stylesApp?: any
                                                                                                                                                                                                                                                                                                        • Optional stylesContent?: any
                                                                                                                                                                                                                                                                                                        • Optional transition?: (() => undefined)
                                                                                                                                                                                                                                                                                                            • (): undefined

                                                                                                                                                                                                                                                                                                            • Returns undefined

                                                                                                                                                                                                                                                                                                        • Optional transitionOptions?: any

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Type Alias Props

                                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                                            appOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                                            appOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                                            contentOffsetHeight?: boolean;
                                                                                                                                                                                                                                                                                                            contentOffsetWidth?: boolean;
                                                                                                                                                                                                                                                                                                            draggable?: any;
                                                                                                                                                                                                                                                                                                            draggableOptions?: any;
                                                                                                                                                                                                                                                                                                            elementContent?: any;
                                                                                                                                                                                                                                                                                                            elementRoot?: any;
                                                                                                                                                                                                                                                                                                            inTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                            inTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                            outTransition?: (() => undefined);
                                                                                                                                                                                                                                                                                                            outTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                            stylesApp?: any;
                                                                                                                                                                                                                                                                                                            stylesContent?: any;
                                                                                                                                                                                                                                                                                                            transition?: (() => undefined);
                                                                                                                                                                                                                                                                                                            transitionOptions?: any;
                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Slots.html b/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Slots.html index 875fd365..58ad1964 100644 --- a/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Slots.html +++ b/docs/types/_runtime_svelte_component_core.TJSApplicationShell-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                        Type alias Slots

                                                                                                                                                                                                                                                                                                        Slots: {
                                                                                                                                                                                                                                                                                                            default: {};
                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                        Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                        • default: {}

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Type Alias Slots

                                                                                                                                                                                                                                                                                                          Slots: {
                                                                                                                                                                                                                                                                                                              default: {};
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Events.html b/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Events.html index 29cd7511..c16daee6 100644 --- a/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Events.html +++ b/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                          Type alias Events

                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Type Alias Events

                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Props.html b/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Props.html index 650cca10..d2805a32 100644 --- a/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Props.html +++ b/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                          Type alias Props

                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                              elementRoot?: HTMLElement;
                                                                                                                                                                                                                                                                                                              enabled?: boolean;
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                          • Optional elementRoot?: HTMLElement
                                                                                                                                                                                                                                                                                                          • Optional enabled?: boolean

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Type Alias Props

                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                              elementRoot?: HTMLElement;
                                                                                                                                                                                                                                                                                                              enabled?: boolean;
                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Slots.html b/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Slots.html index 821a2211..806f8069 100644 --- a/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Slots.html +++ b/docs/types/_runtime_svelte_component_core.TJSFocusWrap-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                          Type alias Slots

                                                                                                                                                                                                                                                                                                          Slots: {}

                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Type Alias Slots

                                                                                                                                                                                                                                                                                                            Slots: {}

                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Events.html b/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Events.html index 94912efe..ecd7cbf5 100644 --- a/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Events.html +++ b/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                            Type alias Events

                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                glasspane:close: PointerEvent | MouseEvent | UIEvent | Event | ErrorEvent | AnimationEvent | ClipboardEvent | CompositionEvent | DragEvent | FocusEvent | FormDataEvent | InputEvent | KeyboardEvent | ProgressEvent<EventTarget> | SecurityPolicyViolationEvent | SubmitEvent | TouchEvent | TransitionEvent | WheelEvent;
                                                                                                                                                                                                                                                                                                                glasspane:keydown:escape: PointerEvent | MouseEvent | UIEvent | Event | ErrorEvent | AnimationEvent | ClipboardEvent | CompositionEvent | DragEvent | FocusEvent | FormDataEvent | InputEvent | KeyboardEvent | ProgressEvent<EventTarget> | SecurityPolicyViolationEvent | SubmitEvent | TouchEvent | TransitionEvent | WheelEvent;
                                                                                                                                                                                                                                                                                                                glasspane:pointerdown: PointerEvent | MouseEvent | UIEvent | Event | ErrorEvent | AnimationEvent | ClipboardEvent | CompositionEvent | DragEvent | FocusEvent | FormDataEvent | InputEvent | KeyboardEvent | ProgressEvent<EventTarget> | SecurityPolicyViolationEvent | SubmitEvent | TouchEvent | TransitionEvent | WheelEvent;
                                                                                                                                                                                                                                                                                                            } & {
                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Type Alias Events

                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                glasspane:close:
                                                                                                                                                                                                                                                                                                                    | PointerEvent
                                                                                                                                                                                                                                                                                                                    | MouseEvent
                                                                                                                                                                                                                                                                                                                    | UIEvent
                                                                                                                                                                                                                                                                                                                    | Event
                                                                                                                                                                                                                                                                                                                    | ErrorEvent
                                                                                                                                                                                                                                                                                                                    | AnimationEvent
                                                                                                                                                                                                                                                                                                                    | ClipboardEvent
                                                                                                                                                                                                                                                                                                                    | CompositionEvent
                                                                                                                                                                                                                                                                                                                    | DragEvent
                                                                                                                                                                                                                                                                                                                    | FocusEvent
                                                                                                                                                                                                                                                                                                                    | FormDataEvent
                                                                                                                                                                                                                                                                                                                    | InputEvent
                                                                                                                                                                                                                                                                                                                    | KeyboardEvent
                                                                                                                                                                                                                                                                                                                    | ProgressEvent<EventTarget>
                                                                                                                                                                                                                                                                                                                    | SecurityPolicyViolationEvent
                                                                                                                                                                                                                                                                                                                    | SubmitEvent
                                                                                                                                                                                                                                                                                                                    | TouchEvent
                                                                                                                                                                                                                                                                                                                    | TransitionEvent
                                                                                                                                                                                                                                                                                                                    | WheelEvent;
                                                                                                                                                                                                                                                                                                                glasspane:keydown:escape:
                                                                                                                                                                                                                                                                                                                    | PointerEvent
                                                                                                                                                                                                                                                                                                                    | MouseEvent
                                                                                                                                                                                                                                                                                                                    | UIEvent
                                                                                                                                                                                                                                                                                                                    | Event
                                                                                                                                                                                                                                                                                                                    | ErrorEvent
                                                                                                                                                                                                                                                                                                                    | AnimationEvent
                                                                                                                                                                                                                                                                                                                    | ClipboardEvent
                                                                                                                                                                                                                                                                                                                    | CompositionEvent
                                                                                                                                                                                                                                                                                                                    | DragEvent
                                                                                                                                                                                                                                                                                                                    | FocusEvent
                                                                                                                                                                                                                                                                                                                    | FormDataEvent
                                                                                                                                                                                                                                                                                                                    | InputEvent
                                                                                                                                                                                                                                                                                                                    | KeyboardEvent
                                                                                                                                                                                                                                                                                                                    | ProgressEvent<EventTarget>
                                                                                                                                                                                                                                                                                                                    | SecurityPolicyViolationEvent
                                                                                                                                                                                                                                                                                                                    | SubmitEvent
                                                                                                                                                                                                                                                                                                                    | TouchEvent
                                                                                                                                                                                                                                                                                                                    | TransitionEvent
                                                                                                                                                                                                                                                                                                                    | WheelEvent;
                                                                                                                                                                                                                                                                                                                glasspane:pointerdown:
                                                                                                                                                                                                                                                                                                                    | PointerEvent
                                                                                                                                                                                                                                                                                                                    | MouseEvent
                                                                                                                                                                                                                                                                                                                    | UIEvent
                                                                                                                                                                                                                                                                                                                    | Event
                                                                                                                                                                                                                                                                                                                    | ErrorEvent
                                                                                                                                                                                                                                                                                                                    | AnimationEvent
                                                                                                                                                                                                                                                                                                                    | ClipboardEvent
                                                                                                                                                                                                                                                                                                                    | CompositionEvent
                                                                                                                                                                                                                                                                                                                    | DragEvent
                                                                                                                                                                                                                                                                                                                    | FocusEvent
                                                                                                                                                                                                                                                                                                                    | FormDataEvent
                                                                                                                                                                                                                                                                                                                    | InputEvent
                                                                                                                                                                                                                                                                                                                    | KeyboardEvent
                                                                                                                                                                                                                                                                                                                    | ProgressEvent<EventTarget>
                                                                                                                                                                                                                                                                                                                    | SecurityPolicyViolationEvent
                                                                                                                                                                                                                                                                                                                    | SubmitEvent
                                                                                                                                                                                                                                                                                                                    | TouchEvent
                                                                                                                                                                                                                                                                                                                    | TransitionEvent
                                                                                                                                                                                                                                                                                                                    | WheelEvent;
                                                                                                                                                                                                                                                                                                            } & {
                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Props.html b/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Props.html index 3901d181..388e5a16 100644 --- a/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Props.html +++ b/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Props.html @@ -1,3 +1,4 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                            Type alias Props

                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                background?: string;
                                                                                                                                                                                                                                                                                                                captureInput?: boolean;
                                                                                                                                                                                                                                                                                                                closeOnInput?: boolean;
                                                                                                                                                                                                                                                                                                                id?: string;
                                                                                                                                                                                                                                                                                                                inTransition?: any;
                                                                                                                                                                                                                                                                                                                inTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                                outTransition?: any;
                                                                                                                                                                                                                                                                                                                outTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                                slotSeparate?: boolean;
                                                                                                                                                                                                                                                                                                                styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                transition?: any;
                                                                                                                                                                                                                                                                                                                transitionOptions?: any;
                                                                                                                                                                                                                                                                                                                zIndex?: number;
                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                            • Optional background?: string
                                                                                                                                                                                                                                                                                                            • Optional captureInput?: boolean
                                                                                                                                                                                                                                                                                                            • Optional closeOnInput?: boolean

                                                                                                                                                                                                                                                                                                              When true any input fires an event glasspane:close.

                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                            • Optional id?: string
                                                                                                                                                                                                                                                                                                            • Optional inTransition?: any
                                                                                                                                                                                                                                                                                                            • Optional inTransitionOptions?: {}
                                                                                                                                                                                                                                                                                                              • Optional outTransition?: any
                                                                                                                                                                                                                                                                                                              • Optional outTransitionOptions?: {}
                                                                                                                                                                                                                                                                                                                • Optional slotSeparate?: boolean
                                                                                                                                                                                                                                                                                                                • Optional styles?: Record<string, string>
                                                                                                                                                                                                                                                                                                                • Optional transition?: any
                                                                                                                                                                                                                                                                                                                • Optional transitionOptions?: any
                                                                                                                                                                                                                                                                                                                • Optional zIndex?: number

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Type Alias Props

                                                                                                                                                                                                                                                                                                                Props: {
                                                                                                                                                                                                                                                                                                                    background?: string;
                                                                                                                                                                                                                                                                                                                    captureInput?: boolean;
                                                                                                                                                                                                                                                                                                                    closeOnInput?: boolean;
                                                                                                                                                                                                                                                                                                                    id?: string;
                                                                                                                                                                                                                                                                                                                    inTransition?: any;
                                                                                                                                                                                                                                                                                                                    inTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                                    outTransition?: any;
                                                                                                                                                                                                                                                                                                                    outTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                                    slotSeparate?: boolean;
                                                                                                                                                                                                                                                                                                                    styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                    transition?: any;
                                                                                                                                                                                                                                                                                                                    transitionOptions?: any;
                                                                                                                                                                                                                                                                                                                    zIndex?: number;
                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                • Optionalbackground?: string
                                                                                                                                                                                                                                                                                                                • OptionalcaptureInput?: boolean
                                                                                                                                                                                                                                                                                                                • OptionalcloseOnInput?: boolean

                                                                                                                                                                                                                                                                                                                  When true any input fires an event glasspane:close.

                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                • Optionalid?: string
                                                                                                                                                                                                                                                                                                                • OptionalinTransition?: any
                                                                                                                                                                                                                                                                                                                • OptionalinTransitionOptions?: {}
                                                                                                                                                                                                                                                                                                                  • OptionaloutTransition?: any
                                                                                                                                                                                                                                                                                                                  • OptionaloutTransitionOptions?: {}
                                                                                                                                                                                                                                                                                                                    • OptionalslotSeparate?: boolean
                                                                                                                                                                                                                                                                                                                    • Optionalstyles?: Record<string, string>
                                                                                                                                                                                                                                                                                                                    • Optionaltransition?: any
                                                                                                                                                                                                                                                                                                                    • OptionaltransitionOptions?: any
                                                                                                                                                                                                                                                                                                                    • OptionalzIndex?: number

                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Slots.html b/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Slots.html index 96e45822..e9737280 100644 --- a/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Slots.html +++ b/docs/types/_runtime_svelte_component_core.TJSGlassPane-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                    Type alias Slots

                                                                                                                                                                                                                                                                                                                    Slots: {
                                                                                                                                                                                                                                                                                                                        default: {};
                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                    Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                    • default: {}

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias Slots

                                                                                                                                                                                                                                                                                                                      Slots: {
                                                                                                                                                                                                                                                                                                                          default: {};
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_easing.EasingFunctionName.html b/docs/types/_runtime_svelte_easing.EasingFunctionName.html index 25e3d706..4a2d16d6 100644 --- a/docs/types/_runtime_svelte_easing.EasingFunctionName.html +++ b/docs/types/_runtime_svelte_easing.EasingFunctionName.html @@ -1,2 +1,3 @@ -EasingFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias EasingFunctionName

                                                                                                                                                                                                                                                                                                                      EasingFunctionName: "backIn" | "backInOut" | "backOut" | "bounceIn" | "bounceInOut" | "bounceOut" | "circIn" | "circInOut" | "circOut" | "cubicIn" | "cubicInOut" | "cubicOut" | "elasticIn" | "elasticInOut" | "elasticOut" | "expoIn" | "expoInOut" | "expoOut" | "linear" | "quadIn" | "quadInOut" | "quadOut" | "quartIn" | "quartInOut" | "quartOut" | "quintIn" | "quintInOut" | "quintOut" | "sineIn" | "sineInOut" | "sineOut"

                                                                                                                                                                                                                                                                                                                      Defines all the standard 1-dimensional Svelte easing function names.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +EasingFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias EasingFunctionName

                                                                                                                                                                                                                                                                                                                      EasingFunctionName:
                                                                                                                                                                                                                                                                                                                          | "backIn"
                                                                                                                                                                                                                                                                                                                          | "backInOut"
                                                                                                                                                                                                                                                                                                                          | "backOut"
                                                                                                                                                                                                                                                                                                                          | "bounceIn"
                                                                                                                                                                                                                                                                                                                          | "bounceInOut"
                                                                                                                                                                                                                                                                                                                          | "bounceOut"
                                                                                                                                                                                                                                                                                                                          | "circIn"
                                                                                                                                                                                                                                                                                                                          | "circInOut"
                                                                                                                                                                                                                                                                                                                          | "circOut"
                                                                                                                                                                                                                                                                                                                          | "cubicIn"
                                                                                                                                                                                                                                                                                                                          | "cubicInOut"
                                                                                                                                                                                                                                                                                                                          | "cubicOut"
                                                                                                                                                                                                                                                                                                                          | "elasticIn"
                                                                                                                                                                                                                                                                                                                          | "elasticInOut"
                                                                                                                                                                                                                                                                                                                          | "elasticOut"
                                                                                                                                                                                                                                                                                                                          | "expoIn"
                                                                                                                                                                                                                                                                                                                          | "expoInOut"
                                                                                                                                                                                                                                                                                                                          | "expoOut"
                                                                                                                                                                                                                                                                                                                          | "linear"
                                                                                                                                                                                                                                                                                                                          | "quadIn"
                                                                                                                                                                                                                                                                                                                          | "quadInOut"
                                                                                                                                                                                                                                                                                                                          | "quadOut"
                                                                                                                                                                                                                                                                                                                          | "quartIn"
                                                                                                                                                                                                                                                                                                                          | "quartInOut"
                                                                                                                                                                                                                                                                                                                          | "quartOut"
                                                                                                                                                                                                                                                                                                                          | "quintIn"
                                                                                                                                                                                                                                                                                                                          | "quintInOut"
                                                                                                                                                                                                                                                                                                                          | "quintOut"
                                                                                                                                                                                                                                                                                                                          | "sineIn"
                                                                                                                                                                                                                                                                                                                          | "sineInOut"
                                                                                                                                                                                                                                                                                                                          | "sineOut"

                                                                                                                                                                                                                                                                                                                      Defines all the standard 1-dimensional Svelte easing function names.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_easing.EasingReference.html b/docs/types/_runtime_svelte_easing.EasingReference.html index cc23fb2e..2c185d86 100644 --- a/docs/types/_runtime_svelte_easing.EasingReference.html +++ b/docs/types/_runtime_svelte_easing.EasingReference.html @@ -1,2 +1,3 @@ -EasingReference | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias EasingReference

                                                                                                                                                                                                                                                                                                                      EasingReference: EasingFunctionName | EasingFunction

                                                                                                                                                                                                                                                                                                                      Defines an easing input as either a predefined easing function name or a custom easing function.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +EasingReference | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias EasingReference

                                                                                                                                                                                                                                                                                                                      EasingReference: EasingFunctionName | EasingFunction

                                                                                                                                                                                                                                                                                                                      Defines an easing input as either a predefined easing function name or a custom easing function.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_gsap.Action.DraggableGsapOptions.html b/docs/types/_runtime_svelte_gsap.Action.DraggableGsapOptions.html index ddb2ef8c..59f79cf5 100644 --- a/docs/types/_runtime_svelte_gsap.Action.DraggableGsapOptions.html +++ b/docs/types/_runtime_svelte_gsap.Action.DraggableGsapOptions.html @@ -1,13 +1,14 @@ -DraggableGsapOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DraggableGsapOptions

                                                                                                                                                                                                                                                                                                                      DraggableGsapOptions: {
                                                                                                                                                                                                                                                                                                                          button?: number;
                                                                                                                                                                                                                                                                                                                          enabled?: boolean;
                                                                                                                                                                                                                                                                                                                          hasTargetClassList?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                          ignoreTargetClassList?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                          inertia: boolean;
                                                                                                                                                                                                                                                                                                                          inertiaOptions: GsapInertiaOptions;
                                                                                                                                                                                                                                                                                                                          position: TJSPosition | Positionable;
                                                                                                                                                                                                                                                                                                                          storeDragging?: Writable<boolean>;
                                                                                                                                                                                                                                                                                                                          tween?: boolean;
                                                                                                                                                                                                                                                                                                                          tweenOptions?: GsapTweenOptions;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the options for the draggableGsap action.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional button?: number

                                                                                                                                                                                                                                                                                                                        MouseEvent button that activates dragging; default: 0

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        See

                                                                                                                                                                                                                                                                                                                        https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional enabled?: boolean

                                                                                                                                                                                                                                                                                                                        A boolean value; controlling the enabled state.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional hasTargetClassList?: Iterable<string>

                                                                                                                                                                                                                                                                                                                        When defined any event targets that have a class in this list are allowed.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional ignoreTargetClassList?: Iterable<string>

                                                                                                                                                                                                                                                                                                                        When defined any event targets that have a class in this list are ignored.

                                                                                                                                                                                                                                                                                                                        +DraggableGsapOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias DraggableGsapOptions

                                                                                                                                                                                                                                                                                                                        DraggableGsapOptions: {
                                                                                                                                                                                                                                                                                                                            button?: number;
                                                                                                                                                                                                                                                                                                                            enabled?: boolean;
                                                                                                                                                                                                                                                                                                                            hasTargetClassList?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                            ignoreTargetClassList?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                            inertia: boolean;
                                                                                                                                                                                                                                                                                                                            inertiaOptions: GsapInertiaOptions;
                                                                                                                                                                                                                                                                                                                            position: TJSPosition | Positionable;
                                                                                                                                                                                                                                                                                                                            storeDragging?: Writable<boolean>;
                                                                                                                                                                                                                                                                                                                            tween?: boolean;
                                                                                                                                                                                                                                                                                                                            tweenOptions?: GsapTweenOptions;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Defines the options for the draggableGsap action.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalbutton?: number

                                                                                                                                                                                                                                                                                                                          MouseEvent button that activates dragging; default: 0

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          See

                                                                                                                                                                                                                                                                                                                          https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalenabled?: boolean

                                                                                                                                                                                                                                                                                                                          A boolean value; controlling the enabled state.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • OptionalhasTargetClassList?: Iterable<string>

                                                                                                                                                                                                                                                                                                                          When defined any event targets that have a class in this list are allowed.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • OptionalignoreTargetClassList?: Iterable<string>

                                                                                                                                                                                                                                                                                                                          When defined any event targets that have a class in this list are ignored.

                                                                                                                                                                                                                                                                                                                        • inertia: boolean

                                                                                                                                                                                                                                                                                                                          When true inertia plugin options are enabled.

                                                                                                                                                                                                                                                                                                                        • inertiaOptions: GsapInertiaOptions

                                                                                                                                                                                                                                                                                                                          Inertia plugin options.

                                                                                                                                                                                                                                                                                                                        • position: TJSPosition | Positionable

                                                                                                                                                                                                                                                                                                                          A position or positionable instance.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional storeDragging?: Writable<boolean>

                                                                                                                                                                                                                                                                                                                          A writable store that tracks "dragging" state.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional tween?: boolean

                                                                                                                                                                                                                                                                                                                          When true tweening is enabled; default: false

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional tweenOptions?: GsapTweenOptions

                                                                                                                                                                                                                                                                                                                          Quick tween options.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                      • OptionalstoreDragging?: Writable<boolean>

                                                                                                                                                                                                                                                                                                                        A writable store that tracks "dragging" state.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionaltween?: boolean

                                                                                                                                                                                                                                                                                                                        When true tweening is enabled; default: false

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionaltweenOptions?: GsapTweenOptions

                                                                                                                                                                                                                                                                                                                        Quick tween options.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_gsap.Action.GsapInertiaOptions.html b/docs/types/_runtime_svelte_gsap.Action.GsapInertiaOptions.html index 735190d4..751817e1 100644 --- a/docs/types/_runtime_svelte_gsap.Action.GsapInertiaOptions.html +++ b/docs/types/_runtime_svelte_gsap.Action.GsapInertiaOptions.html @@ -1,7 +1,8 @@ -GsapInertiaOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GsapInertiaOptions

                                                                                                                                                                                                                                                                                                                      GsapInertiaOptions: {
                                                                                                                                                                                                                                                                                                                          duration?: {
                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                          end?: number | number[] | ((naturalLandingValue) => number);
                                                                                                                                                                                                                                                                                                                          resistance?: number;
                                                                                                                                                                                                                                                                                                                          velocityScale?: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines options for the inertia plugin.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional duration?: {
                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Min and max time in seconds for inertia duration. Default: min: 0; max: 3

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        • max: number
                                                                                                                                                                                                                                                                                                                        • min: number
                                                                                                                                                                                                                                                                                                                      • Optional end?: number | number[] | ((naturalLandingValue) => number)

                                                                                                                                                                                                                                                                                                                        Specifies hard ending points that are snapped to in pixels.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional resistance?: number

                                                                                                                                                                                                                                                                                                                        The amount of resistance per second (think of it like how much friction is applied); Default: 1000

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional velocityScale?: number

                                                                                                                                                                                                                                                                                                                        Scales velocity tracking values generated from dragging; Default: 1

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      See

                                                                                                                                                                                                                                                                                                                      https://gsap.com/docs/v3/Plugins/InertiaPlugin/#config-object

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +GsapInertiaOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias GsapInertiaOptions

                                                                                                                                                                                                                                                                                                                      GsapInertiaOptions: {
                                                                                                                                                                                                                                                                                                                          duration?: {
                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                          end?: number | number[] | ((naturalLandingValue: number) => number);
                                                                                                                                                                                                                                                                                                                          resistance?: number;
                                                                                                                                                                                                                                                                                                                          velocityScale?: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines options for the inertia plugin.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalduration?: {
                                                                                                                                                                                                                                                                                                                            max: number;
                                                                                                                                                                                                                                                                                                                            min: number;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Min and max time in seconds for inertia duration. Default: min: 0; max: 3

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                        • max: number
                                                                                                                                                                                                                                                                                                                        • min: number
                                                                                                                                                                                                                                                                                                                      • Optionalend?: number | number[] | ((naturalLandingValue: number) => number)

                                                                                                                                                                                                                                                                                                                        Specifies hard ending points that are snapped to in pixels.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalresistance?: number

                                                                                                                                                                                                                                                                                                                        The amount of resistance per second (think of it like how much friction is applied); Default: 1000

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalvelocityScale?: number

                                                                                                                                                                                                                                                                                                                        Scales velocity tracking values generated from dragging; Default: 1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      See

                                                                                                                                                                                                                                                                                                                      https://gsap.com/docs/v3/Plugins/InertiaPlugin/#config-object

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_gsap.Action.GsapTweenOptions.html b/docs/types/_runtime_svelte_gsap.Action.GsapTweenOptions.html index 44b62e4d..634b955c 100644 --- a/docs/types/_runtime_svelte_gsap.Action.GsapTweenOptions.html +++ b/docs/types/_runtime_svelte_gsap.Action.GsapTweenOptions.html @@ -1,4 +1,5 @@ -GsapTweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GsapTweenOptions

                                                                                                                                                                                                                                                                                                                      GsapTweenOptions: {
                                                                                                                                                                                                                                                                                                                          duration?: number;
                                                                                                                                                                                                                                                                                                                          ease?: string | EasingFunction;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines Gsap tween options.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional duration?: number

                                                                                                                                                                                                                                                                                                                        Duration in seconds; default: 1

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional ease?: string | EasingFunction

                                                                                                                                                                                                                                                                                                                        Easing function; default: 'power3.out'

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +GsapTweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias GsapTweenOptions

                                                                                                                                                                                                                                                                                                                      GsapTweenOptions: {
                                                                                                                                                                                                                                                                                                                          duration?: number;
                                                                                                                                                                                                                                                                                                                          ease?: string | EasingFunction;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines Gsap tween options.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalduration?: number

                                                                                                                                                                                                                                                                                                                        Duration in seconds; default: 1

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalease?: string | EasingFunction

                                                                                                                                                                                                                                                                                                                        Easing function; default: 'power3.out'

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_gsap.Compose.GsapData.html b/docs/types/_runtime_svelte_gsap.Compose.GsapData.html index a62f971f..5c08b98f 100644 --- a/docs/types/_runtime_svelte_gsap.Compose.GsapData.html +++ b/docs/types/_runtime_svelte_gsap.Compose.GsapData.html @@ -1 +1,2 @@ -GsapData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GsapData

                                                                                                                                                                                                                                                                                                                      GsapData: Iterable<object> | Function

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +GsapData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias GsapData

                                                                                                                                                                                                                                                                                                                      GsapData: Iterable<object> | Function

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_gsap.Compose.GsapPositionOptions.html b/docs/types/_runtime_svelte_gsap.Compose.GsapPositionOptions.html index ecbbd74c..619b8fb5 100644 --- a/docs/types/_runtime_svelte_gsap.Compose.GsapPositionOptions.html +++ b/docs/types/_runtime_svelte_gsap.Compose.GsapPositionOptions.html @@ -1,5 +1,6 @@ -GsapPositionOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GsapPositionOptions

                                                                                                                                                                                                                                                                                                                      GsapPositionOptions: {
                                                                                                                                                                                                                                                                                                                          filter?: Function;
                                                                                                                                                                                                                                                                                                                          initialProps?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional filter?: Function

                                                                                                                                                                                                                                                                                                                        An optional filter function to adjust position data in onUpdate callbacks. This is useful if you need to +GsapPositionOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias GsapPositionOptions

                                                                                                                                                                                                                                                                                                                        GsapPositionOptions: {
                                                                                                                                                                                                                                                                                                                            filter?: Function;
                                                                                                                                                                                                                                                                                                                            initialProps?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalfilter?: Function

                                                                                                                                                                                                                                                                                                                          An optional filter function to adjust position data in onUpdate callbacks. This is useful if you need to transform any data from GSAP / plugins into data TJSPosition can utilize.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional initialProps?: Iterable<string>

                                                                                                                                                                                                                                                                                                                          Provides an iterable list of property keys to assign to initial position data. This is useful when you are +

                                                                                                                                                                                                                                                                                                                        • OptionalinitialProps?: Iterable<string>

                                                                                                                                                                                                                                                                                                                          Provides an iterable list of property keys to assign to initial position data. This is useful when you are using GSAP plugins that manipulate data automatically; Ex. MotionPathPlugin

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_gsap.Compose.GsapTarget.html b/docs/types/_runtime_svelte_gsap.Compose.GsapTarget.html index f691ba7e..6ff9794a 100644 --- a/docs/types/_runtime_svelte_gsap.Compose.GsapTarget.html +++ b/docs/types/_runtime_svelte_gsap.Compose.GsapTarget.html @@ -1,2 +1,3 @@ -GsapTarget | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GsapTarget

                                                                                                                                                                                                                                                                                                                      GsapTarget: string | object | TJSPosition | Iterable<TJSPosition> | Positionable | Iterable<Positionable> | (HTMLElement | object)[]

                                                                                                                                                                                                                                                                                                                      Allowable targets for GsapCompose.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +GsapTarget | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias GsapTarget

                                                                                                                                                                                                                                                                                                                      GsapTarget:
                                                                                                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                                                                                                          | object
                                                                                                                                                                                                                                                                                                                          | TJSPosition
                                                                                                                                                                                                                                                                                                                          | Iterable<TJSPosition>
                                                                                                                                                                                                                                                                                                                          | Positionable
                                                                                                                                                                                                                                                                                                                          | Iterable<Positionable>
                                                                                                                                                                                                                                                                                                                          | (HTMLElement | object)[]

                                                                                                                                                                                                                                                                                                                      Allowable targets for GsapCompose.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_gsap.GsapEasingFunctionName.html b/docs/types/_runtime_svelte_gsap.GsapEasingFunctionName.html index dc2a313c..559cc70b 100644 --- a/docs/types/_runtime_svelte_gsap.GsapEasingFunctionName.html +++ b/docs/types/_runtime_svelte_gsap.GsapEasingFunctionName.html @@ -1,2 +1,3 @@ -GsapEasingFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GsapEasingFunctionName

                                                                                                                                                                                                                                                                                                                      GsapEasingFunctionName: "back.in(1)" | "back.inOut(1)" | "back.out(1)" | "back.in(10)" | "back.inOut(10)" | "back.out(10)" | "bounce.in" | "bounce.inOut" | "bounce.out" | "circ.in" | "circ.inOut" | "circ.out" | "elastic.in(1, 0.5)" | "elastic.inOut(1, 0.5)" | "elastic.out(1, 0.5)" | "elastic.in(10, 5)" | "elastic.inOut(10, 5)" | "elastic.out(10, 5)" | "expo.in" | "expo.inOut" | "expo.out" | "linear" | "power1.in" | "power1.inOut" | "power1.out" | "power2.in" | "power2.inOut" | "power2.out" | "power3.in" | "power3.inOut" | "power3.out" | "power4.in" | "power4.inOut" | "power4.out" | "sine.in" | "sine.inOut" | "sine.out" | "steps(10)" | "steps(100)" | "svelte-backIn" | "svelte-backInOut" | "svelte-backOut" | "svelte-bounceIn" | "svelte-bounceInOut" | "svelte-bounceOut" | "svelte-circIn" | "svelte-circInOut" | "svelte-circOut" | "svelte-cubicIn" | "svelte-cubicInOut" | "svelte-cubicOut" | "svelte-elasticIn" | "svelte-elasticInOut" | "svelte-elasticOut" | "svelte-expoIn" | "svelte-expoInOut" | "svelte-expoOut" | "svelte-linear" | "svelte-quadIn" | "svelte-quadInOut" | "svelte-quadOut" | "svelte-quartIn" | "svelte-quartInOut" | "svelte-quartOut" | "svelte-quintIn" | "svelte-quintInOut" | "svelte-quintOut" | "svelte-sineIn" | "svelte-sineInOut" | "svelte-sineOut"

                                                                                                                                                                                                                                                                                                                      Defines all the standard 1-dimensional Gsap easing function names.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +GsapEasingFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias GsapEasingFunctionName

                                                                                                                                                                                                                                                                                                                      GsapEasingFunctionName:
                                                                                                                                                                                                                                                                                                                          | "back.in(1)"
                                                                                                                                                                                                                                                                                                                          | "back.inOut(1)"
                                                                                                                                                                                                                                                                                                                          | "back.out(1)"
                                                                                                                                                                                                                                                                                                                          | "back.in(10)"
                                                                                                                                                                                                                                                                                                                          | "back.inOut(10)"
                                                                                                                                                                                                                                                                                                                          | "back.out(10)"
                                                                                                                                                                                                                                                                                                                          | "bounce.in"
                                                                                                                                                                                                                                                                                                                          | "bounce.inOut"
                                                                                                                                                                                                                                                                                                                          | "bounce.out"
                                                                                                                                                                                                                                                                                                                          | "circ.in"
                                                                                                                                                                                                                                                                                                                          | "circ.inOut"
                                                                                                                                                                                                                                                                                                                          | "circ.out"
                                                                                                                                                                                                                                                                                                                          | "elastic.in(1, 0.5)"
                                                                                                                                                                                                                                                                                                                          | "elastic.inOut(1, 0.5)"
                                                                                                                                                                                                                                                                                                                          | "elastic.out(1, 0.5)"
                                                                                                                                                                                                                                                                                                                          | "elastic.in(10, 5)"
                                                                                                                                                                                                                                                                                                                          | "elastic.inOut(10, 5)"
                                                                                                                                                                                                                                                                                                                          | "elastic.out(10, 5)"
                                                                                                                                                                                                                                                                                                                          | "expo.in"
                                                                                                                                                                                                                                                                                                                          | "expo.inOut"
                                                                                                                                                                                                                                                                                                                          | "expo.out"
                                                                                                                                                                                                                                                                                                                          | "linear"
                                                                                                                                                                                                                                                                                                                          | "power1.in"
                                                                                                                                                                                                                                                                                                                          | "power1.inOut"
                                                                                                                                                                                                                                                                                                                          | "power1.out"
                                                                                                                                                                                                                                                                                                                          | "power2.in"
                                                                                                                                                                                                                                                                                                                          | "power2.inOut"
                                                                                                                                                                                                                                                                                                                          | "power2.out"
                                                                                                                                                                                                                                                                                                                          | "power3.in"
                                                                                                                                                                                                                                                                                                                          | "power3.inOut"
                                                                                                                                                                                                                                                                                                                          | "power3.out"
                                                                                                                                                                                                                                                                                                                          | "power4.in"
                                                                                                                                                                                                                                                                                                                          | "power4.inOut"
                                                                                                                                                                                                                                                                                                                          | "power4.out"
                                                                                                                                                                                                                                                                                                                          | "sine.in"
                                                                                                                                                                                                                                                                                                                          | "sine.inOut"
                                                                                                                                                                                                                                                                                                                          | "sine.out"
                                                                                                                                                                                                                                                                                                                          | "steps(10)"
                                                                                                                                                                                                                                                                                                                          | "steps(100)"
                                                                                                                                                                                                                                                                                                                          | "svelte-backIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-backInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-backOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-bounceIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-bounceInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-bounceOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-circIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-circInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-circOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-cubicIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-cubicInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-cubicOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-elasticIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-elasticInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-elasticOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-expoIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-expoInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-expoOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-linear"
                                                                                                                                                                                                                                                                                                                          | "svelte-quadIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-quadInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-quadOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-quartIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-quartInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-quartOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-quintIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-quintInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-quintOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-sineIn"
                                                                                                                                                                                                                                                                                                                          | "svelte-sineInOut"
                                                                                                                                                                                                                                                                                                                          | "svelte-sineOut"

                                                                                                                                                                                                                                                                                                                      Defines all the standard 1-dimensional Gsap easing function names.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_gsap.GsapEasingReference.html b/docs/types/_runtime_svelte_gsap.GsapEasingReference.html index e600e717..18151072 100644 --- a/docs/types/_runtime_svelte_gsap.GsapEasingReference.html +++ b/docs/types/_runtime_svelte_gsap.GsapEasingReference.html @@ -1,2 +1,3 @@ -GsapEasingReference | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GsapEasingReference

                                                                                                                                                                                                                                                                                                                      GsapEasingReference: GsapEasingFunctionName | EasingFunction

                                                                                                                                                                                                                                                                                                                      Defines an easing input as either a predefined GSAP easing function name or a custom easing function.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +GsapEasingReference | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias GsapEasingReference

                                                                                                                                                                                                                                                                                                                      GsapEasingReference: GsapEasingFunctionName | EasingFunction

                                                                                                                                                                                                                                                                                                                      Defines an easing input as either a predefined GSAP easing function name or a custom easing function.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_dom.KeyStoreOptions.html b/docs/types/_runtime_svelte_store_dom.KeyStoreOptions.html index 9690a01c..3f98a7d6 100644 --- a/docs/types/_runtime_svelte_store_dom.KeyStoreOptions.html +++ b/docs/types/_runtime_svelte_store_dom.KeyStoreOptions.html @@ -1,4 +1,5 @@ -KeyStoreOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias KeyStoreOptions

                                                                                                                                                                                                                                                                                                                      KeyStoreOptions: {
                                                                                                                                                                                                                                                                                                                          preventDefault?: boolean;
                                                                                                                                                                                                                                                                                                                          stopPropagation?: boolean;
                                                                                                                                                                                                                                                                                                                          useCode?: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional preventDefault?: boolean

                                                                                                                                                                                                                                                                                                                        Invoke preventDefault on key events.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional stopPropagation?: boolean

                                                                                                                                                                                                                                                                                                                        Invoke stopPropagation on key events.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional useCode?: boolean

                                                                                                                                                                                                                                                                                                                        When true use event.code otherwise use event.key to get active key.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +KeyStoreOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias KeyStoreOptions

                                                                                                                                                                                                                                                                                                                      KeyStoreOptions: {
                                                                                                                                                                                                                                                                                                                          preventDefault?: boolean;
                                                                                                                                                                                                                                                                                                                          stopPropagation?: boolean;
                                                                                                                                                                                                                                                                                                                          useCode?: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • OptionalpreventDefault?: boolean

                                                                                                                                                                                                                                                                                                                        Invoke preventDefault on key events.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalstopPropagation?: boolean

                                                                                                                                                                                                                                                                                                                        Invoke stopPropagation on key events.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionaluseCode?: boolean

                                                                                                                                                                                                                                                                                                                        When true use event.code otherwise use event.key to get active key.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionOptions.html b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionOptions.html index d57c10c5..9aae9856 100644 --- a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionOptions.html @@ -1,5 +1,6 @@ -TJSDocumentCollectionOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSDocumentCollectionOptions

                                                                                                                                                                                                                                                                                                                      TJSDocumentCollectionOptions: {
                                                                                                                                                                                                                                                                                                                          delete?: ((collection) => void);
                                                                                                                                                                                                                                                                                                                          preDelete?: ((collection) => void);
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionUpdateOptions.html b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionUpdateOptions.html index d56fc3aa..c94f41a0 100644 --- a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionUpdateOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionUpdateOptions.html @@ -1,6 +1,7 @@ -TJSDocumentCollectionUpdateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSDocumentCollectionUpdateOptions<T>

                                                                                                                                                                                                                                                                                                                      TJSDocumentCollectionUpdateOptions<T>: {
                                                                                                                                                                                                                                                                                                                          action: string;
                                                                                                                                                                                                                                                                                                                          data: object[] | string[];
                                                                                                                                                                                                                                                                                                                          documentType: string;
                                                                                                                                                                                                                                                                                                                          documents: T[];
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides data regarding the latest collection change.

                                                                                                                                                                                                                                                                                                                      +TJSDocumentCollectionUpdateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias TJSDocumentCollectionUpdateOptions<T>

                                                                                                                                                                                                                                                                                                                      TJSDocumentCollectionUpdateOptions<T>: {
                                                                                                                                                                                                                                                                                                                          action: string;
                                                                                                                                                                                                                                                                                                                          data: object[] | string[];
                                                                                                                                                                                                                                                                                                                          documents: T[];
                                                                                                                                                                                                                                                                                                                          documentType: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides data regarding the latest collection change.

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • action: string

                                                                                                                                                                                                                                                                                                                        The update action. Useful for filtering.

                                                                                                                                                                                                                                                                                                                      • data: object[] | string[]

                                                                                                                                                                                                                                                                                                                        Foundry data associated with document changes.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • documentType: string

                                                                                                                                                                                                                                                                                                                        The document name.

                                                                                                                                                                                                                                                                                                                      • documents: T[]

                                                                                                                                                                                                                                                                                                                        associated documents that changed.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                    • documentType: string

                                                                                                                                                                                                                                                                                                                      The document name.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      • Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentOptions.html b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentOptions.html index 93c3dbac..9b48e112 100644 --- a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentOptions.html @@ -1,5 +1,6 @@ -TJSDocumentOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSDocumentOptions

                                                                                                                                                                                                                                                                                                                      TJSDocumentOptions: {
                                                                                                                                                                                                                                                                                                                          delete?: ((doc?) => void);
                                                                                                                                                                                                                                                                                                                          preDelete?: ((doc?) => void);
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional delete?: ((doc?) => void)

                                                                                                                                                                                                                                                                                                                        Optional post delete function to invoke when +TJSDocumentOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias TJSDocumentOptions

                                                                                                                                                                                                                                                                                                                        TJSDocumentOptions: {
                                                                                                                                                                                                                                                                                                                            delete?: ((doc?: object) => void);
                                                                                                                                                                                                                                                                                                                            preDelete?: ((doc?: object) => void);
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionaldelete?: ((doc?: object) => void)

                                                                                                                                                                                                                                                                                                                          Optional post delete function to invoke when document is deleted after subscribers have been notified.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                            • (doc?): void

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • Optional doc: object

                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                        • Optional preDelete?: ((doc?) => void)

                                                                                                                                                                                                                                                                                                                          Optional pre delete function to invoke +

                                                                                                                                                                                                                                                                                                                            • (doc?): void

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • Optionaldoc: object

                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                        • OptionalpreDelete?: ((doc?: object) => void)

                                                                                                                                                                                                                                                                                                                          Optional pre delete function to invoke when document is deleted before subscribers are notified.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                            • (doc?): void

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • Optional doc: object

                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                          • (doc?): void

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • Optionaldoc: object

                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentUpdateOptions.html b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentUpdateOptions.html index efd7a1f0..b405fbf7 100644 --- a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentUpdateOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentUpdateOptions.html @@ -1,5 +1,6 @@ -TJSDocumentUpdateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSDocumentUpdateOptions

                                                                                                                                                                                                                                                                                                                      TJSDocumentUpdateOptions: {
                                                                                                                                                                                                                                                                                                                          action?: string;
                                                                                                                                                                                                                                                                                                                          data?: object[] | string[];
                                                                                                                                                                                                                                                                                                                          renderContext?: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides data regarding the latest document change.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional action?: string

                                                                                                                                                                                                                                                                                                                        The update action. Useful for filtering.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional data?: object[] | string[]

                                                                                                                                                                                                                                                                                                                        Foundry data associated with document changes.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional renderContext?: string

                                                                                                                                                                                                                                                                                                                        The update action. Useful for filtering.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSDocumentUpdateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias TJSDocumentUpdateOptions

                                                                                                                                                                                                                                                                                                                      TJSDocumentUpdateOptions: {
                                                                                                                                                                                                                                                                                                                          action?: string;
                                                                                                                                                                                                                                                                                                                          data?: object[] | string[];
                                                                                                                                                                                                                                                                                                                          renderContext?: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides data regarding the latest document change.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalaction?: string

                                                                                                                                                                                                                                                                                                                        The update action. Useful for filtering.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionaldata?: object[] | string[]

                                                                                                                                                                                                                                                                                                                        Foundry data associated with document changes.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalrenderContext?: string

                                                                                                                                                                                                                                                                                                                        The update action. Useful for filtering.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_settings.GameSetting.html b/docs/types/_runtime_svelte_store_fvtt_settings.GameSetting.html index 336be9bf..f450c4d1 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.GameSetting.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.GameSetting.html @@ -1,7 +1,8 @@ -GameSetting | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GameSetting

                                                                                                                                                                                                                                                                                                                      GameSetting: {
                                                                                                                                                                                                                                                                                                                          folder?: string;
                                                                                                                                                                                                                                                                                                                          key: string;
                                                                                                                                                                                                                                                                                                                          namespace: string;
                                                                                                                                                                                                                                                                                                                          options: GameSettingOptions;
                                                                                                                                                                                                                                                                                                                          store?: Writable<any>;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines a game setting.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional folder?: string

                                                                                                                                                                                                                                                                                                                        The name of the TJSSvgFolder to put this setting in to group them.

                                                                                                                                                                                                                                                                                                                        +GameSetting | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias GameSetting

                                                                                                                                                                                                                                                                                                                        GameSetting: {
                                                                                                                                                                                                                                                                                                                            folder?: string;
                                                                                                                                                                                                                                                                                                                            key: string;
                                                                                                                                                                                                                                                                                                                            namespace: string;
                                                                                                                                                                                                                                                                                                                            options: GameSettingOptions;
                                                                                                                                                                                                                                                                                                                            store?: Writable<any>;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Defines a game setting.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalfolder?: string

                                                                                                                                                                                                                                                                                                                          The name of the TJSSvgFolder to put this setting in to group them.

                                                                                                                                                                                                                                                                                                                        • key: string

                                                                                                                                                                                                                                                                                                                          The setting key to register.

                                                                                                                                                                                                                                                                                                                        • namespace: string

                                                                                                                                                                                                                                                                                                                          The setting namespace; usually the ID of the module / system.

                                                                                                                                                                                                                                                                                                                        • options: GameSettingOptions

                                                                                                                                                                                                                                                                                                                          Configuration for setting data.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional store?: Writable<any>

                                                                                                                                                                                                                                                                                                                          An existing store instance to use.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                      • Optionalstore?: Writable<any>

                                                                                                                                                                                                                                                                                                                        An existing store instance to use.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingData.html b/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingData.html index 195ffdf0..dc648333 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingData.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingData.html @@ -1,2 +1,3 @@ -GameSettingData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GameSettingData

                                                                                                                                                                                                                                                                                                                      GameSettingData: GameSettingOptions

                                                                                                                                                                                                                                                                                                                      Stores the primary TJS game setting keys w/ GameSettingOptions.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +GameSettingData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias GameSettingData

                                                                                                                                                                                                                                                                                                                      GameSettingData: GameSettingOptions

                                                                                                                                                                                                                                                                                                                      Stores the primary TJS game setting keys w/ GameSettingOptions.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingOptions.html b/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingOptions.html index e161ab7f..31f20155 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingOptions.html @@ -1,13 +1,14 @@ -GameSettingOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GameSettingOptions

                                                                                                                                                                                                                                                                                                                      GameSettingOptions: {
                                                                                                                                                                                                                                                                                                                          choices?: object;
                                                                                                                                                                                                                                                                                                                          config?: boolean;
                                                                                                                                                                                                                                                                                                                          default?: any;
                                                                                                                                                                                                                                                                                                                          hint?: string;
                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                          onChange?: Function | Iterable<Function>;
                                                                                                                                                                                                                                                                                                                          range?: {
                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                              step: number;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                          requiresReload?: boolean;
                                                                                                                                                                                                                                                                                                                          scope?: "client" | "world";
                                                                                                                                                                                                                                                                                                                          type: object | Function;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional choices?: object

                                                                                                                                                                                                                                                                                                                        If choices are defined, the resulting setting will be a select menu.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional config?: boolean

                                                                                                                                                                                                                                                                                                                        Specifies that the setting appears in the configuration view.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional default?: any

                                                                                                                                                                                                                                                                                                                        A default value for the setting.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional hint?: string

                                                                                                                                                                                                                                                                                                                        A description of the registered setting and its behavior.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional name?: string

                                                                                                                                                                                                                                                                                                                        The displayed name of the setting.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional onChange?: Function | Iterable<Function>

                                                                                                                                                                                                                                                                                                                        An onChange callback function or iterable list of callbacks to +GameSettingOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias GameSettingOptions

                                                                                                                                                                                                                                                                                                                        GameSettingOptions: {
                                                                                                                                                                                                                                                                                                                            choices?: object;
                                                                                                                                                                                                                                                                                                                            config?: boolean;
                                                                                                                                                                                                                                                                                                                            default?: any;
                                                                                                                                                                                                                                                                                                                            hint?: string;
                                                                                                                                                                                                                                                                                                                            name?: string;
                                                                                                                                                                                                                                                                                                                            onChange?: Function | Iterable<Function>;
                                                                                                                                                                                                                                                                                                                            range?: {
                                                                                                                                                                                                                                                                                                                                max: number;
                                                                                                                                                                                                                                                                                                                                min: number;
                                                                                                                                                                                                                                                                                                                                step: number;
                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                            requiresReload?: boolean;
                                                                                                                                                                                                                                                                                                                            scope?: "client" | "world";
                                                                                                                                                                                                                                                                                                                            type: object | Function;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalchoices?: object

                                                                                                                                                                                                                                                                                                                          If choices are defined, the resulting setting will be a select menu.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalconfig?: boolean

                                                                                                                                                                                                                                                                                                                          Specifies that the setting appears in the configuration view.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionaldefault?: any

                                                                                                                                                                                                                                                                                                                          A default value for the setting.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalhint?: string

                                                                                                                                                                                                                                                                                                                          A description of the registered setting and its behavior.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalname?: string

                                                                                                                                                                                                                                                                                                                          The displayed name of the setting.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • OptionalonChange?: Function | Iterable<Function>

                                                                                                                                                                                                                                                                                                                          An onChange callback function or iterable list of callbacks to directly receive callbacks from Foundry on setting change.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional range?: {
                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                              step: number;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          If range is specified, the resulting setting will be +

                                                                                                                                                                                                                                                                                                                        • Optionalrange?: {
                                                                                                                                                                                                                                                                                                                              max: number;
                                                                                                                                                                                                                                                                                                                              min: number;
                                                                                                                                                                                                                                                                                                                              step: number;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          If range is specified, the resulting setting will be a range slider.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          • max: number
                                                                                                                                                                                                                                                                                                                          • min: number
                                                                                                                                                                                                                                                                                                                          • step: number
                                                                                                                                                                                                                                                                                                                        • Optional requiresReload?: boolean

                                                                                                                                                                                                                                                                                                                          If true then a prompt to reload after changes occurs.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional scope?: "client" | "world"

                                                                                                                                                                                                                                                                                                                          Scope for setting.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                          • max: number
                                                                                                                                                                                                                                                                                                                          • min: number
                                                                                                                                                                                                                                                                                                                          • step: number
                                                                                                                                                                                                                                                                                                                        • OptionalrequiresReload?: boolean

                                                                                                                                                                                                                                                                                                                          If true then a prompt to reload after changes occurs.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalscope?: "client" | "world"

                                                                                                                                                                                                                                                                                                                          Scope for setting.

                                                                                                                                                                                                                                                                                                                        • type: object | Function

                                                                                                                                                                                                                                                                                                                          A constructable object or function.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCreateOptions.html b/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCreateOptions.html index 52593c86..8456c112 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCreateOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCreateOptions.html @@ -1,3 +1,4 @@ -TJSSettingsCreateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSSettingsCreateOptions

                                                                                                                                                                                                                                                                                                                      TJSSettingsCreateOptions: {
                                                                                                                                                                                                                                                                                                                          efx?: string;
                                                                                                                                                                                                                                                                                                                          storage?: TJSWebStorage;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional efx?: string

                                                                                                                                                                                                                                                                                                                        Defines the effects added to TJS components; ripple by default.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional storage?: TJSWebStorage

                                                                                                                                                                                                                                                                                                                        TRL TJSWebStorage (session) instance to serialize folder state and scrollbar position.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSSettingsCreateOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias TJSSettingsCreateOptions

                                                                                                                                                                                                                                                                                                                      TJSSettingsCreateOptions: {
                                                                                                                                                                                                                                                                                                                          efx?: string;
                                                                                                                                                                                                                                                                                                                          storage?: TJSWebStorage;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalefx?: string

                                                                                                                                                                                                                                                                                                                        Defines the effects added to TJS components; ripple by default.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalstorage?: TJSWebStorage

                                                                                                                                                                                                                                                                                                                        TRL TJSWebStorage (session) instance to serialize folder state and scrollbar position.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCustomSection.html b/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCustomSection.html index 6ca6e884..b0ce772e 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCustomSection.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCustomSection.html @@ -1,5 +1,6 @@ -TJSSettingsCustomSection | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSSettingsCustomSection

                                                                                                                                                                                                                                                                                                                      TJSSettingsCustomSection: {
                                                                                                                                                                                                                                                                                                                          class: Function;
                                                                                                                                                                                                                                                                                                                          folder?: string | TJSSettingsCustomSectionFolder;
                                                                                                                                                                                                                                                                                                                          props?: Function;
                                                                                                                                                                                                                                                                                                                          styles?: object;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • class: Function

                                                                                                                                                                                                                                                                                                                        Svelte component constructor function for custom section.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional folder?: string | TJSSettingsCustomSectionFolder

                                                                                                                                                                                                                                                                                                                        A folder label or TJSSettingsCustomSectionFolder object.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional props?: Function

                                                                                                                                                                                                                                                                                                                        Svelte component constructor function for custom section.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional styles?: object

                                                                                                                                                                                                                                                                                                                        Inline styles for the section element.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSSettingsCustomSection | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias TJSSettingsCustomSection

                                                                                                                                                                                                                                                                                                                      TJSSettingsCustomSection: {
                                                                                                                                                                                                                                                                                                                          class: Function;
                                                                                                                                                                                                                                                                                                                          folder?: string | TJSSettingsCustomSectionFolder;
                                                                                                                                                                                                                                                                                                                          props?: Function;
                                                                                                                                                                                                                                                                                                                          styles?: object;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • class: Function

                                                                                                                                                                                                                                                                                                                        Svelte component constructor function for custom section.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalfolder?: string | TJSSettingsCustomSectionFolder

                                                                                                                                                                                                                                                                                                                        A folder label or TJSSettingsCustomSectionFolder object.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalprops?: Function

                                                                                                                                                                                                                                                                                                                        Svelte component constructor function for custom section.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalstyles?: object

                                                                                                                                                                                                                                                                                                                        Inline styles for the section element.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCustomSectionFolder.html b/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCustomSectionFolder.html index 535c7c0b..8d681130 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCustomSectionFolder.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsCustomSectionFolder.html @@ -1,4 +1,5 @@ -TJSSettingsCustomSectionFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSSettingsCustomSectionFolder

                                                                                                                                                                                                                                                                                                                      TJSSettingsCustomSectionFolder: {
                                                                                                                                                                                                                                                                                                                          label: string;
                                                                                                                                                                                                                                                                                                                          styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                          summaryEnd?: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • label: string

                                                                                                                                                                                                                                                                                                                        The folder label.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional styles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                        Inline styles for the TJSSvgFolder; useful for setting CSS variables.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional summaryEnd?: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                        A Svelte component config object defining TJSSvgFolder summary end component.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSSettingsCustomSectionFolder | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias TJSSettingsCustomSectionFolder

                                                                                                                                                                                                                                                                                                                      TJSSettingsCustomSectionFolder: {
                                                                                                                                                                                                                                                                                                                          label: string;
                                                                                                                                                                                                                                                                                                                          styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                          summaryEnd?: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • label: string

                                                                                                                                                                                                                                                                                                                        The folder label.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalstyles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                        Inline styles for the TJSSvgFolder; useful for setting CSS variables.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalsummaryEnd?: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                        A Svelte component config object defining TJSSvgFolder summary end component.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsUIData.html b/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsUIData.html index f631def9..5c676274 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsUIData.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.TJSSettingsUIData.html @@ -1,6 +1,7 @@ -TJSSettingsUIData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSSettingsUIData

                                                                                                                                                                                                                                                                                                                      TJSSettingsUIData: {
                                                                                                                                                                                                                                                                                                                          destroy?: Function;
                                                                                                                                                                                                                                                                                                                          folders: {
                                                                                                                                                                                                                                                                                                                              label: string;
                                                                                                                                                                                                                                                                                                                              settings: object[];
                                                                                                                                                                                                                                                                                                                          }[];
                                                                                                                                                                                                                                                                                                                          sections: object[];
                                                                                                                                                                                                                                                                                                                          storeScrollbar: Writable<number>;
                                                                                                                                                                                                                                                                                                                          topLevel: object[];
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional destroy?: Function

                                                                                                                                                                                                                                                                                                                        The bound destroy callback function for received of TJSSettingsUIData.

                                                                                                                                                                                                                                                                                                                        +TJSSettingsUIData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias TJSSettingsUIData

                                                                                                                                                                                                                                                                                                                        TJSSettingsUIData: {
                                                                                                                                                                                                                                                                                                                            destroy?: Function;
                                                                                                                                                                                                                                                                                                                            folders: {
                                                                                                                                                                                                                                                                                                                                label: string;
                                                                                                                                                                                                                                                                                                                                settings: object[];
                                                                                                                                                                                                                                                                                                                            }[];
                                                                                                                                                                                                                                                                                                                            sections: object[];
                                                                                                                                                                                                                                                                                                                            storeScrollbar: Writable<number>;
                                                                                                                                                                                                                                                                                                                            topLevel: object[];
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionaldestroy?: Function

                                                                                                                                                                                                                                                                                                                          The bound destroy callback function for received of TJSSettingsUIData.

                                                                                                                                                                                                                                                                                                                        • folders: {
                                                                                                                                                                                                                                                                                                                              label: string;
                                                                                                                                                                                                                                                                                                                              settings: object[];
                                                                                                                                                                                                                                                                                                                          }[]

                                                                                                                                                                                                                                                                                                                          Sorted folders with associated settings and label.

                                                                                                                                                                                                                                                                                                                        • sections: object[]

                                                                                                                                                                                                                                                                                                                          Custom sections.

                                                                                                                                                                                                                                                                                                                        • storeScrollbar: Writable<number>

                                                                                                                                                                                                                                                                                                                          The store for applyScrolltop.

                                                                                                                                                                                                                                                                                                                        • topLevel: object[]

                                                                                                                                                                                                                                                                                                                          Top level settings data.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.Action.DraggableOptions.html b/docs/types/_runtime_svelte_store_position.Action.DraggableOptions.html index f638a0b6..f7f4fefe 100644 --- a/docs/types/_runtime_svelte_store_position.Action.DraggableOptions.html +++ b/docs/types/_runtime_svelte_store_position.Action.DraggableOptions.html @@ -1,11 +1,12 @@ -DraggableOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DraggableOptions

                                                                                                                                                                                                                                                                                                                      DraggableOptions: {
                                                                                                                                                                                                                                                                                                                          button?: number;
                                                                                                                                                                                                                                                                                                                          enabled: boolean;
                                                                                                                                                                                                                                                                                                                          hasTargetClassList?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                          ignoreTargetClassList?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                          position: TJSPosition | Positionable;
                                                                                                                                                                                                                                                                                                                          storeDragging?: Writable<boolean>;
                                                                                                                                                                                                                                                                                                                          tween?: boolean;
                                                                                                                                                                                                                                                                                                                          tweenOptions?: QuickTweenOptions;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the options for the draggable action.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.AnimationKey.html b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.AnimationKey.html index b6923fe5..df9c2138 100644 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.AnimationKey.html +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.AnimationKey.html @@ -1,2 +1,3 @@ -AnimationKey | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias AnimationKey

                                                                                                                                                                                                                                                                                                                      AnimationKey: "left" | "top" | "maxWidth" | "maxHeight" | "minWidth" | "minHeight" | "width" | "height" | "rotateX" | "rotateY" | "rotateZ" | "scale" | "translateX" | "translateY" | "translateZ" | "zIndex" | "rotation"

                                                                                                                                                                                                                                                                                                                      The position keys that can be animated.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +AnimationKey | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias AnimationKey

                                                                                                                                                                                                                                                                                                                      AnimationKey:
                                                                                                                                                                                                                                                                                                                          | "left"
                                                                                                                                                                                                                                                                                                                          | "top"
                                                                                                                                                                                                                                                                                                                          | "maxWidth"
                                                                                                                                                                                                                                                                                                                          | "maxHeight"
                                                                                                                                                                                                                                                                                                                          | "minWidth"
                                                                                                                                                                                                                                                                                                                          | "minHeight"
                                                                                                                                                                                                                                                                                                                          | "width"
                                                                                                                                                                                                                                                                                                                          | "height"
                                                                                                                                                                                                                                                                                                                          | "rotateX"
                                                                                                                                                                                                                                                                                                                          | "rotateY"
                                                                                                                                                                                                                                                                                                                          | "rotateZ"
                                                                                                                                                                                                                                                                                                                          | "scale"
                                                                                                                                                                                                                                                                                                                          | "translateX"
                                                                                                                                                                                                                                                                                                                          | "translateY"
                                                                                                                                                                                                                                                                                                                          | "translateZ"
                                                                                                                                                                                                                                                                                                                          | "zIndex"
                                                                                                                                                                                                                                                                                                                          | "rotation"

                                                                                                                                                                                                                                                                                                                      The position keys that can be animated.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.GroupCallbackOptions.html b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.GroupCallbackOptions.html index 7311abdd..315a6bf0 100644 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.GroupCallbackOptions.html +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.GroupCallbackOptions.html @@ -1,6 +1,7 @@ -GroupCallbackOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias GroupCallbackOptions

                                                                                                                                                                                                                                                                                                                      GroupCallbackOptions: {
                                                                                                                                                                                                                                                                                                                          entry?: Positionable;
                                                                                                                                                                                                                                                                                                                          index?: number;
                                                                                                                                                                                                                                                                                                                          position?: TJSPosition;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Options passed to any group animation callbacks for Data.TJSPositionDataRelative data or +GroupCallbackOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias GroupCallbackOptions

                                                                                                                                                                                                                                                                                                                      GroupCallbackOptions: {
                                                                                                                                                                                                                                                                                                                          entry?: Positionable;
                                                                                                                                                                                                                                                                                                                          index?: number;
                                                                                                                                                                                                                                                                                                                          position?: TJSPosition;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Options passed to any group animation callbacks for Data.TJSPositionDataRelative data or TweenOptions.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.QuickTweenOptions.html b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.QuickTweenOptions.html index 8830d820..97a619c9 100644 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.QuickTweenOptions.html +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.QuickTweenOptions.html @@ -1,5 +1,6 @@ -QuickTweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias QuickTweenOptions

                                                                                                                                                                                                                                                                                                                      QuickTweenOptions: {
                                                                                                                                                                                                                                                                                                                          duration?: number;
                                                                                                                                                                                                                                                                                                                          ease?: EasingReference;
                                                                                                                                                                                                                                                                                                                          interpolate?: InterpolateFunctionName;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the quick tweening options.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional duration?: number

                                                                                                                                                                                                                                                                                                                        Duration in seconds; default: 1

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional ease?: EasingReference

                                                                                                                                                                                                                                                                                                                        Easing function or easing function name; controls the time variable for interpolation. Default: cubicOut

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional interpolate?: InterpolateFunctionName

                                                                                                                                                                                                                                                                                                                        Interpolation function name. Currently, only lerp is supported and doesn't need to be specified.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +QuickTweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias QuickTweenOptions

                                                                                                                                                                                                                                                                                                                      QuickTweenOptions: {
                                                                                                                                                                                                                                                                                                                          duration?: number;
                                                                                                                                                                                                                                                                                                                          ease?: EasingReference;
                                                                                                                                                                                                                                                                                                                          interpolate?: InterpolateFunctionName;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the quick tweening options.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalduration?: number

                                                                                                                                                                                                                                                                                                                        Duration in seconds; default: 1

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalease?: EasingReference

                                                                                                                                                                                                                                                                                                                        Easing function or easing function name; controls the time variable for interpolation. Default: cubicOut

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalinterpolate?: InterpolateFunctionName

                                                                                                                                                                                                                                                                                                                        Interpolation function name. Currently, only lerp is supported and doesn't need to be specified.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.ScheduleOptions.html b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.ScheduleOptions.html index b899301c..9e148bcc 100644 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.ScheduleOptions.html +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.ScheduleOptions.html @@ -1,4 +1,5 @@ -ScheduleOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ScheduleOptions

                                                                                                                                                                                                                                                                                                                      ScheduleOptions: {
                                                                                                                                                                                                                                                                                                                          active?: boolean;
                                                                                                                                                                                                                                                                                                                          pending?: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines options for the AnimationGroupAPI.isScheduled.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional active?: boolean

                                                                                                                                                                                                                                                                                                                        When false exclude searching active animations.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional pending?: boolean

                                                                                                                                                                                                                                                                                                                        When false exclude searching pending animations that have not started.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +ScheduleOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ScheduleOptions

                                                                                                                                                                                                                                                                                                                      ScheduleOptions: {
                                                                                                                                                                                                                                                                                                                          active?: boolean;
                                                                                                                                                                                                                                                                                                                          pending?: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines options for the AnimationGroupAPI.isScheduled.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalactive?: boolean

                                                                                                                                                                                                                                                                                                                        When false exclude searching active animations.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalpending?: boolean

                                                                                                                                                                                                                                                                                                                        When false exclude searching pending animations that have not started.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.TweenOptions.html b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.TweenOptions.html index bead695d..149783ac 100644 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.TweenOptions.html +++ b/docs/types/_runtime_svelte_store_position.AnimationAPI-1.TweenOptions.html @@ -1,9 +1,11 @@ -TweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TweenOptions

                                                                                                                                                                                                                                                                                                                      TweenOptions: QuickTweenOptions & {
                                                                                                                                                                                                                                                                                                                          delay?: number;
                                                                                                                                                                                                                                                                                                                          strategy?: "cancel" | "cancelAll" | "exclusive";
                                                                                                                                                                                                                                                                                                                          transformOrigin?: TransformOrigin;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the tweening options.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional delay?: number

                                                                                                                                                                                                                                                                                                                        Delay in seconds before animation starts; default: 0

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional strategy?: "cancel" | "cancelAll" | "exclusive"

                                                                                                                                                                                                                                                                                                                        Defines the scheduling strategy for handling new animations when an existing animation is already scheduled for +TweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias TweenOptions

                                                                                                                                                                                                                                                                                                                        TweenOptions: QuickTweenOptions & {
                                                                                                                                                                                                                                                                                                                            delay?: number;
                                                                                                                                                                                                                                                                                                                            strategy?: "cancel" | "cancelAll" | "exclusive";
                                                                                                                                                                                                                                                                                                                            transformOrigin?: TransformOrigin;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Defines the tweening options.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionaldelay?: number

                                                                                                                                                                                                                                                                                                                          Delay in seconds before animation starts; default: 0

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalstrategy?: "cancel" | "cancelAll" | "exclusive"

                                                                                                                                                                                                                                                                                                                          Defines the scheduling strategy for handling new animations when an existing animation is already scheduled for the same target.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                          - `cancel`: Cancels any non `quickTo` pending and ongoing animations on the same target and schedules the new
                                                                                                                                                                                                                                                                                                                            animation immediately. This option ensures that the new animation takes precedence by clearing any existing
                                                                                                                                                                                                                                                                                                                            animations.

                                                                                                                                                                                                                                                                                                                          - `cancelAll`: Cancels _all_ pending and ongoing animations on the same target and schedules the new animation
                                                                                                                                                                                                                                                                                                                            immediately. This option ensures that the new animation takes precedence by clearing any existing animations.

                                                                                                                                                                                                                                                                                                                          - `exclusive`: Only schedules the new animation if there are no other animations currently scheduled for the
                                                                                                                                                                                                                                                                                                                            same target. This option avoids animation conflicts by ensuring that only one animation can run at a time.
+
                                                                                                                                                                                                                                                                                                                          - `cancel`: Cancels any non `quickTo` pending and ongoing animations on the same target and schedules the new
                                                                                                                                                                                                                                                                                                                            animation immediately. This option ensures that the new animation takes precedence by clearing any existing
                                                                                                                                                                                                                                                                                                                            animations.

                                                                                                                                                                                                                                                                                                                          - `cancelAll`: Cancels _all_ pending and ongoing animations on the same target and schedules the new animation
                                                                                                                                                                                                                                                                                                                            immediately. This option ensures that the new animation takes precedence by clearing any existing animations.

                                                                                                                                                                                                                                                                                                                          - `exclusive`: Only schedules the new animation if there are no other animations currently scheduled for the
                                                                                                                                                                                                                                                                                                                            same target. This option avoids animation conflicts by ensuring that only one animation can run at a time.
 
                                                                                                                                                                                                                                                                                                                          
-
                                                                                                                                                                                                                                                                                                                        • Optional transformOrigin?: TransformOrigin

                                                                                                                                                                                                                                                                                                                          A transform origin to apply for the animation. The initial transform origin is reset when the animation + +

                                                                                                                                                                                                                                                                                                                        • OptionaltransformOrigin?: TransformOrigin

                                                                                                                                                                                                                                                                                                                          A transform origin to apply for the animation. The initial transform origin is reset when the animation finishes.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.Data.TJSPositionDataRelative.html b/docs/types/_runtime_svelte_store_position.Data.TJSPositionDataRelative.html index 0b30f446..866d16a2 100644 --- a/docs/types/_runtime_svelte_store_position.Data.TJSPositionDataRelative.html +++ b/docs/types/_runtime_svelte_store_position.Data.TJSPositionDataRelative.html @@ -1,10 +1,12 @@ -TJSPositionDataRelative | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSPositionDataRelative

                                                                                                                                                                                                                                                                                                                      TJSPositionDataRelative: Partial<{
                                                                                                                                                                                                                                                                                                                          [P in keyof TJSPositionData as P extends AnimationKey
                                                                                                                                                                                                                                                                                                                              ? P
                                                                                                                                                                                                                                                                                                                              : never]: TJSPositionData[P] | string
                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                          [P in keyof TJSPositionData as P extends AnimationKey
                                                                                                                                                                                                                                                                                                                              ? never
                                                                                                                                                                                                                                                                                                                              : P]: TJSPositionData[P]
                                                                                                                                                                                                                                                                                                                      }> & {
                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines an extension to Data.TJSPositionData where each animatable property defined by +TJSPositionDataRelative | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias TJSPositionDataRelative

                                                                                                                                                                                                                                                                                                                      TJSPositionDataRelative: Partial<{
                                                                                                                                                                                                                                                                                                                          [P in keyof TJSPositionData as P extends AnimationKey
                                                                                                                                                                                                                                                                                                                              ? P
                                                                                                                                                                                                                                                                                                                              : never]: TJSPositionData[P] | string
                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                          [P in keyof TJSPositionData as P extends AnimationKey
                                                                                                                                                                                                                                                                                                                              ? never
                                                                                                                                                                                                                                                                                                                              : P]: TJSPositionData[P]
                                                                                                                                                                                                                                                                                                                      }> & {
                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines an extension to Data.TJSPositionData where each animatable property defined by AnimationAPI.AnimationKey can also be a string. Relative adjustments to animatable properties should be a string the form of '+=', '-=', or '*=' and float / numeric value. IE '+=0.2'. TJSPosition.set will apply the addition, subtraction, or multiplication operation specified against the current value of the given property. Various unit types are also supported including: %, %~, px, rad, turn:

                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                      - `no unit type` - The natural value for each property is adjusted which may be `px` for properties like `width`
                                                                                                                                                                                                                                                                                                                      or degrees for rotation based properties.

                                                                                                                                                                                                                                                                                                                      - `%`: Properties such as `width` are calculated against the parent elements client bounds. Other properties such
                                                                                                                                                                                                                                                                                                                      as rotation are a percentage bound by 360 degrees.

                                                                                                                                                                                                                                                                                                                      - `%~`: Relative percentage. Properties are calculated as a percentage of the current value of the property.
                                                                                                                                                                                                                                                                                                                      IE `width: '150%~` results in `150%` of the current width value.

                                                                                                                                                                                                                                                                                                                      - `px`: Only properties that support `px` will be adjusted all other properties like rotation will be rejected
                                                                                                                                                                                                                                                                                                                      with a warning.

                                                                                                                                                                                                                                                                                                                      - `rad`: Only rotation properties may be specified and the rotation is performed in `radians`.

                                                                                                                                                                                                                                                                                                                      - `turn`: Only rotation properties may be specified and rotation is performed in respect to the `turn` CSS
                                                                                                                                                                                                                                                                                                                      specification. `1turn` is 360 degrees. `0.25turn` is 90 degrees.
+
                                                                                                                                                                                                                                                                                                                      - `no unit type` - The natural value for each property is adjusted which may be `px` for properties like `width`
                                                                                                                                                                                                                                                                                                                      or degrees for rotation based properties.

                                                                                                                                                                                                                                                                                                                      - `%`: Properties such as `width` are calculated against the parent elements client bounds. Other properties such
                                                                                                                                                                                                                                                                                                                      as rotation are a percentage bound by 360 degrees.

                                                                                                                                                                                                                                                                                                                      - `%~`: Relative percentage. Properties are calculated as a percentage of the current value of the property.
                                                                                                                                                                                                                                                                                                                      IE `width: '150%~` results in `150%` of the current width value.

                                                                                                                                                                                                                                                                                                                      - `px`: Only properties that support `px` will be adjusted all other properties like rotation will be rejected
                                                                                                                                                                                                                                                                                                                      with a warning.

                                                                                                                                                                                                                                                                                                                      - `rad`: Only rotation properties may be specified and the rotation is performed in `radians`.

                                                                                                                                                                                                                                                                                                                      - `turn`: Only rotation properties may be specified and rotation is performed in respect to the `turn` CSS
                                                                                                                                                                                                                                                                                                                      specification. `1turn` is 360 degrees. `0.25turn` is 90 degrees.
 
                                                                                                                                                                                                                                                                                                                      
+
 
                                                                                                                                                                                                                                                                                                                      Additional properties may be added that are not specified by TJSPositionData and are forwarded through
 ValidatorAPI.ValidationData as the rest property allowing extra data to be sent to any custom validator.
                                                                                                                                                                                                                                                                                                                      
-

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • [key: string]: any

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtor.html b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtor.html index 0071f547..1274e38d 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtor.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtor.html @@ -1,6 +1,7 @@ -OptionsCtor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias OptionsCtor

                                                                                                                                                                                                                                                                                                                      OptionsCtor: {
                                                                                                                                                                                                                                                                                                                          calculateTransform: boolean;
                                                                                                                                                                                                                                                                                                                          initial: InitialSystem;
                                                                                                                                                                                                                                                                                                                          ortho: boolean;
                                                                                                                                                                                                                                                                                                                          validator: ValidatorOption;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the unique options available for setting in the constructor of TJSPosition.

                                                                                                                                                                                                                                                                                                                      +OptionsCtor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias OptionsCtor

                                                                                                                                                                                                                                                                                                                      OptionsCtor: {
                                                                                                                                                                                                                                                                                                                          calculateTransform: boolean;
                                                                                                                                                                                                                                                                                                                          initial: InitialSystem;
                                                                                                                                                                                                                                                                                                                          ortho: boolean;
                                                                                                                                                                                                                                                                                                                          validator: ValidatorOption;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the unique options available for setting in the constructor of TJSPosition.

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • calculateTransform: boolean

                                                                                                                                                                                                                                                                                                                        When true always calculate transform data.

                                                                                                                                                                                                                                                                                                                      • initial: InitialSystem

                                                                                                                                                                                                                                                                                                                        Provides a helper for setting initial position location.

                                                                                                                                                                                                                                                                                                                      • ortho: boolean

                                                                                                                                                                                                                                                                                                                        Sets TJSPosition to orthographic mode using just transform / matrix3d CSS for positioning.

                                                                                                                                                                                                                                                                                                                      • validator: ValidatorOption

                                                                                                                                                                                                                                                                                                                        Provides an initial validator or list of validators.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtorAll.html b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtorAll.html index 514f5121..f6aebeca 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtorAll.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtorAll.html @@ -1,3 +1,4 @@ -OptionsCtorAll | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias OptionsCtorAll

                                                                                                                                                                                                                                                                                                                      OptionsCtorAll: Partial<OptionsCtor & TJSPositionDataExtra>

                                                                                                                                                                                                                                                                                                                      Provides the complete options object including unique TJSPosition options in addition to positional +OptionsCtorAll | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias OptionsCtorAll

                                                                                                                                                                                                                                                                                                                      OptionsCtorAll: Partial<OptionsCtor & TJSPositionDataExtra>

                                                                                                                                                                                                                                                                                                                      Provides the complete options object including unique TJSPosition options in addition to positional data that is available to set in the constructor.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsGet.html b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsGet.html index 41d1ee4f..77b4d9ec 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsGet.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsGet.html @@ -1,6 +1,7 @@ -OptionsGet | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias OptionsGet

                                                                                                                                                                                                                                                                                                                      OptionsGet: {
                                                                                                                                                                                                                                                                                                                          exclude?: Iterable<keyof TJSPositionData>;
                                                                                                                                                                                                                                                                                                                          keys?: Iterable<keyof TJSPositionData>;
                                                                                                                                                                                                                                                                                                                          nullable?: boolean;
                                                                                                                                                                                                                                                                                                                          numeric?: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Options for TJSPosition.get.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional exclude?: Iterable<keyof TJSPositionData>

                                                                                                                                                                                                                                                                                                                        When provided these keys are excluded.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional keys?: Iterable<keyof TJSPositionData>

                                                                                                                                                                                                                                                                                                                        When provided only these keys are copied.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional nullable?: boolean

                                                                                                                                                                                                                                                                                                                        When true all nullable values are included.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional numeric?: boolean

                                                                                                                                                                                                                                                                                                                        When true any null values are converted into default numeric values.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +OptionsGet | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias OptionsGet

                                                                                                                                                                                                                                                                                                                      OptionsGet: {
                                                                                                                                                                                                                                                                                                                          exclude?: Iterable<keyof TJSPositionData>;
                                                                                                                                                                                                                                                                                                                          keys?: Iterable<keyof TJSPositionData>;
                                                                                                                                                                                                                                                                                                                          nullable?: boolean;
                                                                                                                                                                                                                                                                                                                          numeric?: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Options for TJSPosition.get.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalexclude?: Iterable<keyof TJSPositionData>

                                                                                                                                                                                                                                                                                                                        When provided these keys are excluded.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalkeys?: Iterable<keyof TJSPositionData>

                                                                                                                                                                                                                                                                                                                        When provided only these keys are copied.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalnullable?: boolean

                                                                                                                                                                                                                                                                                                                        When true all nullable values are included.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalnumeric?: boolean

                                                                                                                                                                                                                                                                                                                        When true any null values are converted into default numeric values.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsSet.html b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsSet.html index 9bad7931..5f7affd4 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsSet.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsSet.html @@ -1,5 +1,6 @@ -OptionsSet | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias OptionsSet

                                                                                                                                                                                                                                                                                                                      OptionsSet: {
                                                                                                                                                                                                                                                                                                                          immediateElementUpdate: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Options for TJSPosition.set.

                                                                                                                                                                                                                                                                                                                      +OptionsSet | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias OptionsSet

                                                                                                                                                                                                                                                                                                                      OptionsSet: {
                                                                                                                                                                                                                                                                                                                          immediateElementUpdate: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Options for TJSPosition.set.

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • immediateElementUpdate: boolean

                                                                                                                                                                                                                                                                                                                        Perform the update to position state immediately. Callers can specify to immediately update the associated element. This is useful if set is called from requestAnimationFrame / rAF. Library integrations like GSAP invoke set from rAF.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionGroup.html b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionGroup.html index f5cc13e3..8f001c10 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionGroup.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionGroup.html @@ -1,2 +1,3 @@ -PositionGroup | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias PositionGroup

                                                                                                                                                                                                                                                                                                                      PositionGroup: TJSPosition | Positionable | Iterable<TJSPosition> | Iterable<Positionable>

                                                                                                                                                                                                                                                                                                                      Defines one or more positions or positionable objects.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +PositionGroup | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias PositionGroup

                                                                                                                                                                                                                                                                                                                      PositionGroup:
                                                                                                                                                                                                                                                                                                                          | TJSPosition
                                                                                                                                                                                                                                                                                                                          | Positionable
                                                                                                                                                                                                                                                                                                                          | Iterable<TJSPosition>
                                                                                                                                                                                                                                                                                                                          | Iterable<Positionable>

                                                                                                                                                                                                                                                                                                                      Defines one or more positions or positionable objects.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionInitial.html b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionInitial.html index 25088e26..a1de6260 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionInitial.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionInitial.html @@ -1,4 +1,5 @@ -PositionInitial | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias PositionInitial

                                                                                                                                                                                                                                                                                                                      PositionInitial: {
                                                                                                                                                                                                                                                                                                                          Centered: InitialSystemConstructor;
                                                                                                                                                                                                                                                                                                                          browserCentered: InitialSystem;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides the default System.Initial.InitialSystem implementations available.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Centered: InitialSystemConstructor

                                                                                                                                                                                                                                                                                                                        The Centered class constructor to instantiate a new instance.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • browserCentered: InitialSystem

                                                                                                                                                                                                                                                                                                                        A locked instance of the Centered initial helper suitable for displaying elements in the browser window.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +PositionInitial | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias PositionInitial

                                                                                                                                                                                                                                                                                                                      PositionInitial: {
                                                                                                                                                                                                                                                                                                                          browserCentered: InitialSystem;
                                                                                                                                                                                                                                                                                                                          Centered: InitialSystemConstructor;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides the default System.Initial.InitialSystem implementations available.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • browserCentered: InitialSystem

                                                                                                                                                                                                                                                                                                                        A locked instance of the Centered initial helper suitable for displaying elements in the browser window.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Centered: InitialSystemConstructor

                                                                                                                                                                                                                                                                                                                        The Centered class constructor to instantiate a new instance.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionParent.html b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionParent.html index bffe72f9..8292a75c 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionParent.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionParent.html @@ -1,3 +1,4 @@ -PositionParent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias PositionParent

                                                                                                                                                                                                                                                                                                                      PositionParent: HTMLElement | {
                                                                                                                                                                                                                                                                                                                          elementTarget?: HTMLElement;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the TJSPosition parent element. Provide either an HTMLElement directly or an object with an +PositionParent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias PositionParent

                                                                                                                                                                                                                                                                                                                      PositionParent: HTMLElement | {
                                                                                                                                                                                                                                                                                                                          elementTarget?: HTMLElement;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the TJSPosition parent element. Provide either an HTMLElement directly or an object with an elementTarget property / accessor defining the parent HTMLElement.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionValidators.html b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionValidators.html index 8a4d4670..ed72fa73 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionValidators.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionValidators.html @@ -1,5 +1,6 @@ -PositionValidators | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias PositionValidators

                                                                                                                                                                                                                                                                                                                      PositionValidators: {
                                                                                                                                                                                                                                                                                                                          TransformBounds: ValidatorSystemConstructor;
                                                                                                                                                                                                                                                                                                                          transformWindow: ValidatorSystem;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides the default System.Initial.ValidatorSystem implementations available.

                                                                                                                                                                                                                                                                                                                      +PositionValidators | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias PositionValidators

                                                                                                                                                                                                                                                                                                                      PositionValidators: {
                                                                                                                                                                                                                                                                                                                          TransformBounds: ValidatorSystemConstructor;
                                                                                                                                                                                                                                                                                                                          transformWindow: ValidatorSystem;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides the default System.Initial.ValidatorSystem implementations available.

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • TransformBounds: ValidatorSystemConstructor

                                                                                                                                                                                                                                                                                                                        The TransformBounds class constructor to instantiate a new instance.

                                                                                                                                                                                                                                                                                                                      • transformWindow: ValidatorSystem

                                                                                                                                                                                                                                                                                                                        A locked instance of the TransformBounds validator suitable for transformed bounds checking against the browser window.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.Stores.html b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.Stores.html index 676459d0..5666ed94 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.Stores.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.Stores.html @@ -1,9 +1,10 @@ -Stores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias Stores

                                                                                                                                                                                                                                                                                                                      Stores: {
                                                                                                                                                                                                                                                                                                                          dimension: Readable<{
                                                                                                                                                                                                                                                                                                                              height: number | "auto" | "inherit";
                                                                                                                                                                                                                                                                                                                              width: number | "auto" | "inherit";
                                                                                                                                                                                                                                                                                                                          }>;
                                                                                                                                                                                                                                                                                                                          element: Readable<HTMLElement>;
                                                                                                                                                                                                                                                                                                                          height: Writable<number | "auto" | "inherit" | null>;
                                                                                                                                                                                                                                                                                                                          left: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          maxHeight: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          maxWidth: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          minHeight: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          minWidth: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          resizeContentHeight: Readable<number | undefined>;
                                                                                                                                                                                                                                                                                                                          resizeContentWidth: Readable<number | undefined>;
                                                                                                                                                                                                                                                                                                                          resizeObservable: Readable<boolean>;
                                                                                                                                                                                                                                                                                                                          resizeObserved: Writable<ResizeObserverData.ResizeObject>;
                                                                                                                                                                                                                                                                                                                          resizeOffsetHeight: Readable<number | undefined>;
                                                                                                                                                                                                                                                                                                                          resizeOffsetWidth: Readable<number | undefined>;
                                                                                                                                                                                                                                                                                                                          rotateX: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          rotateY: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          rotateZ: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          scale: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          top: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          transform: Readable<TransformData>;
                                                                                                                                                                                                                                                                                                                          transformOrigin: TransformOriginWritable;
                                                                                                                                                                                                                                                                                                                          translateX: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          translateY: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          translateZ: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          width: Writable<number | "auto" | "inherit" | null>;
                                                                                                                                                                                                                                                                                                                          zIndex: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines all derived stores for positional properties. These property stores can be used to update the position +Stores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias Stores

                                                                                                                                                                                                                                                                                                                      Stores: {
                                                                                                                                                                                                                                                                                                                          dimension: Readable<{
                                                                                                                                                                                                                                                                                                                              height: number | "auto" | "inherit";
                                                                                                                                                                                                                                                                                                                              width: number | "auto" | "inherit";
                                                                                                                                                                                                                                                                                                                          }>;
                                                                                                                                                                                                                                                                                                                          element: Readable<HTMLElement>;
                                                                                                                                                                                                                                                                                                                          height: Writable<
                                                                                                                                                                                                                                                                                                                              | number
                                                                                                                                                                                                                                                                                                                              | "auto"
                                                                                                                                                                                                                                                                                                                              | "inherit"
                                                                                                                                                                                                                                                                                                                              | null>;
                                                                                                                                                                                                                                                                                                                          left: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          maxHeight: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          maxWidth: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          minHeight: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          minWidth: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          resizeContentHeight: Readable<number | undefined>;
                                                                                                                                                                                                                                                                                                                          resizeContentWidth: Readable<number | undefined>;
                                                                                                                                                                                                                                                                                                                          resizeObservable: Readable<boolean>;
                                                                                                                                                                                                                                                                                                                          resizeObserved: Writable<ResizeObject>;
                                                                                                                                                                                                                                                                                                                          resizeOffsetHeight: Readable<number | undefined>;
                                                                                                                                                                                                                                                                                                                          resizeOffsetWidth: Readable<number | undefined>;
                                                                                                                                                                                                                                                                                                                          rotateX: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          rotateY: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          rotateZ: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          scale: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          top: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          transform: Readable<TransformData>;
                                                                                                                                                                                                                                                                                                                          transformOrigin: TransformOriginWritable;
                                                                                                                                                                                                                                                                                                                          translateX: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          translateY: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          translateZ: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                          width: Writable<
                                                                                                                                                                                                                                                                                                                              | number
                                                                                                                                                                                                                                                                                                                              | "auto"
                                                                                                                                                                                                                                                                                                                              | "inherit"
                                                                                                                                                                                                                                                                                                                              | null>;
                                                                                                                                                                                                                                                                                                                          zIndex: Writable<number | null>;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines all derived stores for positional properties. These property stores can be used to update the position state.

                                                                                                                                                                                                                                                                                                                      There are several readable stores for additional derived data.

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • dimension: Readable<{
                                                                                                                                                                                                                                                                                                                            height: number | "auto" | "inherit";
                                                                                                                                                                                                                                                                                                                            width: number | "auto" | "inherit";
                                                                                                                                                                                                                                                                                                                        }>

                                                                                                                                                                                                                                                                                                                        Readable store for dimension data.

                                                                                                                                                                                                                                                                                                                      • element: Readable<HTMLElement>

                                                                                                                                                                                                                                                                                                                        Readable store for current element.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • height: Writable<number | "auto" | "inherit" | null>

                                                                                                                                                                                                                                                                                                                        Derived store for height updates.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • height: Writable<
                                                                                                                                                                                                                                                                                                                            | number
                                                                                                                                                                                                                                                                                                                            | "auto"
                                                                                                                                                                                                                                                                                                                            | "inherit"
                                                                                                                                                                                                                                                                                                                            | null>

                                                                                                                                                                                                                                                                                                                        Derived store for height updates.

                                                                                                                                                                                                                                                                                                                      • left: Writable<number | null>

                                                                                                                                                                                                                                                                                                                        Derived store for left updates.

                                                                                                                                                                                                                                                                                                                      • maxHeight: Writable<number | null>

                                                                                                                                                                                                                                                                                                                        Derived store for maxHeight updates.

                                                                                                                                                                                                                                                                                                                      • maxWidth: Writable<number | null>

                                                                                                                                                                                                                                                                                                                        Derived store for maxWidth updates.

                                                                                                                                                                                                                                                                                                                        @@ -13,7 +14,7 @@
                                                                                                                                                                                                                                                                                                                      • resizeContentWidth: Readable<number | undefined>

                                                                                                                                                                                                                                                                                                                        Readable store for contentWidth.

                                                                                                                                                                                                                                                                                                                      • resizeObservable: Readable<boolean>

                                                                                                                                                                                                                                                                                                                        Readable store indicating when width or height is auto or inherit indicating that this position instance is a good candidate for the resizeObserver action.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • resizeObserved: Writable<ResizeObserverData.ResizeObject>

                                                                                                                                                                                                                                                                                                                        Protected store for resize observer updates.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • resizeObserved: Writable<ResizeObject>

                                                                                                                                                                                                                                                                                                                        Protected store for resize observer updates.

                                                                                                                                                                                                                                                                                                                      • resizeOffsetHeight: Readable<number | undefined>

                                                                                                                                                                                                                                                                                                                        Readable store for offsetHeight.

                                                                                                                                                                                                                                                                                                                      • resizeOffsetWidth: Readable<number | undefined>

                                                                                                                                                                                                                                                                                                                        Readable store for offsetWidth.

                                                                                                                                                                                                                                                                                                                      • rotateX: Writable<number | null>

                                                                                                                                                                                                                                                                                                                        Derived store for rotateX updates.

                                                                                                                                                                                                                                                                                                                        @@ -26,6 +27,6 @@
                                                                                                                                                                                                                                                                                                                      • translateX: Writable<number | null>

                                                                                                                                                                                                                                                                                                                        Derived store for translateX updates.

                                                                                                                                                                                                                                                                                                                      • translateY: Writable<number | null>

                                                                                                                                                                                                                                                                                                                        Derived store for translateY updates.

                                                                                                                                                                                                                                                                                                                      • translateZ: Writable<number | null>

                                                                                                                                                                                                                                                                                                                        Derived store for translateZ updates.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • width: Writable<number | "auto" | "inherit" | null>

                                                                                                                                                                                                                                                                                                                        Derived store for width updates.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • width: Writable<
                                                                                                                                                                                                                                                                                                                            | number
                                                                                                                                                                                                                                                                                                                            | "auto"
                                                                                                                                                                                                                                                                                                                            | "inherit"
                                                                                                                                                                                                                                                                                                                            | null>

                                                                                                                                                                                                                                                                                                                        Derived store for width updates.

                                                                                                                                                                                                                                                                                                                      • zIndex: Writable<number | null>

                                                                                                                                                                                                                                                                                                                        Derived store for zIndex updates.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.TransformAPI-1.TransformOrigin.html b/docs/types/_runtime_svelte_store_position.TransformAPI-1.TransformOrigin.html index d381639b..2bcd1bed 100644 --- a/docs/types/_runtime_svelte_store_position.TransformAPI-1.TransformOrigin.html +++ b/docs/types/_runtime_svelte_store_position.TransformAPI-1.TransformOrigin.html @@ -1,2 +1,3 @@ -TransformOrigin | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TransformOrigin

                                                                                                                                                                                                                                                                                                                      TransformOrigin: "top left" | "top center" | "top right" | "center left" | "center" | "center right" | "bottom left" | "bottom center" | "bottom right"

                                                                                                                                                                                                                                                                                                                      The supported transform origin strings.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +TransformOrigin | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias TransformOrigin

                                                                                                                                                                                                                                                                                                                      TransformOrigin:
                                                                                                                                                                                                                                                                                                                          | "top left"
                                                                                                                                                                                                                                                                                                                          | "top center"
                                                                                                                                                                                                                                                                                                                          | "top right"
                                                                                                                                                                                                                                                                                                                          | "center left"
                                                                                                                                                                                                                                                                                                                          | "center"
                                                                                                                                                                                                                                                                                                                          | "center right"
                                                                                                                                                                                                                                                                                                                          | "bottom left"
                                                                                                                                                                                                                                                                                                                          | "bottom center"
                                                                                                                                                                                                                                                                                                                          | "bottom right"

                                                                                                                                                                                                                                                                                                                      The supported transform origin strings.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.RemoveByCallback.html b/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.RemoveByCallback.html index f6f67b1b..343bcf4d 100644 --- a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.RemoveByCallback.html +++ b/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.RemoveByCallback.html @@ -1,3 +1,4 @@ -RemoveByCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias RemoveByCallback

                                                                                                                                                                                                                                                                                                                      RemoveByCallback: ((data) => boolean)

                                                                                                                                                                                                                                                                                                                      Callback function to evaluate each validator entry. Return true to remove.

                                                                                                                                                                                                                                                                                                                      +RemoveByCallback | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias RemoveByCallback

                                                                                                                                                                                                                                                                                                                      RemoveByCallback: ((data: ValidatorData) => boolean)

                                                                                                                                                                                                                                                                                                                      Callback function to evaluate each validator entry. Return true to remove.

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        • (data): boolean

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • data: ValidatorData

                                                                                                                                                                                                                                                                                                                            ValidatorData instance to potentially filter / remove.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidationData.html b/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidationData.html index f739d885..7fb3a6dc 100644 --- a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidationData.html +++ b/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidationData.html @@ -1,4 +1,5 @@ -ValidationData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ValidationData

                                                                                                                                                                                                                                                                                                                      ValidationData: {
                                                                                                                                                                                                                                                                                                                          computed: CSSStyleDeclaration;
                                                                                                                                                                                                                                                                                                                          el: HTMLElement;
                                                                                                                                                                                                                                                                                                                          height: number;
                                                                                                                                                                                                                                                                                                                          marginLeft: number | undefined;
                                                                                                                                                                                                                                                                                                                          marginTop: number | undefined;
                                                                                                                                                                                                                                                                                                                          maxHeight: number | undefined;
                                                                                                                                                                                                                                                                                                                          maxWidth: number | undefined;
                                                                                                                                                                                                                                                                                                                          minHeight: number | undefined;
                                                                                                                                                                                                                                                                                                                          minWidth: number | undefined;
                                                                                                                                                                                                                                                                                                                          parent: PositionParent;
                                                                                                                                                                                                                                                                                                                          position: TJSPositionData;
                                                                                                                                                                                                                                                                                                                          rest: Record<string, any> | undefined;
                                                                                                                                                                                                                                                                                                                          transforms: TransformAPI;
                                                                                                                                                                                                                                                                                                                          width: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      The data passed to validator functions to determine if the new position / TJSPosition data is valid.

                                                                                                                                                                                                                                                                                                                      +ValidationData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ValidationData

                                                                                                                                                                                                                                                                                                                      ValidationData: {
                                                                                                                                                                                                                                                                                                                          computed: CSSStyleDeclaration;
                                                                                                                                                                                                                                                                                                                          el: HTMLElement;
                                                                                                                                                                                                                                                                                                                          height: number;
                                                                                                                                                                                                                                                                                                                          marginLeft: number | undefined;
                                                                                                                                                                                                                                                                                                                          marginTop: number | undefined;
                                                                                                                                                                                                                                                                                                                          maxHeight: number | undefined;
                                                                                                                                                                                                                                                                                                                          maxWidth: number | undefined;
                                                                                                                                                                                                                                                                                                                          minHeight: number | undefined;
                                                                                                                                                                                                                                                                                                                          minWidth: number | undefined;
                                                                                                                                                                                                                                                                                                                          parent: PositionParent;
                                                                                                                                                                                                                                                                                                                          position: TJSPositionData;
                                                                                                                                                                                                                                                                                                                          rest: Record<string, any> | undefined;
                                                                                                                                                                                                                                                                                                                          transforms: TransformAPI;
                                                                                                                                                                                                                                                                                                                          width: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      The data passed to validator functions to determine if the new position / TJSPosition data is valid.

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • computed: CSSStyleDeclaration

                                                                                                                                                                                                                                                                                                                        Computed styles for the element.

                                                                                                                                                                                                                                                                                                                      • el: HTMLElement

                                                                                                                                                                                                                                                                                                                        Associated element being positioned.

                                                                                                                                                                                                                                                                                                                      • height: number

                                                                                                                                                                                                                                                                                                                        Current height

                                                                                                                                                                                                                                                                                                                        @@ -14,4 +15,4 @@ validators.

                                                                                                                                                                                                                                                                                                                      • transforms: TransformAPI

                                                                                                                                                                                                                                                                                                                        Current applies transforms / transform tracking & conversion utility.

                                                                                                                                                                                                                                                                                                                      • width: number

                                                                                                                                                                                                                                                                                                                        Current width

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorData.html b/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorData.html index b9c52314..0b2fef03 100644 --- a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorData.html +++ b/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorData.html @@ -1,9 +1,10 @@ -ValidatorData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ValidatorData

                                                                                                                                                                                                                                                                                                                      ValidatorData: {
                                                                                                                                                                                                                                                                                                                          id?: any;
                                                                                                                                                                                                                                                                                                                          validate: ValidatorFn;
                                                                                                                                                                                                                                                                                                                          weight?: number;
                                                                                                                                                                                                                                                                                                                          subscribe?(this, run, invalidate?): Unsubscriber;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines a validator function entry with optional data such as assigning an id / weight or providing more +ValidatorData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ValidatorData

                                                                                                                                                                                                                                                                                                                      ValidatorData: {
                                                                                                                                                                                                                                                                                                                          id?: any;
                                                                                                                                                                                                                                                                                                                          validate: ValidatorFn;
                                                                                                                                                                                                                                                                                                                          weight?: number;
                                                                                                                                                                                                                                                                                                                          subscribe?(this: void, run: Subscriber<any>, invalidate?: Invalidator<any>): Unsubscriber;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines a validator function entry with optional data such as assigning an id / weight or providing more interactivity through attaching a subscriber function to monitor for updates that triggers validation.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional id?: any

                                                                                                                                                                                                                                                                                                                        An ID associated with this validator. Can be used to remove the validator; default: undefined.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalid?: any

                                                                                                                                                                                                                                                                                                                          An ID associated with this validator. Can be used to remove the validator; default: undefined.

                                                                                                                                                                                                                                                                                                                        • validate: ValidatorFn

                                                                                                                                                                                                                                                                                                                          TJSPosition validator function that takes a Data.TJSPositionData instance potentially modifying it or returning null if invalid.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional weight?: number

                                                                                                                                                                                                                                                                                                                          A number between 0 and 1 inclusive to position this validator against others; default: 1.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalweight?: number

                                                                                                                                                                                                                                                                                                                          A number between 0 and 1 inclusive to position this validator against others; default: 1.

                                                                                                                                                                                                                                                                                                                        • subscribe?:function
                                                                                                                                                                                                                                                                                                                          • subscribe(this, run, invalidate?): Unsubscriber

                                                                                                                                                                                                                                                                                                                          • Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will be processed again.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                            Returns Unsubscriber

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                      Returns Unsubscriber

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorOption.html b/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorOption.html index 6199ed4e..7e4f5d62 100644 --- a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorOption.html +++ b/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorOption.html @@ -1,2 +1,3 @@ -ValidatorOption | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ValidatorOption

                                                                                                                                                                                                                                                                                                                      ValidatorOption: ValidatorFn | ValidatorData | Iterable<ValidatorFn | ValidatorData>

                                                                                                                                                                                                                                                                                                                      Defines the TJSPosition validator option.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +ValidatorOption | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ValidatorOption

                                                                                                                                                                                                                                                                                                                      ValidatorOption: ValidatorFn | ValidatorData | Iterable<ValidatorFn | ValidatorData>

                                                                                                                                                                                                                                                                                                                      Defines the TJSPosition validator option.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynArrayData.html b/docs/types/_runtime_svelte_store_reducer.DynArrayData.html index 2e3e7364..b89527c9 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynArrayData.html +++ b/docs/types/_runtime_svelte_store_reducer.DynArrayData.html @@ -1,3 +1,4 @@ -DynArrayData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynArrayData<T>

                                                                                                                                                                                                                                                                                                                      DynArrayData<T>: {
                                                                                                                                                                                                                                                                                                                          data?: Iterable<T>;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      The main options object for DynArrayReducer.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional data?: Iterable<T>

                                                                                                                                                                                                                                                                                                                        Initial data iterable list.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynArrayData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynArrayData<T>

                                                                                                                                                                                                                                                                                                                      DynArrayData<T>: {
                                                                                                                                                                                                                                                                                                                          data?: Iterable<T>;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      The main options object for DynArrayReducer.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionaldata?: Iterable<T>

                                                                                                                                                                                                                                                                                                                        Initial data iterable list.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynCompareFn.html b/docs/types/_runtime_svelte_store_reducer.DynCompareFn.html index ed132a0a..ef4f9a84 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynCompareFn.html +++ b/docs/types/_runtime_svelte_store_reducer.DynCompareFn.html @@ -1,8 +1,9 @@ -DynCompareFn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynCompareFn<T>

                                                                                                                                                                                                                                                                                                                      DynCompareFn<T>: {
                                                                                                                                                                                                                                                                                                                          subscribe?: ((indexUpdate) => (() => void));
                                                                                                                                                                                                                                                                                                                          (a, b): number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      A callback function that compares two values. Return > 0 to sort 'b' before 'a'; < 0 to sort 'a' before 'b'; or 0 to +DynCompareFn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynCompareFn<T>

                                                                                                                                                                                                                                                                                                                      DynCompareFn<T>: {
                                                                                                                                                                                                                                                                                                                          subscribe?: ((indexUpdate: DynIndexerUpdateFn) => (() => void));
                                                                                                                                                                                                                                                                                                                          (a: T, b: T): number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      A callback function that compares two values. Return > 0 to sort 'b' before 'a'; < 0 to sort 'a' before 'b'; or 0 to keep original order of 'a' & 'b'.

                                                                                                                                                                                                                                                                                                                      This function has an optional subscribe function that follows the Svelte store Subscriber pattern. If a subscribe function is provided automatic updates to the reduced index is performed.

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        • (a, b): number

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • a: T

                                                                                                                                                                                                                                                                                                                            Element 'a' of backing data to sort.

                                                                                                                                                                                                                                                                                                                          • b: T

                                                                                                                                                                                                                                                                                                                            Element 'b' of backing data to sort.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                          Returns number

                                                                                                                                                                                                                                                                                                                      • Optional subscribe?: ((indexUpdate) => (() => void))

                                                                                                                                                                                                                                                                                                                        Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                          • (indexUpdate): (() => void)

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            Returns (() => void)

                                                                                                                                                                                                                                                                                                                              • (): void

                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Returns number

                                                                                                                                                                                                                                                                                                                    • Optionalsubscribe?: ((indexUpdate: DynIndexerUpdateFn) => (() => void))

                                                                                                                                                                                                                                                                                                                      Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                        • (indexUpdate): (() => void)

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          Returns (() => void)

                                                                                                                                                                                                                                                                                                                            • (): void

                                                                                                                                                                                                                                                                                                                            • Returns void

                                                                                                                                                                                                                                                                                                                      • Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynDataArrayCreate.html b/docs/types/_runtime_svelte_store_reducer.DynDataArrayCreate.html index abf0f224..4c9ab022 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataArrayCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataArrayCreate.html @@ -1,4 +1,5 @@ -DynDataArrayCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynDataArrayCreate<T>

                                                                                                                                                                                                                                                                                                                      DynDataArrayCreate<T>: {
                                                                                                                                                                                                                                                                                                                          ctor?: IDynArrayReducerCtor<T>;
                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      Defines object / options for creating a dynamic array reducer.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional ctor?: IDynArrayReducerCtor<T>

                                                                                                                                                                                                                                                                                                                        A DynMapReducer constructor function / class.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional name?: string

                                                                                                                                                                                                                                                                                                                        Name of dynamic array reducer.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynDataArrayCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynDataArrayCreate<T>

                                                                                                                                                                                                                                                                                                                      DynDataArrayCreate<T>: {
                                                                                                                                                                                                                                                                                                                          ctor?: IDynArrayReducerCtor<T>;
                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      Defines object / options for creating a dynamic array reducer.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalctor?: IDynArrayReducerCtor<T>

                                                                                                                                                                                                                                                                                                                        A DynMapReducer constructor function / class.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalname?: string

                                                                                                                                                                                                                                                                                                                        Name of dynamic array reducer.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynDataDerivedCreate.html b/docs/types/_runtime_svelte_store_reducer.DynDataDerivedCreate.html index 32c24ca0..9a9cf107 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataDerivedCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataDerivedCreate.html @@ -1,4 +1,5 @@ -DynDataDerivedCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynDataDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                      DynDataDerivedCreate<T>: {
                                                                                                                                                                                                                                                                                                                          ctor?: IDynDerivedReducerCtor<T>;
                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      Defines object / options for creating a derived reducer.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional ctor?: IDynDerivedReducerCtor<T>

                                                                                                                                                                                                                                                                                                                        A DerivedReducer constructor function / class.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional name?: string

                                                                                                                                                                                                                                                                                                                        Name of derived reducer.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynDataDerivedCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynDataDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                      DynDataDerivedCreate<T>: {
                                                                                                                                                                                                                                                                                                                          ctor?: IDynDerivedReducerCtor<T>;
                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      Defines object / options for creating a derived reducer.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalctor?: IDynDerivedReducerCtor<T>

                                                                                                                                                                                                                                                                                                                        A DerivedReducer constructor function / class.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalname?: string

                                                                                                                                                                                                                                                                                                                        Name of derived reducer.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynDataFilter.html b/docs/types/_runtime_svelte_store_reducer.DynDataFilter.html index 7a2f9a2c..8e0fe90b 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataFilter.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataFilter.html @@ -1,6 +1,7 @@ -DynDataFilter | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynDataFilter<T>

                                                                                                                                                                                                                                                                                                                      DynDataFilter<T>: {
                                                                                                                                                                                                                                                                                                                          filter: DynFilterFn<T>;
                                                                                                                                                                                                                                                                                                                          id?: any;
                                                                                                                                                                                                                                                                                                                          subscribe?: ((indexUpdate) => (() => void));
                                                                                                                                                                                                                                                                                                                          weight?: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the data object to configure a filter w/ additional configuration options.

                                                                                                                                                                                                                                                                                                                      +DynDataFilter | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynDataFilter<T>

                                                                                                                                                                                                                                                                                                                      DynDataFilter<T>: {
                                                                                                                                                                                                                                                                                                                          filter: DynFilterFn<T>;
                                                                                                                                                                                                                                                                                                                          id?: any;
                                                                                                                                                                                                                                                                                                                          subscribe?: ((indexUpdate: DynIndexerUpdateFn) => (() => void));
                                                                                                                                                                                                                                                                                                                          weight?: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the data object to configure a filter w/ additional configuration options.

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • filter: DynFilterFn<T>

                                                                                                                                                                                                                                                                                                                        Filter function that takes a value argument and returns a truthy value to keep it.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional id?: any

                                                                                                                                                                                                                                                                                                                        An optional ID associated with this filter. Can be used to remove the filter.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional subscribe?: ((indexUpdate) => (() => void))

                                                                                                                                                                                                                                                                                                                        Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                          • (indexUpdate): (() => void)

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            Returns (() => void)

                                                                                                                                                                                                                                                                                                                              • (): void

                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                      • Optional weight?: number

                                                                                                                                                                                                                                                                                                                        An optional number between 0 and 1 inclusive to position this filter against others.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                    • Optionalid?: any

                                                                                                                                                                                                                                                                                                                      An optional ID associated with this filter. Can be used to remove the filter.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                    • Optionalsubscribe?: ((indexUpdate: DynIndexerUpdateFn) => (() => void))

                                                                                                                                                                                                                                                                                                                      Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                        • (indexUpdate): (() => void)

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          Returns (() => void)

                                                                                                                                                                                                                                                                                                                            • (): void

                                                                                                                                                                                                                                                                                                                            • Returns void

                                                                                                                                                                                                                                                                                                                    • Optionalweight?: number

                                                                                                                                                                                                                                                                                                                      An optional number between 0 and 1 inclusive to position this filter against others.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      • Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynDataHost.html b/docs/types/_runtime_svelte_store_reducer.DynDataHost.html index abd67792..0b1d2836 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataHost.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataHost.html @@ -1,2 +1,3 @@ -DynDataHost | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynDataHost<D>

                                                                                                                                                                                                                                                                                                                      DynDataHost<D>: (D | null)[]

                                                                                                                                                                                                                                                                                                                      Provides a compound type for the backing data structure stored in reducers.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • D

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynDataHost | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynDataHost<D>

                                                                                                                                                                                                                                                                                                                      DynDataHost<D>: (D | null)[]

                                                                                                                                                                                                                                                                                                                      Provides a compound type for the backing data structure stored in reducers.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • D

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynDataMapCreate.html b/docs/types/_runtime_svelte_store_reducer.DynDataMapCreate.html index d74caa39..af61cd0b 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataMapCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataMapCreate.html @@ -1,4 +1,5 @@ -DynDataMapCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynDataMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                      DynDataMapCreate<K, T>: {
                                                                                                                                                                                                                                                                                                                          ctor?: IDynMapReducerCtor<K, T>;
                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      Defines object / options for creating a dynamic map reducer.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • K
                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional ctor?: IDynMapReducerCtor<K, T>

                                                                                                                                                                                                                                                                                                                        A DynMapReducer constructor function / class.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional name?: string

                                                                                                                                                                                                                                                                                                                        Name of dynamic map reducer.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynDataMapCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynDataMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                      DynDataMapCreate<K, T>: {
                                                                                                                                                                                                                                                                                                                          ctor?: IDynMapReducerCtor<K, T>;
                                                                                                                                                                                                                                                                                                                          name?: string;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      Defines object / options for creating a dynamic map reducer.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • K
                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionalctor?: IDynMapReducerCtor<K, T>

                                                                                                                                                                                                                                                                                                                        A DynMapReducer constructor function / class.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalname?: string

                                                                                                                                                                                                                                                                                                                        Name of dynamic map reducer.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynDataOptions.html b/docs/types/_runtime_svelte_store_reducer.DynDataOptions.html index 086d1f51..53787f29 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataOptions.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataOptions.html @@ -1,4 +1,5 @@ -DynDataOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      DynDataOptions<T>: {
                                                                                                                                                                                                                                                                                                                          filters?: Iterable<DynFilterFn<T> | DynDataFilter<T>>;
                                                                                                                                                                                                                                                                                                                          sort?: DynCompareFn<T> | DynDataSort<T>;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the additional options for filters and sort function.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynDataOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      DynDataOptions<T>: {
                                                                                                                                                                                                                                                                                                                          filters?: Iterable<DynFilterFn<T> | DynDataFilter<T>>;
                                                                                                                                                                                                                                                                                                                          sort?: DynCompareFn<T> | DynDataSort<T>;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the additional options for filters and sort function.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynDataSort.html b/docs/types/_runtime_svelte_store_reducer.DynDataSort.html index 26aa9131..eeb58024 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataSort.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataSort.html @@ -1,4 +1,5 @@ -DynDataSort | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynDataSort<T>

                                                                                                                                                                                                                                                                                                                      DynDataSort<T>: {
                                                                                                                                                                                                                                                                                                                          compare: DynCompareFn<T>;
                                                                                                                                                                                                                                                                                                                          subscribe?: ((indexUpdate) => (() => void));
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines an object to configure sort functionality.

                                                                                                                                                                                                                                                                                                                      +DynDataSort | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynDataSort<T>

                                                                                                                                                                                                                                                                                                                      DynDataSort<T>: {
                                                                                                                                                                                                                                                                                                                          compare: DynCompareFn<T>;
                                                                                                                                                                                                                                                                                                                          subscribe?: ((indexUpdate: DynIndexerUpdateFn) => (() => void));
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines an object to configure sort functionality.

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • compare: DynCompareFn<T>

                                                                                                                                                                                                                                                                                                                        A callback function that compares two values.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional subscribe?: ((indexUpdate) => (() => void))

                                                                                                                                                                                                                                                                                                                        Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                          • (indexUpdate): (() => void)

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            Returns (() => void)

                                                                                                                                                                                                                                                                                                                              • (): void

                                                                                                                                                                                                                                                                                                                              • Returns void

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                    • Optionalsubscribe?: ((indexUpdate: DynIndexerUpdateFn) => (() => void))

                                                                                                                                                                                                                                                                                                                      Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                        • (indexUpdate): (() => void)

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          Returns (() => void)

                                                                                                                                                                                                                                                                                                                            • (): void

                                                                                                                                                                                                                                                                                                                            • Returns void

                                                                                                                                                                                                                                                                                                                      • Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynFilterFn.html b/docs/types/_runtime_svelte_store_reducer.DynFilterFn.html index 3f71e1a2..1b3ec4ac 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynFilterFn.html +++ b/docs/types/_runtime_svelte_store_reducer.DynFilterFn.html @@ -1,7 +1,9 @@ -DynFilterFn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynFilterFn<T>

                                                                                                                                                                                                                                                                                                                      DynFilterFn<T>: {
                                                                                                                                                                                                                                                                                                                          subscribe?: ((indexUpdate) => (() => void));
                                                                                                                                                                                                                                                                                                                          (element): boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Filter function that takes an element argument and returns a truthy value to keep it.

                                                                                                                                                                                                                                                                                                                      +DynFilterFn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynFilterFn<T>

                                                                                                                                                                                                                                                                                                                      DynFilterFn<T>: {
                                                                                                                                                                                                                                                                                                                          subscribe?: ((indexUpdate: DynIndexerUpdateFn) => (() => void));
                                                                                                                                                                                                                                                                                                                          (element: T): boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Filter function that takes an element argument and returns a truthy value to keep it.

                                                                                                                                                                                                                                                                                                                      This function has an optional subscribe function that follows the Svelte store Subscriber pattern. If a subscribe function is provided automatic updates to the reduced index is performed.

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        • (element): boolean

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • element: T

                                                                                                                                                                                                                                                                                                                            Element of backing data structure to filter.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                      • Optional subscribe?: ((indexUpdate) => (() => void))

                                                                                                                                                                                                                                                                                                                        Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Returns boolean

                                                                                                                                                                                                                                                                                                                      Does the element pass the filter test.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                    • Optionalsubscribe?: ((indexUpdate: DynIndexerUpdateFn) => (() => void))

                                                                                                                                                                                                                                                                                                                      Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                        • (indexUpdate): (() => void)

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • indexUpdate: DynIndexerUpdateFn

                                                                                                                                                                                                                                                                                                                            Callback function that is invoked on update / changes. Receives this reference.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                          Returns (() => void)

                                                                                                                                                                                                                                                                                                                            • (): void

                                                                                                                                                                                                                                                                                                                            • Returns void

                                                                                                                                                                                                                                                                                                                      • Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Returns (() => void)

                                                                                                                                                                                                                                                                                                                        • (): void

                                                                                                                                                                                                                                                                                                                        • Returns void

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynIndexerUpdateFn.html b/docs/types/_runtime_svelte_store_reducer.DynIndexerUpdateFn.html index 9bf3cdff..14a15efc 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynIndexerUpdateFn.html +++ b/docs/types/_runtime_svelte_store_reducer.DynIndexerUpdateFn.html @@ -1,3 +1,4 @@ -DynIndexerUpdateFn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynIndexerUpdateFn

                                                                                                                                                                                                                                                                                                                      DynIndexerUpdateFn: ((force?) => void)

                                                                                                                                                                                                                                                                                                                      Updates associated dynamic reducer indexer.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        • (force?): void

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • Optional force: boolean

                                                                                                                                                                                                                                                                                                                            Force an update the index regardless of hash calculations.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynIndexerUpdateFn | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynIndexerUpdateFn

                                                                                                                                                                                                                                                                                                                      DynIndexerUpdateFn: ((force?: boolean) => void)

                                                                                                                                                                                                                                                                                                                      Updates associated dynamic reducer indexer.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        • (force?): void

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • Optionalforce: boolean

                                                                                                                                                                                                                                                                                                                            Force an update the index regardless of hash calculations.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynMapData.html b/docs/types/_runtime_svelte_store_reducer.DynMapData.html index 212e2f84..a996a8be 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynMapData.html +++ b/docs/types/_runtime_svelte_store_reducer.DynMapData.html @@ -1,3 +1,4 @@ -DynMapData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynMapData<K, T>

                                                                                                                                                                                                                                                                                                                      DynMapData<K, T>: {
                                                                                                                                                                                                                                                                                                                          data?: Map<K, T>;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      The main options object for DynMapReducer.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • K
                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional data?: Map<K, T>

                                                                                                                                                                                                                                                                                                                        Optional initial backing Map.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynMapData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynMapData<K, T>

                                                                                                                                                                                                                                                                                                                      DynMapData<K, T>: {
                                                                                                                                                                                                                                                                                                                          data?: Map<K, T>;
                                                                                                                                                                                                                                                                                                                      } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                      The main options object for DynMapReducer.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • K
                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionaldata?: Map<K, T>

                                                                                                                                                                                                                                                                                                                        Optional initial backing Map.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynOptionsArrayCreate.html b/docs/types/_runtime_svelte_store_reducer.DynOptionsArrayCreate.html index 9c63c44e..0c0e42d3 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynOptionsArrayCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynOptionsArrayCreate.html @@ -1 +1,2 @@ -DynOptionsArrayCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynOptionsArrayCreate<T>

                                                                                                                                                                                                                                                                                                                      DynOptionsArrayCreate<T>: string | IDynArrayReducerCtor<T> | DynDataArrayCreate<T>

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynOptionsArrayCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynOptionsArrayCreate<T>

                                                                                                                                                                                                                                                                                                                      DynOptionsArrayCreate<T>: string | IDynArrayReducerCtor<T> | DynDataArrayCreate<T>

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynOptionsDerivedCreate.html b/docs/types/_runtime_svelte_store_reducer.DynOptionsDerivedCreate.html index 8e6a8b17..c94a55e9 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynOptionsDerivedCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynOptionsDerivedCreate.html @@ -1,2 +1,3 @@ -DynOptionsDerivedCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynOptionsDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                      DynOptionsDerivedCreate<T>: string | IDynDerivedReducerCtor<T> | DynDataDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                      Creates a compound type for all derived reducer 'create' option combinations.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynOptionsDerivedCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynOptionsDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                      DynOptionsDerivedCreate<T>: string | IDynDerivedReducerCtor<T> | DynDataDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                      Creates a compound type for all derived reducer 'create' option combinations.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer.DynOptionsMapCreate.html b/docs/types/_runtime_svelte_store_reducer.DynOptionsMapCreate.html index 292a5c77..64476ed6 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynOptionsMapCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynOptionsMapCreate.html @@ -1 +1,2 @@ -DynOptionsMapCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias DynOptionsMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                      DynOptionsMapCreate<K, T>: string | IDynMapReducerCtor<K, T> | DynDataMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • K
                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +DynOptionsMapCreate | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias DynOptionsMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                      DynOptionsMapCreate<K, T>: string | IDynMapReducerCtor<K, T> | DynDataMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • K
                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectStoreParams.html b/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectStoreParams.html index 700a19c3..323348bf 100644 --- a/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectStoreParams.html +++ b/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectStoreParams.html @@ -1,10 +1,11 @@ -ArrayObjectStoreParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ArrayObjectStoreParams

                                                                                                                                                                                                                                                                                                                      ArrayObjectStoreParams: {
                                                                                                                                                                                                                                                                                                                          StoreClass: BaseArrayObjectEntryStore;
                                                                                                                                                                                                                                                                                                                          childDebounce?: number;
                                                                                                                                                                                                                                                                                                                          dataReducer?: boolean;
                                                                                                                                                                                                                                                                                                                          defaultData?: object[];
                                                                                                                                                                                                                                                                                                                          manualUpdate?: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • StoreClass: BaseArrayObjectEntryStore

                                                                                                                                                                                                                                                                                                                        The entry store class that is instantiated.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional childDebounce?: number

                                                                                                                                                                                                                                                                                                                        An integer between and including 0 - 1000; a debounce time in +ArrayObjectStoreParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias ArrayObjectStoreParams

                                                                                                                                                                                                                                                                                                                        ArrayObjectStoreParams: {
                                                                                                                                                                                                                                                                                                                            childDebounce?: number;
                                                                                                                                                                                                                                                                                                                            dataReducer?: boolean;
                                                                                                                                                                                                                                                                                                                            defaultData?: object[];
                                                                                                                                                                                                                                                                                                                            manualUpdate?: boolean;
                                                                                                                                                                                                                                                                                                                            StoreClass: BaseArrayObjectEntryStore;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • OptionalchildDebounce?: number

                                                                                                                                                                                                                                                                                                                          An integer between and including 0 - 1000; a debounce time in milliseconds for child store subscriptions to invoke ArrayObjectStore.updateSubscribers notifying subscribers to this array store.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional dataReducer?: boolean

                                                                                                                                                                                                                                                                                                                          When true a DynArrayReducer will be instantiated wrapping store +

                                                                                                                                                                                                                                                                                                                        • OptionaldataReducer?: boolean

                                                                                                                                                                                                                                                                                                                          When true a DynArrayReducer will be instantiated wrapping store data and accessible from ArrayObjectStore.dataReducer.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional defaultData?: object[]

                                                                                                                                                                                                                                                                                                                          An array of default data objects.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional manualUpdate?: boolean

                                                                                                                                                                                                                                                                                                                          When true ArrayObjectStore.updateSubscribers must be invoked +

                                                                                                                                                                                                                                                                                                                        • OptionaldefaultData?: object[]

                                                                                                                                                                                                                                                                                                                          An array of default data objects.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • OptionalmanualUpdate?: boolean

                                                                                                                                                                                                                                                                                                                          When true ArrayObjectStore.updateSubscribers must be invoked with a single boolean parameter for subscribers to be updated.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                      • StoreClass: BaseArrayObjectEntryStore

                                                                                                                                                                                                                                                                                                                        The entry store class that is instantiated.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectUpdateData.html b/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectUpdateData.html index 6b91e103..b9274981 100644 --- a/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectUpdateData.html +++ b/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectUpdateData.html @@ -1 +1,2 @@ -ArrayObjectUpdateData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ArrayObjectUpdateData

                                                                                                                                                                                                                                                                                                                      ArrayObjectUpdateData: boolean | object | undefined

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +ArrayObjectUpdateData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ArrayObjectUpdateData

                                                                                                                                                                                                                                                                                                                      ArrayObjectUpdateData: boolean | object | undefined

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array_object.BaseArrayObjectEntryStore.html b/docs/types/_runtime_svelte_store_reducer_array_object.BaseArrayObjectEntryStore.html index 3306ecd0..33f64212 100644 --- a/docs/types/_runtime_svelte_store_reducer_array_object.BaseArrayObjectEntryStore.html +++ b/docs/types/_runtime_svelte_store_reducer_array_object.BaseArrayObjectEntryStore.html @@ -1 +1,2 @@ -BaseArrayObjectEntryStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias BaseArrayObjectEntryStore

                                                                                                                                                                                                                                                                                                                      BaseArrayObjectEntryStore: Writable<any> & {
                                                                                                                                                                                                                                                                                                                          get id(): string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • get id(): string

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +BaseArrayObjectEntryStore | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias BaseArrayObjectEntryStore

                                                                                                                                                                                                                                                                                                                      BaseArrayObjectEntryStore: Writable<any> & {
                                                                                                                                                                                                                                                                                                                          get id(): string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParamProps.html b/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParamProps.html index 078184fb..28a568c5 100644 --- a/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParamProps.html +++ b/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParamProps.html @@ -1,7 +1,8 @@ -CrudArrayObjectStoreParamProps | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias CrudArrayObjectStoreParamProps

                                                                                                                                                                                                                                                                                                                      CrudArrayObjectStoreParamProps: {
                                                                                                                                                                                                                                                                                                                          crudDispatch?: CrudDispatch;
                                                                                                                                                                                                                                                                                                                          extraData?: object;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParams.html b/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParams.html index 66da56cd..6c7cb2d1 100644 --- a/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParams.html +++ b/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParams.html @@ -1 +1,2 @@ -CrudArrayObjectStoreParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias CrudArrayObjectStoreParams

                                                                                                                                                                                                                                                                                                                      CrudArrayObjectStoreParams: ArrayObjectStoreParams & CrudArrayObjectStoreParamProps

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +CrudArrayObjectStoreParams | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias CrudArrayObjectStoreParams

                                                                                                                                                                                                                                                                                                                      CrudArrayObjectStoreParams: ArrayObjectStoreParams & CrudArrayObjectStoreParamProps

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_reducer_array_object.CrudDispatch.html b/docs/types/_runtime_svelte_store_reducer_array_object.CrudDispatch.html index c0d330dc..845cb32b 100644 --- a/docs/types/_runtime_svelte_store_reducer_array_object.CrudDispatch.html +++ b/docs/types/_runtime_svelte_store_reducer_array_object.CrudDispatch.html @@ -1,3 +1,4 @@ -CrudDispatch | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias CrudDispatch

                                                                                                                                                                                                                                                                                                                      CrudDispatch: ((data) => boolean)

                                                                                                                                                                                                                                                                                                                      A function that accepts an object w/ 'action', 'moduleId', 'key' properties and optional 'id' / UUIDv4 string and +CrudDispatch | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias CrudDispatch

                                                                                                                                                                                                                                                                                                                      CrudDispatch: ((data: {
                                                                                                                                                                                                                                                                                                                          action: string;
                                                                                                                                                                                                                                                                                                                          data?: object;
                                                                                                                                                                                                                                                                                                                          id?: string;
                                                                                                                                                                                                                                                                                                                      }) => boolean)

                                                                                                                                                                                                                                                                                                                      A function that accepts an object w/ 'action', 'moduleId', 'key' properties and optional 'id' / UUIDv4 string and 'data' property.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        • (data): boolean

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • data: {
                                                                                                                                                                                                                                                                                                                                action: string;
                                                                                                                                                                                                                                                                                                                                data?: object;
                                                                                                                                                                                                                                                                                                                                id?: string;
                                                                                                                                                                                                                                                                                                                            }
                                                                                                                                                                                                                                                                                                                            • action: string
                                                                                                                                                                                                                                                                                                                            • Optional data?: object
                                                                                                                                                                                                                                                                                                                            • Optional id?: string

                                                                                                                                                                                                                                                                                                                          Returns boolean

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_web_storage.StorageDerived.html b/docs/types/_runtime_svelte_store_web_storage.StorageDerived.html index afd3ae03..74358d44 100644 --- a/docs/types/_runtime_svelte_store_web_storage.StorageDerived.html +++ b/docs/types/_runtime_svelte_store_web_storage.StorageDerived.html @@ -1,6 +1,7 @@ -StorageDerived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias StorageDerived

                                                                                                                                                                                                                                                                                                                      StorageDerived: (<S, T>(key, stores, fn, initial_value?) => Readable<T>)

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        • <S, T>(key, stores, fn, initial_value?): Readable<T>

                                                                                                                                                                                                                                                                                                                        • Type Parameters

                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                          • key: string

                                                                                                                                                                                                                                                                                                                            Storage key.

                                                                                                                                                                                                                                                                                                                            +StorageDerived | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Type Alias StorageDerived

                                                                                                                                                                                                                                                                                                                            StorageDerived: (<S, T>(key: string, stores: S, fn: Deriver<S, T>, initial_value?: T) => Readable<T>)

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                              • <S, T>(key, stores, fn, initial_value?): Readable<T>

                                                                                                                                                                                                                                                                                                                              • Type Parameters

                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                • key: string

                                                                                                                                                                                                                                                                                                                                  Storage key.

                                                                                                                                                                                                                                                                                                                                • stores: S

                                                                                                                                                                                                                                                                                                                                  Input stores.

                                                                                                                                                                                                                                                                                                                                • fn: Deriver<S, T>

                                                                                                                                                                                                                                                                                                                                  Function callback that aggregates the values.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional initial_value: T

                                                                                                                                                                                                                                                                                                                                  When used asynchronously.

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                Returns Readable<T>

                                                                                                                                                                                                                                                                                                                            Returns

                                                                                                                                                                                                                                                                                                                            A derived storage store.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                          • Optionalinitial_value: T

                                                                                                                                                                                                                                                                                                                            When used asynchronously.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                          Returns Readable<T>

                                                                                                                                                                                                                                                                                                                          A derived storage store.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_web_storage.StorageReadable.html b/docs/types/_runtime_svelte_store_web_storage.StorageReadable.html index f6aa3639..df3ae500 100644 --- a/docs/types/_runtime_svelte_store_web_storage.StorageReadable.html +++ b/docs/types/_runtime_svelte_store_web_storage.StorageReadable.html @@ -1,6 +1,7 @@ -StorageReadable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias StorageReadable

                                                                                                                                                                                                                                                                                                                      StorageReadable: (<T>(key, value, start) => Readable<T>)

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Returns Readable<T>

                                                                                                                                                                                                                                                                                                                      A readable storage store.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_web_storage.StorageStores.html b/docs/types/_runtime_svelte_store_web_storage.StorageStores.html index ae4a027d..b013caec 100644 --- a/docs/types/_runtime_svelte_store_web_storage.StorageStores.html +++ b/docs/types/_runtime_svelte_store_web_storage.StorageStores.html @@ -1,3 +1,4 @@ -StorageStores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias StorageStores

                                                                                                                                                                                                                                                                                                                      StorageStores: {
                                                                                                                                                                                                                                                                                                                          derived: StorageDerived;
                                                                                                                                                                                                                                                                                                                          deserialize: ((value, ...rest) => any);
                                                                                                                                                                                                                                                                                                                          readable: StorageReadable;
                                                                                                                                                                                                                                                                                                                          serialize: ((value, ...rest) => string);
                                                                                                                                                                                                                                                                                                                          storage: Storage;
                                                                                                                                                                                                                                                                                                                          writable: StorageWritable;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      The generated web storage store helper functions along with the associated storage API source and serialization +StorageStores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias StorageStores

                                                                                                                                                                                                                                                                                                                      StorageStores: {
                                                                                                                                                                                                                                                                                                                          derived: StorageDerived;
                                                                                                                                                                                                                                                                                                                          deserialize: ((value: string, ...rest: any[]) => any);
                                                                                                                                                                                                                                                                                                                          readable: StorageReadable;
                                                                                                                                                                                                                                                                                                                          serialize: ((value: any, ...rest: any[]) => string);
                                                                                                                                                                                                                                                                                                                          storage: Storage;
                                                                                                                                                                                                                                                                                                                          writable: StorageWritable;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      The generated web storage store helper functions along with the associated storage API source and serialization strategy.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • derived: StorageDerived
                                                                                                                                                                                                                                                                                                                      • deserialize: ((value, ...rest) => any)
                                                                                                                                                                                                                                                                                                                          • (value, ...rest): any

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • value: string
                                                                                                                                                                                                                                                                                                                            • Rest ...rest: any[]

                                                                                                                                                                                                                                                                                                                            Returns any

                                                                                                                                                                                                                                                                                                                      • readable: StorageReadable
                                                                                                                                                                                                                                                                                                                      • serialize: ((value, ...rest) => string)
                                                                                                                                                                                                                                                                                                                          • (value, ...rest): string

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • value: any
                                                                                                                                                                                                                                                                                                                            • Rest ...rest: any[]

                                                                                                                                                                                                                                                                                                                            Returns string

                                                                                                                                                                                                                                                                                                                      • storage: Storage
                                                                                                                                                                                                                                                                                                                      • writable: StorageWritable

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_web_storage.StorageWritable.html b/docs/types/_runtime_svelte_store_web_storage.StorageWritable.html index aa045197..c85eeaad 100644 --- a/docs/types/_runtime_svelte_store_web_storage.StorageWritable.html +++ b/docs/types/_runtime_svelte_store_web_storage.StorageWritable.html @@ -1,6 +1,7 @@ -StorageWritable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias StorageWritable

                                                                                                                                                                                                                                                                                                                      StorageWritable: (<T>(key, value, start?) => Writable<T>)

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Returns Writable<T>

                                                                                                                                                                                                                                                                                                                      A writable storage store.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_writable_derived.MinimalWritable.html b/docs/types/_runtime_svelte_store_writable_derived.MinimalWritable.html index ec1c316f..1abf0ce5 100644 --- a/docs/types/_runtime_svelte_store_writable_derived.MinimalWritable.html +++ b/docs/types/_runtime_svelte_store_writable_derived.MinimalWritable.html @@ -1,3 +1,4 @@ -MinimalWritable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias MinimalWritable<T>

                                                                                                                                                                                                                                                                                                                      MinimalWritable<T>: Pick<Writable<T>, "set" | "subscribe">

                                                                                                                                                                                                                                                                                                                      The minimal requirements of the -writable store contract.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +MinimalWritable | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias MinimalWritable<T>

                                                                                                                                                                                                                                                                                                                      MinimalWritable<T>: Pick<Writable<T>, "set" | "subscribe">

                                                                                                                                                                                                                                                                                                                      The minimal requirements of the +writable store contract.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_writable_derived.SetValues.html b/docs/types/_runtime_svelte_store_writable_derived.SetValues.html index 6ada2965..89f13cc0 100644 --- a/docs/types/_runtime_svelte_store_writable_derived.SetValues.html +++ b/docs/types/_runtime_svelte_store_writable_derived.SetValues.html @@ -1,2 +1,3 @@ -SetValues | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias SetValues<T>

                                                                                                                                                                                                                                                                                                                      SetValues<T>: T extends MinimalWritable<infer U>
                                                                                                                                                                                                                                                                                                                          ? U
                                                                                                                                                                                                                                                                                                                          : {
                                                                                                                                                                                                                                                                                                                              [K in keyof T]?: T[K] extends MinimalWritable<infer U>
                                                                                                                                                                                                                                                                                                                                  ? U
                                                                                                                                                                                                                                                                                                                                  : never
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                      Values sent to origin stores.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +SetValues | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias SetValues<T>

                                                                                                                                                                                                                                                                                                                      SetValues<T>: T extends MinimalWritable<infer U>
                                                                                                                                                                                                                                                                                                                          ? U
                                                                                                                                                                                                                                                                                                                          : {
                                                                                                                                                                                                                                                                                                                              [K in keyof T]?: T[K] extends MinimalWritable<infer U>
                                                                                                                                                                                                                                                                                                                                  ? U
                                                                                                                                                                                                                                                                                                                                  : never
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                      Values sent to origin stores.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_writable_derived.Stores.html b/docs/types/_runtime_svelte_store_writable_derived.Stores.html index 8e81fbe5..ee6e719f 100644 --- a/docs/types/_runtime_svelte_store_writable_derived.Stores.html +++ b/docs/types/_runtime_svelte_store_writable_derived.Stores.html @@ -1,2 +1,3 @@ -Stores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias Stores

                                                                                                                                                                                                                                                                                                                      Stores: MinimalWritable<any> | [Readable<any>, ...Readable<any>[]] | Readable<any>[]

                                                                                                                                                                                                                                                                                                                      Stores that may be used as origins.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Stores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias Stores

                                                                                                                                                                                                                                                                                                                      Stores: MinimalWritable<any> | [Readable<any>, ...Readable<any>[]] | Readable<any>[]

                                                                                                                                                                                                                                                                                                                      Stores that may be used as origins.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_store_writable_derived.StoresValues.html b/docs/types/_runtime_svelte_store_writable_derived.StoresValues.html index 47fe3393..14327cd3 100644 --- a/docs/types/_runtime_svelte_store_writable_derived.StoresValues.html +++ b/docs/types/_runtime_svelte_store_writable_derived.StoresValues.html @@ -1,2 +1,3 @@ -StoresValues | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias StoresValues<T>

                                                                                                                                                                                                                                                                                                                      StoresValues<T>: T extends Readable<infer U>
                                                                                                                                                                                                                                                                                                                          ? U
                                                                                                                                                                                                                                                                                                                          : {
                                                                                                                                                                                                                                                                                                                              [K in keyof T]: T[K] extends Readable<infer U>
                                                                                                                                                                                                                                                                                                                                  ? U
                                                                                                                                                                                                                                                                                                                                  : never
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                      Values retrieved from origin stores.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +StoresValues | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias StoresValues<T>

                                                                                                                                                                                                                                                                                                                      StoresValues<T>: T extends Readable<infer U>
                                                                                                                                                                                                                                                                                                                          ? U
                                                                                                                                                                                                                                                                                                                          : {
                                                                                                                                                                                                                                                                                                                              [K in keyof T]: T[K] extends Readable<infer U>
                                                                                                                                                                                                                                                                                                                                  ? U
                                                                                                                                                                                                                                                                                                                                  : never
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                      Values retrieved from origin stores.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • T

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_transition.TransitionFunction.html b/docs/types/_runtime_svelte_transition.TransitionFunction.html index 668d6086..0713ae42 100644 --- a/docs/types/_runtime_svelte_transition.TransitionFunction.html +++ b/docs/types/_runtime_svelte_transition.TransitionFunction.html @@ -1,2 +1,3 @@ -TransitionFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TransitionFunction

                                                                                                                                                                                                                                                                                                                      TransitionFunction: ((node, namedParameters?) => TransitionConfig)

                                                                                                                                                                                                                                                                                                                      Defines the shape of a transition function.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +TransitionFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias TransitionFunction

                                                                                                                                                                                                                                                                                                                      TransitionFunction: ((node: Element, namedParameters?: object) => TransitionConfig)

                                                                                                                                                                                                                                                                                                                      Defines the shape of a transition function.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_svelte_util.TJSSvelteConfig.html b/docs/types/_runtime_svelte_util.TJSSvelteConfig.html index 78fa2010..7f0332e7 100644 --- a/docs/types/_runtime_svelte_util.TJSSvelteConfig.html +++ b/docs/types/_runtime_svelte_util.TJSSvelteConfig.html @@ -1,10 +1,11 @@ -TJSSvelteConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                      TJSSvelteConfig: {
                                                                                                                                                                                                                                                                                                                          anchor?: Element;
                                                                                                                                                                                                                                                                                                                          class: (new (options) => SvelteComponent<any, any, any>);
                                                                                                                                                                                                                                                                                                                          context?: (() => Record<string, any> | Map<string, any>) | Map<string, any> | Record<string, any>;
                                                                                                                                                                                                                                                                                                                          hydrate?: boolean;
                                                                                                                                                                                                                                                                                                                          intro?: boolean;
                                                                                                                                                                                                                                                                                                                          props?: (() => Record<string, any>) | Record<string, any>;
                                                                                                                                                                                                                                                                                                                          target?: Element | Document | ShadowRoot;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines the TRL / client side configuration object to load a Svelte component.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional anchor?: Element

                                                                                                                                                                                                                                                                                                                        A child of target to render the component immediately before.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • class: (new (options) => SvelteComponent<any, any, any>)

                                                                                                                                                                                                                                                                                                                        The Svelte component class / constructor function.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional context?: (() => Record<string, any> | Map<string, any>) | Map<string, any> | Record<string, any>

                                                                                                                                                                                                                                                                                                                        The root-level context to pass to the component. You may define context as a callback function.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional hydrate?: boolean

                                                                                                                                                                                                                                                                                                                        See description in main Svelte docs +TJSSvelteConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                        TJSSvelteConfig: {
                                                                                                                                                                                                                                                                                                                            anchor?: Element;
                                                                                                                                                                                                                                                                                                                            class: (new (options: ComponentConstructorOptions<Record<string, any>>) => SvelteComponent<any, any, any>);
                                                                                                                                                                                                                                                                                                                            context?: (() => Record<string, any> | Map<string, any>) | Map<string, any> | Record<string, any>;
                                                                                                                                                                                                                                                                                                                            hydrate?: boolean;
                                                                                                                                                                                                                                                                                                                            intro?: boolean;
                                                                                                                                                                                                                                                                                                                            props?: (() => Record<string, any>) | Record<string, any>;
                                                                                                                                                                                                                                                                                                                            target?: Element | Document | ShadowRoot;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Defines the TRL / client side configuration object to load a Svelte component.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalanchor?: Element

                                                                                                                                                                                                                                                                                                                          A child of target to render the component immediately before.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • class: (new (options: ComponentConstructorOptions<Record<string, any>>) => SvelteComponent<any, any, any>)

                                                                                                                                                                                                                                                                                                                          The Svelte component class / constructor function.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalcontext?: (() => Record<string, any> | Map<string, any>) | Map<string, any> | Record<string, any>

                                                                                                                                                                                                                                                                                                                          The root-level context to pass to the component. You may define context as a callback function.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalhydrate?: boolean

                                                                                                                                                                                                                                                                                                                          See description in main Svelte docs Creating a component.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional intro?: boolean

                                                                                                                                                                                                                                                                                                                          If true, will play transitions on initial render, rather than waiting for subsequent state changes.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional props?: (() => Record<string, any>) | Record<string, any>

                                                                                                                                                                                                                                                                                                                          Props to pass to the component. You may define props as a callback function.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional target?: Element | Document | ShadowRoot

                                                                                                                                                                                                                                                                                                                          The target to render component to. By default, document.body is used as the target if not otherwise defined.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                      • Optionalintro?: boolean

                                                                                                                                                                                                                                                                                                                        If true, will play transitions on initial render, rather than waiting for subsequent state changes.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalprops?: (() => Record<string, any>) | Record<string, any>

                                                                                                                                                                                                                                                                                                                        Props to pass to the component. You may define props as a callback function.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionaltarget?: Element | Document | ShadowRoot

                                                                                                                                                                                                                                                                                                                        The target to render component to. By default, document.body is used as the target if not otherwise defined.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util.BasicAnimationState.html b/docs/types/_runtime_util.BasicAnimationState.html deleted file mode 100644 index d6b58ad8..00000000 --- a/docs/types/_runtime_util.BasicAnimationState.html +++ /dev/null @@ -1,3 +0,0 @@ -BasicAnimationState | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias BasicAnimationState

                                                                                                                                                                                                                                                                                                                      BasicAnimationState: {
                                                                                                                                                                                                                                                                                                                          cancelled: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      State that is available in the resolution of the Promise for BasicAnimation.finished.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • cancelled: boolean

                                                                                                                                                                                                                                                                                                                        True if the animation was cancelled.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util.ResizeObserverData.ResizeFunction.html b/docs/types/_runtime_util.ResizeObserverData.ResizeFunction.html deleted file mode 100644 index 66c0368d..00000000 --- a/docs/types/_runtime_util.ResizeObserverData.ResizeFunction.html +++ /dev/null @@ -1,2 +0,0 @@ -ResizeFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ResizeFunction

                                                                                                                                                                                                                                                                                                                      ResizeFunction: ((offsetWidth, offsetHeight, contentWidth?, contentHeight?) => unknown)

                                                                                                                                                                                                                                                                                                                      A function that receives offset / content height & width changes.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        • (offsetWidth, offsetHeight, contentWidth?, contentHeight?): unknown

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • offsetWidth: number
                                                                                                                                                                                                                                                                                                                          • offsetHeight: number
                                                                                                                                                                                                                                                                                                                          • Optional contentWidth: number
                                                                                                                                                                                                                                                                                                                          • Optional contentHeight: number

                                                                                                                                                                                                                                                                                                                          Returns unknown

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util.ResizeObserverData.ResizeObject.html b/docs/types/_runtime_util.ResizeObserverData.ResizeObject.html deleted file mode 100644 index b9528236..00000000 --- a/docs/types/_runtime_util.ResizeObserverData.ResizeObject.html +++ /dev/null @@ -1,6 +0,0 @@ -ResizeObject | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ResizeObject

                                                                                                                                                                                                                                                                                                                      ResizeObject: {
                                                                                                                                                                                                                                                                                                                          contentHeight?: number;
                                                                                                                                                                                                                                                                                                                          contentWidth?: number;
                                                                                                                                                                                                                                                                                                                          offsetHeight?: number;
                                                                                                                                                                                                                                                                                                                          offsetWidth?: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      An object to update as a target for ResizeObserverManager resize updates.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional contentHeight?: number

                                                                                                                                                                                                                                                                                                                        Stores contentHeight attribute.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional contentWidth?: number

                                                                                                                                                                                                                                                                                                                        Stores contentWidth attribute.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional offsetHeight?: number

                                                                                                                                                                                                                                                                                                                        Stores offsetHeight attribute.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional offsetWidth?: number

                                                                                                                                                                                                                                                                                                                        Stores offsetWidth attribute.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util.ResizeObserverData.ResizeObjectExtended.html b/docs/types/_runtime_util.ResizeObserverData.ResizeObjectExtended.html deleted file mode 100644 index bdf7b7f8..00000000 --- a/docs/types/_runtime_util.ResizeObserverData.ResizeObjectExtended.html +++ /dev/null @@ -1,6 +0,0 @@ -ResizeObjectExtended | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ResizeObjectExtended

                                                                                                                                                                                                                                                                                                                      ResizeObjectExtended: {
                                                                                                                                                                                                                                                                                                                          resizeObserved?: Writable<ResizeObserverData.ResizeObject> | ResizeObserverData.ResizeFunction;
                                                                                                                                                                                                                                                                                                                          setContentBounds?: ((contentWidth, contentHeight) => unknown);
                                                                                                                                                                                                                                                                                                                          setDimension?: ((offsetWidth, offsetHeight) => unknown);
                                                                                                                                                                                                                                                                                                                          stores?: {
                                                                                                                                                                                                                                                                                                                              resizeObserved: Writable<ResizeObserverData.ResizeObject>;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      An extended object type defining various ways to create a valid target for ResizeObserverManager.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional resizeObserved?: Writable<ResizeObserverData.ResizeObject> | ResizeObserverData.ResizeFunction

                                                                                                                                                                                                                                                                                                                        Either a function or a writable store to receive resize updates.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional setContentBounds?: ((contentWidth, contentHeight) => unknown)

                                                                                                                                                                                                                                                                                                                        A function that is invoked with content width & height changes.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                          • (contentWidth, contentHeight): unknown

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • contentWidth: number
                                                                                                                                                                                                                                                                                                                            • contentHeight: number

                                                                                                                                                                                                                                                                                                                            Returns unknown

                                                                                                                                                                                                                                                                                                                      • Optional setDimension?: ((offsetWidth, offsetHeight) => unknown)

                                                                                                                                                                                                                                                                                                                        A function that is invoked with offset width & height changes.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                          • (offsetWidth, offsetHeight): unknown

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • offsetWidth: number
                                                                                                                                                                                                                                                                                                                            • offsetHeight: number

                                                                                                                                                                                                                                                                                                                            Returns unknown

                                                                                                                                                                                                                                                                                                                      • Optional stores?: {
                                                                                                                                                                                                                                                                                                                            resizeObserved: Writable<ResizeObserverData.ResizeObject>;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        An object with a stores attribute and subsequent resizeObserved writable store.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util.ResizeObserverData.ResizeTarget.html b/docs/types/_runtime_util.ResizeObserverData.ResizeTarget.html deleted file mode 100644 index 5a000517..00000000 --- a/docs/types/_runtime_util.ResizeObserverData.ResizeTarget.html +++ /dev/null @@ -1,3 +0,0 @@ -ResizeTarget | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ResizeTarget

                                                                                                                                                                                                                                                                                                                      ResizeTarget: ResizeObserverData.ResizeObject | ResizeObserverData.ResizeObjectExtended | ResizeObserverData.ResizeFunction

                                                                                                                                                                                                                                                                                                                      The receiving target for observed resize data associated with ResizeObserverManager. Just one of the -mechanisms defined is required to conform to a valid target.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_animate.BasicAnimationState.html b/docs/types/_runtime_util_animate.BasicAnimationState.html index 32302e32..bfbbdc78 100644 --- a/docs/types/_runtime_util_animate.BasicAnimationState.html +++ b/docs/types/_runtime_util_animate.BasicAnimationState.html @@ -1,3 +1,4 @@ -BasicAnimationState | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias BasicAnimationState

                                                                                                                                                                                                                                                                                                                      BasicAnimationState: {
                                                                                                                                                                                                                                                                                                                          cancelled: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      State that is available in the resolution of the Promise for BasicAnimation.finished.

                                                                                                                                                                                                                                                                                                                      +BasicAnimationState | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias BasicAnimationState

                                                                                                                                                                                                                                                                                                                      BasicAnimationState: {
                                                                                                                                                                                                                                                                                                                          cancelled: boolean;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      State that is available in the resolution of the Promise for BasicAnimation.finished.

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • cancelled: boolean

                                                                                                                                                                                                                                                                                                                        True if the animation was cancelled.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_browser.A11yFocusSource.html b/docs/types/_runtime_util_browser.A11yFocusSource.html index 021d2ded..f3fbad56 100644 --- a/docs/types/_runtime_util_browser.A11yFocusSource.html +++ b/docs/types/_runtime_util_browser.A11yFocusSource.html @@ -1,8 +1,9 @@ -A11yFocusSource | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias A11yFocusSource

                                                                                                                                                                                                                                                                                                                      A11yFocusSource: {
                                                                                                                                                                                                                                                                                                                          debug?: boolean;
                                                                                                                                                                                                                                                                                                                          focusEl?: Iterable<FocusableElement | string>;
                                                                                                                                                                                                                                                                                                                          source?: string;
                                                                                                                                                                                                                                                                                                                          x?: number;
                                                                                                                                                                                                                                                                                                                          y?: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides essential data to return focus to an HTMLElement / SVGElement after a +A11yFocusSource | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias A11yFocusSource

                                                                                                                                                                                                                                                                                                                      A11yFocusSource: {
                                                                                                                                                                                                                                                                                                                          debug?: boolean;
                                                                                                                                                                                                                                                                                                                          focusEl?: Iterable<FocusableElement | string>;
                                                                                                                                                                                                                                                                                                                          source?: string;
                                                                                                                                                                                                                                                                                                                          x?: number;
                                                                                                                                                                                                                                                                                                                          y?: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides essential data to return focus to an HTMLElement / SVGElement after a series of UI actions like working with context menus and modal dialogs.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional debug?: boolean

                                                                                                                                                                                                                                                                                                                        When true logs to console the actions taken in A11yHelper.applyFocusSource.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional focusEl?: Iterable<FocusableElement | string>

                                                                                                                                                                                                                                                                                                                        List of targets to attempt to focus.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional source?: string

                                                                                                                                                                                                                                                                                                                        The source of the event: 'keyboard' for instance.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional x?: number

                                                                                                                                                                                                                                                                                                                        Potential X coordinate of initial event.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional y?: number

                                                                                                                                                                                                                                                                                                                        Potential Y coordinate of initial event.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optionaldebug?: boolean

                                                                                                                                                                                                                                                                                                                        When true logs to console the actions taken in A11yHelper.applyFocusSource.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalfocusEl?: Iterable<FocusableElement | string>

                                                                                                                                                                                                                                                                                                                        List of targets to attempt to focus.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalsource?: string

                                                                                                                                                                                                                                                                                                                        The source of the event: 'keyboard' for instance.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalx?: number

                                                                                                                                                                                                                                                                                                                        Potential X coordinate of initial event.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionaly?: number

                                                                                                                                                                                                                                                                                                                        Potential Y coordinate of initial event.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_browser.FocusableElement.html b/docs/types/_runtime_util_browser.FocusableElement.html index 5cbacb54..b2ae4ac0 100644 --- a/docs/types/_runtime_util_browser.FocusableElement.html +++ b/docs/types/_runtime_util_browser.FocusableElement.html @@ -1,2 +1,3 @@ -FocusableElement | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias FocusableElement

                                                                                                                                                                                                                                                                                                                      FocusableElement: Element & HTMLOrSVGElement

                                                                                                                                                                                                                                                                                                                      A focusable element; either HTMLElement or SvgElement.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +FocusableElement | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias FocusableElement

                                                                                                                                                                                                                                                                                                                      FocusableElement: Element & HTMLOrSVGElement

                                                                                                                                                                                                                                                                                                                      A focusable element; either HTMLElement or SvgElement.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_browser.ResizeObserverData.ResizeFunction.html b/docs/types/_runtime_util_browser.ResizeObserverData.ResizeFunction.html index e89a8bdb..31938c2d 100644 --- a/docs/types/_runtime_util_browser.ResizeObserverData.ResizeFunction.html +++ b/docs/types/_runtime_util_browser.ResizeObserverData.ResizeFunction.html @@ -1,2 +1,3 @@ -ResizeFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ResizeFunction

                                                                                                                                                                                                                                                                                                                      ResizeFunction: ((offsetWidth, offsetHeight, contentWidth?, contentHeight?) => unknown)

                                                                                                                                                                                                                                                                                                                      A function that receives offset / content height & width changes.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                        • (offsetWidth, offsetHeight, contentWidth?, contentHeight?): unknown

                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                          • offsetWidth: number
                                                                                                                                                                                                                                                                                                                          • offsetHeight: number
                                                                                                                                                                                                                                                                                                                          • Optional contentWidth: number
                                                                                                                                                                                                                                                                                                                          • Optional contentHeight: number

                                                                                                                                                                                                                                                                                                                          Returns unknown

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +ResizeFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ResizeFunction

                                                                                                                                                                                                                                                                                                                      ResizeFunction: ((offsetWidth: number, offsetHeight: number, contentWidth?: number, contentHeight?: number) => unknown)

                                                                                                                                                                                                                                                                                                                      A function that receives offset / content height & width changes.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_browser.ResizeObserverData.ResizeObject.html b/docs/types/_runtime_util_browser.ResizeObserverData.ResizeObject.html index a9a3bfea..2716699b 100644 --- a/docs/types/_runtime_util_browser.ResizeObserverData.ResizeObject.html +++ b/docs/types/_runtime_util_browser.ResizeObserverData.ResizeObject.html @@ -1,6 +1,7 @@ -ResizeObject | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ResizeObject

                                                                                                                                                                                                                                                                                                                      ResizeObject: {
                                                                                                                                                                                                                                                                                                                          contentHeight?: number;
                                                                                                                                                                                                                                                                                                                          contentWidth?: number;
                                                                                                                                                                                                                                                                                                                          offsetHeight?: number;
                                                                                                                                                                                                                                                                                                                          offsetWidth?: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      An object to update as a target for ResizeObserverManager resize updates.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional contentHeight?: number

                                                                                                                                                                                                                                                                                                                        Stores contentHeight attribute.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional contentWidth?: number

                                                                                                                                                                                                                                                                                                                        Stores contentWidth attribute.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional offsetHeight?: number

                                                                                                                                                                                                                                                                                                                        Stores offsetHeight attribute.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional offsetWidth?: number

                                                                                                                                                                                                                                                                                                                        Stores offsetWidth attribute.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +ResizeObject | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ResizeObject

                                                                                                                                                                                                                                                                                                                      ResizeObject: {
                                                                                                                                                                                                                                                                                                                          contentHeight?: number;
                                                                                                                                                                                                                                                                                                                          contentWidth?: number;
                                                                                                                                                                                                                                                                                                                          offsetHeight?: number;
                                                                                                                                                                                                                                                                                                                          offsetWidth?: number;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      An object to update as a target for ResizeObserverManager resize updates.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • OptionalcontentHeight?: number

                                                                                                                                                                                                                                                                                                                        Stores contentHeight attribute.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalcontentWidth?: number

                                                                                                                                                                                                                                                                                                                        Stores contentWidth attribute.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionaloffsetHeight?: number

                                                                                                                                                                                                                                                                                                                        Stores offsetHeight attribute.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionaloffsetWidth?: number

                                                                                                                                                                                                                                                                                                                        Stores offsetWidth attribute.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_browser.ResizeObserverData.ResizeObjectExtended.html b/docs/types/_runtime_util_browser.ResizeObserverData.ResizeObjectExtended.html index e861f770..83e2c6d0 100644 --- a/docs/types/_runtime_util_browser.ResizeObserverData.ResizeObjectExtended.html +++ b/docs/types/_runtime_util_browser.ResizeObserverData.ResizeObjectExtended.html @@ -1,6 +1,7 @@ -ResizeObjectExtended | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ResizeObjectExtended

                                                                                                                                                                                                                                                                                                                      ResizeObjectExtended: {
                                                                                                                                                                                                                                                                                                                          resizeObserved?: Writable<ResizeObserverData.ResizeObject> | ResizeObserverData.ResizeFunction;
                                                                                                                                                                                                                                                                                                                          setContentBounds?: ((contentWidth, contentHeight) => unknown);
                                                                                                                                                                                                                                                                                                                          setDimension?: ((offsetWidth, offsetHeight) => unknown);
                                                                                                                                                                                                                                                                                                                          stores?: {
                                                                                                                                                                                                                                                                                                                              resizeObserved: Writable<ResizeObserverData.ResizeObject>;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      An extended object type defining various ways to create a valid target for ResizeObserverManager.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional resizeObserved?: Writable<ResizeObserverData.ResizeObject> | ResizeObserverData.ResizeFunction

                                                                                                                                                                                                                                                                                                                        Either a function or a writable store to receive resize updates.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional setContentBounds?: ((contentWidth, contentHeight) => unknown)

                                                                                                                                                                                                                                                                                                                        A function that is invoked with content width & height changes.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                          • (contentWidth, contentHeight): unknown

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • contentWidth: number
                                                                                                                                                                                                                                                                                                                            • contentHeight: number

                                                                                                                                                                                                                                                                                                                            Returns unknown

                                                                                                                                                                                                                                                                                                                      • Optional setDimension?: ((offsetWidth, offsetHeight) => unknown)

                                                                                                                                                                                                                                                                                                                        A function that is invoked with offset width & height changes.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                          • (offsetWidth, offsetHeight): unknown

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • offsetWidth: number
                                                                                                                                                                                                                                                                                                                            • offsetHeight: number

                                                                                                                                                                                                                                                                                                                            Returns unknown

                                                                                                                                                                                                                                                                                                                      • Optional stores?: {
                                                                                                                                                                                                                                                                                                                            resizeObserved: Writable<ResizeObserverData.ResizeObject>;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        An object with a stores attribute and subsequent resizeObserved writable store.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +ResizeObjectExtended | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ResizeObjectExtended

                                                                                                                                                                                                                                                                                                                      ResizeObjectExtended: {
                                                                                                                                                                                                                                                                                                                          resizeObserved?: Writable<ResizeObject> | ResizeFunction;
                                                                                                                                                                                                                                                                                                                          setContentBounds?: ((contentWidth: number, contentHeight: number) => unknown);
                                                                                                                                                                                                                                                                                                                          setDimension?: ((offsetWidth: number, offsetHeight: number) => unknown);
                                                                                                                                                                                                                                                                                                                          stores?: {
                                                                                                                                                                                                                                                                                                                              resizeObserved: Writable<ResizeObject>;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      An extended object type defining various ways to create a valid target for ResizeObserverManager.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • OptionalresizeObserved?: Writable<ResizeObject> | ResizeFunction

                                                                                                                                                                                                                                                                                                                        Either a function or a writable store to receive resize updates.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalsetContentBounds?: ((contentWidth: number, contentHeight: number) => unknown)

                                                                                                                                                                                                                                                                                                                        A function that is invoked with content width & height changes.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                          • (contentWidth, contentHeight): unknown

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • contentWidth: number
                                                                                                                                                                                                                                                                                                                            • contentHeight: number

                                                                                                                                                                                                                                                                                                                            Returns unknown

                                                                                                                                                                                                                                                                                                                      • OptionalsetDimension?: ((offsetWidth: number, offsetHeight: number) => unknown)

                                                                                                                                                                                                                                                                                                                        A function that is invoked with offset width & height changes.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                          • (offsetWidth, offsetHeight): unknown

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • offsetWidth: number
                                                                                                                                                                                                                                                                                                                            • offsetHeight: number

                                                                                                                                                                                                                                                                                                                            Returns unknown

                                                                                                                                                                                                                                                                                                                      • Optionalstores?: {
                                                                                                                                                                                                                                                                                                                            resizeObserved: Writable<ResizeObject>;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        An object with a stores attribute and subsequent resizeObserved writable store.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_browser.ResizeObserverData.ResizeTarget.html b/docs/types/_runtime_util_browser.ResizeObserverData.ResizeTarget.html index e126c369..b9347acf 100644 --- a/docs/types/_runtime_util_browser.ResizeObserverData.ResizeTarget.html +++ b/docs/types/_runtime_util_browser.ResizeObserverData.ResizeTarget.html @@ -1,3 +1,4 @@ -ResizeTarget | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ResizeTarget

                                                                                                                                                                                                                                                                                                                      ResizeTarget: ResizeObserverData.ResizeObject | ResizeObserverData.ResizeObjectExtended | ResizeObserverData.ResizeFunction

                                                                                                                                                                                                                                                                                                                      The receiving target for observed resize data associated with ResizeObserverManager. Just one of the +ResizeTarget | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ResizeTarget

                                                                                                                                                                                                                                                                                                                      ResizeTarget: ResizeObject | ResizeObjectExtended | ResizeFunction

                                                                                                                                                                                                                                                                                                                      The receiving target for observed resize data associated with ResizeObserverManager. Just one of the mechanisms defined is required to conform to a valid target.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_browser.StackingContext.html b/docs/types/_runtime_util_browser.StackingContext.html index be12fea8..6a4937fc 100644 --- a/docs/types/_runtime_util_browser.StackingContext.html +++ b/docs/types/_runtime_util_browser.StackingContext.html @@ -1,7 +1,8 @@ -StackingContext | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias StackingContext

                                                                                                                                                                                                                                                                                                                      StackingContext: {
                                                                                                                                                                                                                                                                                                                          node: Element;
                                                                                                                                                                                                                                                                                                                          reason: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_loader_module.ModuleLoaderObj.html b/docs/types/_runtime_util_loader_module.ModuleLoaderObj.html index b4e387de..76f736a1 100644 --- a/docs/types/_runtime_util_loader_module.ModuleLoaderObj.html +++ b/docs/types/_runtime_util_loader_module.ModuleLoaderObj.html @@ -1,4 +1,5 @@ -ModuleLoaderObj | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ModuleLoaderObj<M, E>

                                                                                                                                                                                                                                                                                                                      ModuleLoaderObj<M, E>: {
                                                                                                                                                                                                                                                                                                                          filepath: string;
                                                                                                                                                                                                                                                                                                                          instance: E;
                                                                                                                                                                                                                                                                                                                          isESM: boolean;
                                                                                                                                                                                                                                                                                                                          loadpath: string;
                                                                                                                                                                                                                                                                                                                          module: M;
                                                                                                                                                                                                                                                                                                                          modulepath: string | URL;
                                                                                                                                                                                                                                                                                                                          type: "import-module" | "import-path" | "import-url" | "require-module" | "require-path" | "require-url";
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      The object passed back from ModuleLoader.load.

                                                                                                                                                                                                                                                                                                                      +ModuleLoaderObj | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias ModuleLoaderObj<M, E>

                                                                                                                                                                                                                                                                                                                      ModuleLoaderObj<M, E>: {
                                                                                                                                                                                                                                                                                                                          filepath: string;
                                                                                                                                                                                                                                                                                                                          instance: E;
                                                                                                                                                                                                                                                                                                                          isESM: boolean;
                                                                                                                                                                                                                                                                                                                          loadpath: string;
                                                                                                                                                                                                                                                                                                                          module: M;
                                                                                                                                                                                                                                                                                                                          modulepath: string | URL;
                                                                                                                                                                                                                                                                                                                          type:
                                                                                                                                                                                                                                                                                                                              | "import-module"
                                                                                                                                                                                                                                                                                                                              | "import-path"
                                                                                                                                                                                                                                                                                                                              | "import-url"
                                                                                                                                                                                                                                                                                                                              | "require-module"
                                                                                                                                                                                                                                                                                                                              | "require-path"
                                                                                                                                                                                                                                                                                                                              | "require-url";
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      The object passed back from ModuleLoader.load.

                                                                                                                                                                                                                                                                                                                      Type Parameters

                                                                                                                                                                                                                                                                                                                      • M
                                                                                                                                                                                                                                                                                                                      • E

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • filepath: string

                                                                                                                                                                                                                                                                                                                        If available the file path on Node otherwise this will match loadpath in the browser.

                                                                                                                                                                                                                                                                                                                      • instance: E

                                                                                                                                                                                                                                                                                                                        Either the module itself or any particular export the resolveModule function @@ -7,5 +8,5 @@

                                                                                                                                                                                                                                                                                                                      • loadpath: string

                                                                                                                                                                                                                                                                                                                        A string representation of the module path being loaded.

                                                                                                                                                                                                                                                                                                                      • module: M

                                                                                                                                                                                                                                                                                                                        The direct module import.

                                                                                                                                                                                                                                                                                                                      • modulepath: string | URL

                                                                                                                                                                                                                                                                                                                        The initial string or URL sent to ModuleLoader.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • type: "import-module" | "import-path" | "import-url" | "require-module" | "require-path" | "require-url"

                                                                                                                                                                                                                                                                                                                        The type and how the module was loaded.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                    • type:
                                                                                                                                                                                                                                                                                                                          | "import-module"
                                                                                                                                                                                                                                                                                                                          | "import-path"
                                                                                                                                                                                                                                                                                                                          | "import-url"
                                                                                                                                                                                                                                                                                                                          | "require-module"
                                                                                                                                                                                                                                                                                                                          | "require-path"
                                                                                                                                                                                                                                                                                                                          | "require-url"

                                                                                                                                                                                                                                                                                                                      The type and how the module was loaded.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      • Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_object.JSONValue.html b/docs/types/_runtime_util_object.JSONValue.html index 82353cac..766833b0 100644 --- a/docs/types/_runtime_util_object.JSONValue.html +++ b/docs/types/_runtime_util_object.JSONValue.html @@ -1 +1,2 @@ -JSONValue | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias JSONValue

                                                                                                                                                                                                                                                                                                                      JSONValue: Primitive | JSONObject | JSONArray

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +JSONValue | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias JSONValue

                                                                                                                                                                                                                                                                                                                      JSONValue: Primitive | JSONObject | JSONArray

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_object.Primitive.html b/docs/types/_runtime_util_object.Primitive.html index 08cde734..1e02b09c 100644 --- a/docs/types/_runtime_util_object.Primitive.html +++ b/docs/types/_runtime_util_object.Primitive.html @@ -1 +1,2 @@ -Primitive | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias Primitive

                                                                                                                                                                                                                                                                                                                      Primitive: bigint | boolean | null | number | string | symbol | undefined

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Primitive | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias Primitive

                                                                                                                                                                                                                                                                                                                      Primitive:
                                                                                                                                                                                                                                                                                                                          | bigint
                                                                                                                                                                                                                                                                                                                          | boolean
                                                                                                                                                                                                                                                                                                                          | null
                                                                                                                                                                                                                                                                                                                          | number
                                                                                                                                                                                                                                                                                                                          | string
                                                                                                                                                                                                                                                                                                                          | symbol
                                                                                                                                                                                                                                                                                                                          | undefined

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_object.SafeSetOperation.html b/docs/types/_runtime_util_object.SafeSetOperation.html index 160fdc20..dab91a81 100644 --- a/docs/types/_runtime_util_object.SafeSetOperation.html +++ b/docs/types/_runtime_util_object.SafeSetOperation.html @@ -1,2 +1,3 @@ -SafeSetOperation | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias SafeSetOperation

                                                                                                                                                                                                                                                                                                                      SafeSetOperation: "add" | "div" | "mult" | "set" | "set-undefined" | "sub"

                                                                                                                                                                                                                                                                                                                      Defines the operation to perform for safeSet.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +SafeSetOperation | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias SafeSetOperation

                                                                                                                                                                                                                                                                                                                      SafeSetOperation:
                                                                                                                                                                                                                                                                                                                          | "add"
                                                                                                                                                                                                                                                                                                                          | "div"
                                                                                                                                                                                                                                                                                                                          | "mult"
                                                                                                                                                                                                                                                                                                                          | "set"
                                                                                                                                                                                                                                                                                                                          | "set-undefined"
                                                                                                                                                                                                                                                                                                                          | "sub"

                                                                                                                                                                                                                                                                                                                      Defines the operation to perform for safeSet.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_runtime_util_object.ValidationEntry.html b/docs/types/_runtime_util_object.ValidationEntry.html index ece3e237..43261852 100644 --- a/docs/types/_runtime_util_object.ValidationEntry.html +++ b/docs/types/_runtime_util_object.ValidationEntry.html @@ -1,8 +1,9 @@ -ValidationEntry | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias ValidationEntry

                                                                                                                                                                                                                                                                                                                      ValidationEntry: {
                                                                                                                                                                                                                                                                                                                          error?: boolean;
                                                                                                                                                                                                                                                                                                                          expected?: any[] | Function | Set<any>;
                                                                                                                                                                                                                                                                                                                          message?: string;
                                                                                                                                                                                                                                                                                                                          required?: boolean;
                                                                                                                                                                                                                                                                                                                          test: "array" | "entry" | "entry|array";
                                                                                                                                                                                                                                                                                                                          type?: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Provides data for a validation check.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional error?: boolean

                                                                                                                                                                                                                                                                                                                        When true and an error is thrown otherwise a boolean is returned; default: true

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional expected?: any[] | Function | Set<any>

                                                                                                                                                                                                                                                                                                                        Optional array, function, or set of expected values to test against.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional message?: string

                                                                                                                                                                                                                                                                                                                        Optional message to include.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional required?: boolean

                                                                                                                                                                                                                                                                                                                        When false if the accessor is missing validation is skipped; default: true

                                                                                                                                                                                                                                                                                                                        +ValidationEntry | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias ValidationEntry

                                                                                                                                                                                                                                                                                                                        ValidationEntry: {
                                                                                                                                                                                                                                                                                                                            error?: boolean;
                                                                                                                                                                                                                                                                                                                            expected?: any[] | Function | Set<any>;
                                                                                                                                                                                                                                                                                                                            message?: string;
                                                                                                                                                                                                                                                                                                                            required?: boolean;
                                                                                                                                                                                                                                                                                                                            test: "array" | "entry" | "entry|array";
                                                                                                                                                                                                                                                                                                                            type?: string;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Provides data for a validation check.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalerror?: boolean

                                                                                                                                                                                                                                                                                                                          When true and an error is thrown otherwise a boolean is returned; default: true

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalexpected?: any[] | Function | Set<any>

                                                                                                                                                                                                                                                                                                                          Optional array, function, or set of expected values to test against.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalmessage?: string

                                                                                                                                                                                                                                                                                                                          Optional message to include.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalrequired?: boolean

                                                                                                                                                                                                                                                                                                                          When false if the accessor is missing validation is skipped; default: true

                                                                                                                                                                                                                                                                                                                        • test: "array" | "entry" | "entry|array"

                                                                                                                                                                                                                                                                                                                          The type of entry / variable to test.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional type?: string

                                                                                                                                                                                                                                                                                                                          Optionally tests with a typeof check.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                      • Optionaltype?: string

                                                                                                                                                                                                                                                                                                                        Optionally tests with a typeof check.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_application.FVTTFilePickerBrowseOptions.html b/docs/types/_standard_application.FVTTFilePickerBrowseOptions.html index e0650b51..2820d0e6 100644 --- a/docs/types/_standard_application.FVTTFilePickerBrowseOptions.html +++ b/docs/types/_standard_application.FVTTFilePickerBrowseOptions.html @@ -1,24 +1,25 @@ -FVTTFilePickerBrowseOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias FVTTFilePickerBrowseOptions

                                                                                                                                                                                                                                                                                                                      FVTTFilePickerBrowseOptions: {
                                                                                                                                                                                                                                                                                                                          activeSource?: string;
                                                                                                                                                                                                                                                                                                                          allowUpload?: boolean;
                                                                                                                                                                                                                                                                                                                          callback?: Function;
                                                                                                                                                                                                                                                                                                                          current?: string;
                                                                                                                                                                                                                                                                                                                          displayMode?: string;
                                                                                                                                                                                                                                                                                                                          favorites?: Map<string, globalThis.FavoriteFolder>;
                                                                                                                                                                                                                                                                                                                          glasspaneId?: string;
                                                                                                                                                                                                                                                                                                                          id?: string;
                                                                                                                                                                                                                                                                                                                          modal?: boolean;
                                                                                                                                                                                                                                                                                                                          modalOptions?: {
                                                                                                                                                                                                                                                                                                                              background: string;
                                                                                                                                                                                                                                                                                                                              closeOnInput: boolean;
                                                                                                                                                                                                                                                                                                                              styles: Record<string, string>;
                                                                                                                                                                                                                                                                                                                              transition: TransitionFunction;
                                                                                                                                                                                                                                                                                                                              transitionOptions: Record<string, any>;
                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                          onFilepath?: (({ filepath: string }) => void);
                                                                                                                                                                                                                                                                                                                          onValidate?: (({ filepath: string }) => Promise<boolean>);
                                                                                                                                                                                                                                                                                                                          redirectToRoot?: string[];
                                                                                                                                                                                                                                                                                                                          store?: Writable<string>;
                                                                                                                                                                                                                                                                                                                          tileSize?: boolean;
                                                                                                                                                                                                                                                                                                                          type?: string;
                                                                                                                                                                                                                                                                                                                          zIndex?: number;
                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                        +FVTTFilePickerBrowseOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias FVTTFilePickerBrowseOptions

                                                                                                                                                                                                                                                                                                                        FVTTFilePickerBrowseOptions: {
                                                                                                                                                                                                                                                                                                                            activeSource?: string;
                                                                                                                                                                                                                                                                                                                            allowUpload?: boolean;
                                                                                                                                                                                                                                                                                                                            callback?: Function;
                                                                                                                                                                                                                                                                                                                            current?: string;
                                                                                                                                                                                                                                                                                                                            displayMode?: string;
                                                                                                                                                                                                                                                                                                                            favorites?: Map<string, globalThis.FavoriteFolder>;
                                                                                                                                                                                                                                                                                                                            glasspaneId?: string;
                                                                                                                                                                                                                                                                                                                            id?: string;
                                                                                                                                                                                                                                                                                                                            modal?: boolean;
                                                                                                                                                                                                                                                                                                                            modalOptions?: {
                                                                                                                                                                                                                                                                                                                                background: string;
                                                                                                                                                                                                                                                                                                                                closeOnInput: boolean;
                                                                                                                                                                                                                                                                                                                                styles: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                transition: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                transitionOptions: Record<string, any>;
                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                            onFilepath?: (({ filepath: string }: {
                                                                                                                                                                                                                                                                                                                                filepath: any;
                                                                                                                                                                                                                                                                                                                            }) => void);
                                                                                                                                                                                                                                                                                                                            onValidate?: (({ filepath: string }: {
                                                                                                                                                                                                                                                                                                                                filepath: any;
                                                                                                                                                                                                                                                                                                                            }) => Promise<boolean>);
                                                                                                                                                                                                                                                                                                                            redirectToRoot?: string[];
                                                                                                                                                                                                                                                                                                                            store?: Writable<string>;
                                                                                                                                                                                                                                                                                                                            tileSize?: boolean;
                                                                                                                                                                                                                                                                                                                            type?: string;
                                                                                                                                                                                                                                                                                                                            zIndex?: number;
                                                                                                                                                                                                                                                                                                                        }
                                                                                                                                                                                                                                                                                                                        • Foundry globalThis.FilePicker w/ expanded - FVTTFilePickerControl options.
                                                                                                                                                                                                                                                                                                                          • +FVTTFilePickerControl options.
                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optional activeSource?: string

                                                                                                                                                                                                                                                                                                                          A current file source in 'data', 'public', or 's3'.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional allowUpload?: boolean

                                                                                                                                                                                                                                                                                                                          A flag which permits explicitly disallowing upload, true by default.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional callback?: Function

                                                                                                                                                                                                                                                                                                                          A callback function to trigger once a file has been selected.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional current?: string

                                                                                                                                                                                                                                                                                                                          The current file path being modified, if any.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional displayMode?: string

                                                                                                                                                                                                                                                                                                                          The picker display mode in FilePicker.DISPLAY_MODES.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional favorites?: Map<string, globalThis.FavoriteFolder>

                                                                                                                                                                                                                                                                                                                          A map of favorite folder configuration objects.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional glasspaneId?: string

                                                                                                                                                                                                                                                                                                                          Provide the CSS ID of the glasspane to move the file picker app to after opening.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional id?: string

                                                                                                                                                                                                                                                                                                                          A specific unique CSS app ID.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional modal?: boolean

                                                                                                                                                                                                                                                                                                                          When true a modal file picker will be opened.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional modalOptions?: {
                                                                                                                                                                                                                                                                                                                              background: string;
                                                                                                                                                                                                                                                                                                                              closeOnInput: boolean;
                                                                                                                                                                                                                                                                                                                              styles: Record<string, string>;
                                                                                                                                                                                                                                                                                                                              transition: TransitionFunction;
                                                                                                                                                                                                                                                                                                                              transitionOptions: Record<string, any>;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Options for the modal glasspane / TJSGlasspane component.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional onFilepath?: (({ filepath: string }) => void)

                                                                                                                                                                                                                                                                                                                          Optional function invoked when filepath changes.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                            • ({ filepath: string }): void

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • { filepath: string }: {
                                                                                                                                                                                                                                                                                                                                    filepath: any;
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                • filepath: any

                                                                                                                                                                                                                                                                                                                              Returns void

                                                                                                                                                                                                                                                                                                                        • Optional onValidate?: (({ filepath: string }) => Promise<boolean>)

                                                                                                                                                                                                                                                                                                                          Optional validation function of selected filepath.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                            • ({ filepath: string }): Promise<boolean>

                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                              • { filepath: string }: {
                                                                                                                                                                                                                                                                                                                                    filepath: any;
                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                • filepath: any

                                                                                                                                                                                                                                                                                                                              Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                        • Optional redirectToRoot?: string[]

                                                                                                                                                                                                                                                                                                                          Redirect to the root directory rather than starting in the source directory - of one of these files.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional store?: Writable<string>

                                                                                                                                                                                                                                                                                                                          A writable Svelte store that is set with result.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional tileSize?: boolean

                                                                                                                                                                                                                                                                                                                          Display the tile size configuration.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional type?: string

                                                                                                                                                                                                                                                                                                                          A type of file to target, in 'audio', 'image', 'video', 'imagevideo', - 'folder', 'font', 'graphics', 'text', or 'any'.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional zIndex?: number

                                                                                                                                                                                                                                                                                                                          Provides an explicit z-index for the file picker app.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • OptionalactiveSource?: string

                                                                                                                                                                                                                                                                                                                        A current file source in 'data', 'public', or 's3'.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalallowUpload?: boolean

                                                                                                                                                                                                                                                                                                                        A flag which permits explicitly disallowing upload, true by default.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalcallback?: Function

                                                                                                                                                                                                                                                                                                                        A callback function to trigger once a file has been selected.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalcurrent?: string

                                                                                                                                                                                                                                                                                                                        The current file path being modified, if any.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionaldisplayMode?: string

                                                                                                                                                                                                                                                                                                                        The picker display mode in FilePicker.DISPLAY_MODES.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalfavorites?: Map<string, globalThis.FavoriteFolder>

                                                                                                                                                                                                                                                                                                                        A map of favorite folder configuration objects.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalglasspaneId?: string

                                                                                                                                                                                                                                                                                                                        Provide the CSS ID of the glasspane to move the file picker app to after opening.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalid?: string

                                                                                                                                                                                                                                                                                                                        A specific unique CSS app ID.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalmodal?: boolean

                                                                                                                                                                                                                                                                                                                        When true a modal file picker will be opened.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalmodalOptions?: {
                                                                                                                                                                                                                                                                                                                            background: string;
                                                                                                                                                                                                                                                                                                                            closeOnInput: boolean;
                                                                                                                                                                                                                                                                                                                            styles: Record<string, string>;
                                                                                                                                                                                                                                                                                                                            transition: TransitionFunction;
                                                                                                                                                                                                                                                                                                                            transitionOptions: Record<string, any>;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Options for the modal glasspane / TJSGlasspane component.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalonFilepath?: (({ filepath: string }: {
                                                                                                                                                                                                                                                                                                                            filepath: any;
                                                                                                                                                                                                                                                                                                                        }) => void)

                                                                                                                                                                                                                                                                                                                        Optional function invoked when filepath changes.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                          • ({ filepath: string }): void

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • { filepath: string }: {
                                                                                                                                                                                                                                                                                                                                  filepath: any;
                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                              • filepath: any

                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                      • OptionalonValidate?: (({ filepath: string }: {
                                                                                                                                                                                                                                                                                                                            filepath: any;
                                                                                                                                                                                                                                                                                                                        }) => Promise<boolean>)

                                                                                                                                                                                                                                                                                                                        Optional validation function of selected filepath.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                          • ({ filepath: string }): Promise<boolean>

                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                            • { filepath: string }: {
                                                                                                                                                                                                                                                                                                                                  filepath: any;
                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                              • filepath: any

                                                                                                                                                                                                                                                                                                                            Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                      • OptionalredirectToRoot?: string[]

                                                                                                                                                                                                                                                                                                                        Redirect to the root directory rather than starting in the source directory +of one of these files.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionalstore?: Writable<string>

                                                                                                                                                                                                                                                                                                                        A writable Svelte store that is set with result.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionaltileSize?: boolean

                                                                                                                                                                                                                                                                                                                        Display the tile size configuration.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionaltype?: string

                                                                                                                                                                                                                                                                                                                        A type of file to target, in 'audio', 'image', 'video', 'imagevideo', +'folder', 'font', 'graphics', 'text', or 'any'.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • OptionalzIndex?: number

                                                                                                                                                                                                                                                                                                                        Provides an explicit z-index for the file picker app.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_application.FVTTSidebarAddData.html b/docs/types/_standard_application.FVTTSidebarAddData.html index 59b407a6..ef2b1565 100644 --- a/docs/types/_standard_application.FVTTSidebarAddData.html +++ b/docs/types/_standard_application.FVTTSidebarAddData.html @@ -1,18 +1,19 @@ -FVTTSidebarAddData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias FVTTSidebarAddData

                                                                                                                                                                                                                                                                                                                      FVTTSidebarAddData: {
                                                                                                                                                                                                                                                                                                                          beforeId?: string;
                                                                                                                                                                                                                                                                                                                          condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                          icon: string | TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                          mergeAppImpl?: object;
                                                                                                                                                                                                                                                                                                                          popoutApplication?: SvelteApplication;
                                                                                                                                                                                                                                                                                                                          popoutOptions?: object;
                                                                                                                                                                                                                                                                                                                          svelte: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                          title?: string;
                                                                                                                                                                                                                                                                                                                          tooltip?: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      The configuration object to add a Svelte sidebar.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional beforeId?: string

                                                                                                                                                                                                                                                                                                                        The ID for the tab to place the new sidebar before. This must be an +FVTTSidebarAddData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias FVTTSidebarAddData

                                                                                                                                                                                                                                                                                                                        FVTTSidebarAddData: {
                                                                                                                                                                                                                                                                                                                            beforeId?: string;
                                                                                                                                                                                                                                                                                                                            condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                            icon: string | TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                            id: string;
                                                                                                                                                                                                                                                                                                                            mergeAppImpl?: object;
                                                                                                                                                                                                                                                                                                                            popoutApplication?: SvelteApplication;
                                                                                                                                                                                                                                                                                                                            popoutOptions?: object;
                                                                                                                                                                                                                                                                                                                            svelte: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                            title?: string;
                                                                                                                                                                                                                                                                                                                            tooltip?: string;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        The configuration object to add a Svelte sidebar.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • OptionalbeforeId?: string

                                                                                                                                                                                                                                                                                                                          The ID for the tab to place the new sidebar before. This must be an existing sidebar tab ID. THe stock Foundry sidebar tab IDs from left to right are:

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional condition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                                                          A boolean value or function to invoke that returns a +

                                                                                                                                                                                                                                                                                                                        • Optionalcondition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                                                          A boolean value or function to invoke that returns a boolean value to control sidebar replacement. This is executed in the renderSidebar callback internally.

                                                                                                                                                                                                                                                                                                                        • icon: string | TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                          The FontAwesome icon css classes or a Svelte configuration object to load a custom Svelte component to use as the "icon".

                                                                                                                                                                                                                                                                                                                        • id: string

                                                                                                                                                                                                                                                                                                                          The unique Sidebar ID / name. Used for CSS ID and retrieving the sidebar.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional mergeAppImpl?: object

                                                                                                                                                                                                                                                                                                                          Provides a custom base implementation for the object instance +

                                                                                                                                                                                                                                                                                                                        • OptionalmergeAppImpl?: object

                                                                                                                                                                                                                                                                                                                          Provides a custom base implementation for the object instance for this sidebar app stored in globalThis.ui.<SIDEBAR ID>.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional popoutApplication?: SvelteApplication

                                                                                                                                                                                                                                                                                                                          Provides a custom +

                                                                                                                                                                                                                                                                                                                        • OptionalpopoutApplication?: SvelteApplication

                                                                                                                                                                                                                                                                                                                          Provides a custom SvelteApplication class to instantiate for the popout sidebar.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional popoutOptions?: object

                                                                                                                                                                                                                                                                                                                          Provides SvelteApplication options overrides for the default popout sidebar.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • OptionalpopoutOptions?: object

                                                                                                                                                                                                                                                                                                                          Provides SvelteApplication options overrides for the default popout sidebar.

                                                                                                                                                                                                                                                                                                                        • svelte: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                          A Svelte configuration object.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional title?: string

                                                                                                                                                                                                                                                                                                                          The popout application title text or i18n lang key.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional tooltip?: string

                                                                                                                                                                                                                                                                                                                          The sidebar tab tooltip text or i18n lang key.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                      • Optionaltitle?: string

                                                                                                                                                                                                                                                                                                                        The popout application title text or i18n lang key.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionaltooltip?: string

                                                                                                                                                                                                                                                                                                                        The sidebar tab tooltip text or i18n lang key.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_application.FVTTSidebarEntry.html b/docs/types/_standard_application.FVTTSidebarEntry.html index cb5df5aa..164eff4c 100644 --- a/docs/types/_standard_application.FVTTSidebarEntry.html +++ b/docs/types/_standard_application.FVTTSidebarEntry.html @@ -1,6 +1,7 @@ -FVTTSidebarEntry | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias FVTTSidebarEntry

                                                                                                                                                                                                                                                                                                                      FVTTSidebarEntry: {
                                                                                                                                                                                                                                                                                                                          data: FVTTSidebarAddData | FVTTSidebarRemoveData | FVTTSidebarReplaceData;
                                                                                                                                                                                                                                                                                                                          popout: SvelteApplication;
                                                                                                                                                                                                                                                                                                                          tab: SvelteComponent;
                                                                                                                                                                                                                                                                                                                          wrapper: SvelteComponent;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_application.FVTTSidebarRemoveData.html b/docs/types/_standard_application.FVTTSidebarRemoveData.html index eae94d57..ffa40022 100644 --- a/docs/types/_standard_application.FVTTSidebarRemoveData.html +++ b/docs/types/_standard_application.FVTTSidebarRemoveData.html @@ -1,4 +1,5 @@ -FVTTSidebarRemoveData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias FVTTSidebarRemoveData

                                                                                                                                                                                                                                                                                                                      FVTTSidebarRemoveData: {
                                                                                                                                                                                                                                                                                                                          condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional condition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                                                        A boolean value or function to invoke that returns a boolean +FVTTSidebarRemoveData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias FVTTSidebarRemoveData

                                                                                                                                                                                                                                                                                                                        FVTTSidebarRemoveData: {
                                                                                                                                                                                                                                                                                                                            condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                            id: string;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalcondition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                                                          A boolean value or function to invoke that returns a boolean value to control sidebar replacement. This is executed in the renderSidebar callback internally.

                                                                                                                                                                                                                                                                                                                        • id: string

                                                                                                                                                                                                                                                                                                                          The ID for the sidebar tab to remove. This must be an existing sidebar tab ID.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_application.FVTTSidebarReplaceData.html b/docs/types/_standard_application.FVTTSidebarReplaceData.html index c406979b..c20f10cb 100644 --- a/docs/types/_standard_application.FVTTSidebarReplaceData.html +++ b/docs/types/_standard_application.FVTTSidebarReplaceData.html @@ -1,15 +1,16 @@ -FVTTSidebarReplaceData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias FVTTSidebarReplaceData

                                                                                                                                                                                                                                                                                                                      FVTTSidebarReplaceData: {
                                                                                                                                                                                                                                                                                                                          condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                          icon: string | TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                          id: string;
                                                                                                                                                                                                                                                                                                                          mergeAppImpl?: object;
                                                                                                                                                                                                                                                                                                                          popoutApplication?: SvelteApplication;
                                                                                                                                                                                                                                                                                                                          popoutOptions?: object;
                                                                                                                                                                                                                                                                                                                          svelte: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                          title?: string;
                                                                                                                                                                                                                                                                                                                          tooltip?: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      The configuration object to replace a core sidebar with a Svelte sidebar.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional condition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                                                        A boolean value or function to invoke that returns a boolean +FVTTSidebarReplaceData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias FVTTSidebarReplaceData

                                                                                                                                                                                                                                                                                                                        FVTTSidebarReplaceData: {
                                                                                                                                                                                                                                                                                                                            condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                            icon: string | TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                            id: string;
                                                                                                                                                                                                                                                                                                                            mergeAppImpl?: object;
                                                                                                                                                                                                                                                                                                                            popoutApplication?: SvelteApplication;
                                                                                                                                                                                                                                                                                                                            popoutOptions?: object;
                                                                                                                                                                                                                                                                                                                            svelte: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                            title?: string;
                                                                                                                                                                                                                                                                                                                            tooltip?: string;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        The configuration object to replace a core sidebar with a Svelte sidebar.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalcondition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                                                          A boolean value or function to invoke that returns a boolean value to control sidebar replacement. This is executed in the renderSidebar callback internally.

                                                                                                                                                                                                                                                                                                                        • icon: string | TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                          The FontAwesome icon css classes or a Svelte configuration object to load a custom Svelte component to use as the "icon".

                                                                                                                                                                                                                                                                                                                        • id: string

                                                                                                                                                                                                                                                                                                                          The ID for the sidebar to replace. This must be an existing sidebar tab ID.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional mergeAppImpl?: object

                                                                                                                                                                                                                                                                                                                          Provides a custom base implementation for the object instance for this sidebar +

                                                                                                                                                                                                                                                                                                                        • OptionalmergeAppImpl?: object

                                                                                                                                                                                                                                                                                                                          Provides a custom base implementation for the object instance for this sidebar app stored in globalThis.ui.<SIDEBAR ID>.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional popoutApplication?: SvelteApplication

                                                                                                                                                                                                                                                                                                                          Provides a custom +

                                                                                                                                                                                                                                                                                                                        • OptionalpopoutApplication?: SvelteApplication

                                                                                                                                                                                                                                                                                                                          Provides a custom SvelteApplication class to instantiate for the popout sidebar.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional popoutOptions?: object

                                                                                                                                                                                                                                                                                                                          Provides SvelteApplication options overrides for the default popout sidebar.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • OptionalpopoutOptions?: object

                                                                                                                                                                                                                                                                                                                          Provides SvelteApplication options overrides for the default popout sidebar.

                                                                                                                                                                                                                                                                                                                        • svelte: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                          A Svelte configuration object.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional title?: string

                                                                                                                                                                                                                                                                                                                          The popout application title text or i18n lang key.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional tooltip?: string

                                                                                                                                                                                                                                                                                                                          The sidebar tab tooltip text or i18n lang key.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                      • Optionaltitle?: string

                                                                                                                                                                                                                                                                                                                        The popout application title text or i18n lang key.

                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                      • Optionaltooltip?: string

                                                                                                                                                                                                                                                                                                                        The sidebar tab tooltip text or i18n lang key.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_application.TJSContextMenuItemData.html b/docs/types/_standard_application.TJSContextMenuItemData.html index f30c2117..e0ee7290 100644 --- a/docs/types/_standard_application.TJSContextMenuItemData.html +++ b/docs/types/_standard_application.TJSContextMenuItemData.html @@ -1,16 +1,17 @@ -TJSContextMenuItemData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias TJSContextMenuItemData

                                                                                                                                                                                                                                                                                                                      TJSContextMenuItemData: {
                                                                                                                                                                                                                                                                                                                          class?: Function;
                                                                                                                                                                                                                                                                                                                          condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                          icon?: string;
                                                                                                                                                                                                                                                                                                                          image?: string;
                                                                                                                                                                                                                                                                                                                          imageAlt?: string;
                                                                                                                                                                                                                                                                                                                          label?: string;
                                                                                                                                                                                                                                                                                                                          onPress?: ((item, object) => void);
                                                                                                                                                                                                                                                                                                                          props?: object;
                                                                                                                                                                                                                                                                                                                          separator?: "hr";
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines a menu item entry. Depending on the item data that is passed +TJSContextMenuItemData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias TJSContextMenuItemData

                                                                                                                                                                                                                                                                                                                      TJSContextMenuItemData: {
                                                                                                                                                                                                                                                                                                                          class?: Function;
                                                                                                                                                                                                                                                                                                                          condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                          icon?: string;
                                                                                                                                                                                                                                                                                                                          image?: string;
                                                                                                                                                                                                                                                                                                                          imageAlt?: string;
                                                                                                                                                                                                                                                                                                                          label?: string;
                                                                                                                                                                                                                                                                                                                          onPress?: ((item: TJSContextMenuItemData, object: any) => void);
                                                                                                                                                                                                                                                                                                                          props?: object;
                                                                                                                                                                                                                                                                                                                          separator?: "hr";
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines a menu item entry. Depending on the item data that is passed into the menu you can define 4 types of items: 'icon / label', 'image / label', 'class / Svelte component', and 'separator / hr'. A single callback function onPress is supported.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional class?: Function

                                                                                                                                                                                                                                                                                                                        A Svelte component class.

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                      • Optional condition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                                                        If a boolean and false or a function that invoked returns a falsy +

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optionalclass?: Function

                                                                                                                                                                                                                                                                                                                          A Svelte component class.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalcondition?: boolean | (() => boolean)

                                                                                                                                                                                                                                                                                                                          If a boolean and false or a function that invoked returns a falsy value this item is not added.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional icon?: string

                                                                                                                                                                                                                                                                                                                          A string containing icon classes.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional image?: string

                                                                                                                                                                                                                                                                                                                          An image icon path.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional imageAlt?: string

                                                                                                                                                                                                                                                                                                                          An image 'alt' text description.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional label?: string

                                                                                                                                                                                                                                                                                                                          A text string that is passed through localization.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional onPress?: ((item, object) => void)

                                                                                                                                                                                                                                                                                                                          A callback function that receives the selected +

                                                                                                                                                                                                                                                                                                                        • Optionalicon?: string

                                                                                                                                                                                                                                                                                                                          A string containing icon classes.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionalimage?: string

                                                                                                                                                                                                                                                                                                                          An image icon path.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • OptionalimageAlt?: string

                                                                                                                                                                                                                                                                                                                          An image 'alt' text description.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • Optionallabel?: string

                                                                                                                                                                                                                                                                                                                          A text string that is passed through localization.

                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                        • OptionalonPress?: ((item: TJSContextMenuItemData, object: any) => void)

                                                                                                                                                                                                                                                                                                                          A callback function that receives the selected item data and an object containing the A11yFocusSource data that can be passed to any Application / particularly modal dialogs returning focus when closed.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional props?: object

                                                                                                                                                                                                                                                                                                                          An object passed on as props for any Svelte component.

                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                        • Optional separator?: "hr"

                                                                                                                                                                                                                                                                                                                          A menu item separator; only 'hr' supported.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                    • Optionalprops?: object

                                                                                                                                                                                                                                                                                                                      An object passed on as props for any Svelte component.

                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                    • Optionalseparator?: "hr"

                                                                                                                                                                                                                                                                                                                      A menu item separator; only 'hr' supported.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      • Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.PMEditorExtra.html b/docs/types/_standard_component.PMEditorExtra.html index 67e2d19c..a678ca2c 100644 --- a/docs/types/_standard_component.PMEditorExtra.html +++ b/docs/types/_standard_component.PMEditorExtra.html @@ -1,3 +1,4 @@ -PMEditorExtra | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias PMEditorExtra

                                                                                                                                                                                                                                                                                                                      PMEditorExtra: {
                                                                                                                                                                                                                                                                                                                          initialSelectionDefault: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines extra data passed to TJSEditorOptions ProseMirror plugin.

                                                                                                                                                                                                                                                                                                                      +PMEditorExtra | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias PMEditorExtra

                                                                                                                                                                                                                                                                                                                      PMEditorExtra: {
                                                                                                                                                                                                                                                                                                                          initialSelectionDefault: string;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Defines extra data passed to TJSEditorOptions ProseMirror plugin.

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • initialSelectionDefault: string

                                                                                                                                                                                                                                                                                                                        The default value if `options.initialSelection is not defined.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSButton-1.Events.html b/docs/types/_standard_component.TJSButton-1.Events.html index 18e96520..25a022d3 100644 --- a/docs/types/_standard_component.TJSButton-1.Events.html +++ b/docs/types/_standard_component.TJSButton-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias Events

                                                                                                                                                                                                                                                                                                                      Events: {
                                                                                                                                                                                                                                                                                                                          click: MouseEvent;
                                                                                                                                                                                                                                                                                                                          contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                          press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                          [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias Events

                                                                                                                                                                                                                                                                                                                      Events: {
                                                                                                                                                                                                                                                                                                                          click: MouseEvent;
                                                                                                                                                                                                                                                                                                                          contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                          press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                          [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSButton-1.Props.html b/docs/types/_standard_component.TJSButton-1.Props.html index 9d0ec980..153f11fe 100644 --- a/docs/types/_standard_component.TJSButton-1.Props.html +++ b/docs/types/_standard_component.TJSButton-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias Props

                                                                                                                                                                                                                                                                                                                      Props: {
                                                                                                                                                                                                                                                                                                                          button?: any;
                                                                                                                                                                                                                                                                                                                          clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                          disabled?: any;
                                                                                                                                                                                                                                                                                                                          efx?: any;
                                                                                                                                                                                                                                                                                                                          icon?: any;
                                                                                                                                                                                                                                                                                                                          keyCode?: any;
                                                                                                                                                                                                                                                                                                                          label?: any;
                                                                                                                                                                                                                                                                                                                          onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                          onPress?: any;
                                                                                                                                                                                                                                                                                                                          styles?: any;
                                                                                                                                                                                                                                                                                                                          title?: any;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • Optional button?: any
                                                                                                                                                                                                                                                                                                                      • Optional clickPropagate?: any
                                                                                                                                                                                                                                                                                                                      • Optional disabled?: any
                                                                                                                                                                                                                                                                                                                      • Optional efx?: any
                                                                                                                                                                                                                                                                                                                      • Optional icon?: any
                                                                                                                                                                                                                                                                                                                      • Optional keyCode?: any
                                                                                                                                                                                                                                                                                                                      • Optional label?: any
                                                                                                                                                                                                                                                                                                                      • Optional onContextMenu?: any
                                                                                                                                                                                                                                                                                                                      • Optional onPress?: any
                                                                                                                                                                                                                                                                                                                      • Optional styles?: any
                                                                                                                                                                                                                                                                                                                      • Optional title?: any

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Type Alias Props

                                                                                                                                                                                                                                                                                                                      Props: {
                                                                                                                                                                                                                                                                                                                          button?: any;
                                                                                                                                                                                                                                                                                                                          clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                          disabled?: any;
                                                                                                                                                                                                                                                                                                                          efx?: any;
                                                                                                                                                                                                                                                                                                                          icon?: any;
                                                                                                                                                                                                                                                                                                                          keyCode?: any;
                                                                                                                                                                                                                                                                                                                          label?: any;
                                                                                                                                                                                                                                                                                                                          onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                          onPress?: any;
                                                                                                                                                                                                                                                                                                                          styles?: any;
                                                                                                                                                                                                                                                                                                                          title?: any;
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSButton-1.Slots.html b/docs/types/_standard_component.TJSButton-1.Slots.html index 64827251..5536d792 100644 --- a/docs/types/_standard_component.TJSButton-1.Slots.html +++ b/docs/types/_standard_component.TJSButton-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                      Type alias Slots

                                                                                                                                                                                                                                                                                                                      Slots: {
                                                                                                                                                                                                                                                                                                                          default: {};
                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                      Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                      • default: {}

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias Slots

                                                                                                                                                                                                                                                                                                                        Slots: {
                                                                                                                                                                                                                                                                                                                            default: {};
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSColordButton-1.Events.html b/docs/types/_standard_component.TJSColordButton-1.Events.html index 7ff6a900..09e40d29 100644 --- a/docs/types/_standard_component.TJSColordButton-1.Events.html +++ b/docs/types/_standard_component.TJSColordButton-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        Type alias Events

                                                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                                                            click: MouseEvent;
                                                                                                                                                                                                                                                                                                                            contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                            press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                        } & {
                                                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias Events

                                                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                                                            click: MouseEvent;
                                                                                                                                                                                                                                                                                                                            contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                            press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                        } & {
                                                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSColordButton-1.Props.html b/docs/types/_standard_component.TJSColordButton-1.Props.html index 5c262917..e0a6d927 100644 --- a/docs/types/_standard_component.TJSColordButton-1.Props.html +++ b/docs/types/_standard_component.TJSColordButton-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        Type alias Props

                                                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                                                            button?: any;
                                                                                                                                                                                                                                                                                                                            clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                            color?: any;
                                                                                                                                                                                                                                                                                                                            efx?: any;
                                                                                                                                                                                                                                                                                                                            keyCode?: any;
                                                                                                                                                                                                                                                                                                                            onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                            onPress?: any;
                                                                                                                                                                                                                                                                                                                            styles?: any;
                                                                                                                                                                                                                                                                                                                            title?: any;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • Optional button?: any
                                                                                                                                                                                                                                                                                                                        • Optional clickPropagate?: any
                                                                                                                                                                                                                                                                                                                        • Optional color?: any
                                                                                                                                                                                                                                                                                                                        • Optional efx?: any
                                                                                                                                                                                                                                                                                                                        • Optional keyCode?: any
                                                                                                                                                                                                                                                                                                                        • Optional onContextMenu?: any
                                                                                                                                                                                                                                                                                                                        • Optional onPress?: any
                                                                                                                                                                                                                                                                                                                        • Optional styles?: any
                                                                                                                                                                                                                                                                                                                        • Optional title?: any

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Type Alias Props

                                                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                                                            button?: any;
                                                                                                                                                                                                                                                                                                                            clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                            color?: any;
                                                                                                                                                                                                                                                                                                                            efx?: any;
                                                                                                                                                                                                                                                                                                                            keyCode?: any;
                                                                                                                                                                                                                                                                                                                            onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                            onPress?: any;
                                                                                                                                                                                                                                                                                                                            styles?: any;
                                                                                                                                                                                                                                                                                                                            title?: any;
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSColordButton-1.Slots.html b/docs/types/_standard_component.TJSColordButton-1.Slots.html index 1999151f..24e17356 100644 --- a/docs/types/_standard_component.TJSColordButton-1.Slots.html +++ b/docs/types/_standard_component.TJSColordButton-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                        Type alias Slots

                                                                                                                                                                                                                                                                                                                        Slots: {
                                                                                                                                                                                                                                                                                                                            default: {};
                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                        Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                        • default: {}

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Type Alias Slots

                                                                                                                                                                                                                                                                                                                          Slots: {
                                                                                                                                                                                                                                                                                                                              default: {};
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSColordPicker-1.Events.html b/docs/types/_standard_component.TJSColordPicker-1.Events.html index ce36ac91..8a2f3817 100644 --- a/docs/types/_standard_component.TJSColordPicker-1.Events.html +++ b/docs/types/_standard_component.TJSColordPicker-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                          Type alias Events

                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                              color: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Type Alias Events

                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                              color: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSColordPicker-1.Props.html b/docs/types/_standard_component.TJSColordPicker-1.Props.html index a7dbcf4b..4fafda16 100644 --- a/docs/types/_standard_component.TJSColordPicker-1.Props.html +++ b/docs/types/_standard_component.TJSColordPicker-1.Props.html @@ -1,4 +1,5 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                          Type alias Props

                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                              color?: TJSColordPickerColor;
                                                                                                                                                                                                                                                                                                                              options?: TJSColordPickerOptions;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Type Alias Props

                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                              color?: TJSColordPickerColor;
                                                                                                                                                                                                                                                                                                                              options?: TJSColordPickerOptions;
                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSColordPicker-1.Slots.html b/docs/types/_standard_component.TJSColordPicker-1.Slots.html index c60f8000..429d72dc 100644 --- a/docs/types/_standard_component.TJSColordPicker-1.Slots.html +++ b/docs/types/_standard_component.TJSColordPicker-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                          Type alias Slots

                                                                                                                                                                                                                                                                                                                          Slots: {}

                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Type Alias Slots

                                                                                                                                                                                                                                                                                                                            Slots: {}

                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSColordPickerColor.html b/docs/types/_standard_component.TJSColordPickerColor.html index 266b4d47..3e265956 100644 --- a/docs/types/_standard_component.TJSColordPickerColor.html +++ b/docs/types/_standard_component.TJSColordPickerColor.html @@ -1 +1,2 @@ -TJSColordPickerColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                            Type alias TJSColordPickerColor

                                                                                                                                                                                                                                                                                                                            TJSColordPickerColor: object | string

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +TJSColordPickerColor | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Type Alias TJSColordPickerColor

                                                                                                                                                                                                                                                                                                                            TJSColordPickerColor: object | string

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSColordPickerComponents.html b/docs/types/_standard_component.TJSColordPickerComponents.html index 934bed4e..4394be02 100644 --- a/docs/types/_standard_component.TJSColordPickerComponents.html +++ b/docs/types/_standard_component.TJSColordPickerComponents.html @@ -1,10 +1,11 @@ -TJSColordPickerComponents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                            Type alias TJSColordPickerComponents

                                                                                                                                                                                                                                                                                                                            TJSColordPickerComponents: {
                                                                                                                                                                                                                                                                                                                                alphaIndicator?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                alphaWrapper?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                focusWrap?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                pickerIndicator?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                pickerWrapper?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                sliderIndicator?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                sliderWrapper?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                textInput?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                wrapper?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +TJSColordPickerComponents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Type Alias TJSColordPickerComponents

                                                                                                                                                                                                                                                                                                                            TJSColordPickerComponents: {
                                                                                                                                                                                                                                                                                                                                alphaIndicator?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                alphaWrapper?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                focusWrap?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                pickerIndicator?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                pickerWrapper?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                sliderIndicator?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                sliderWrapper?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                textInput?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                wrapper?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSColordPickerOptions.html b/docs/types/_standard_component.TJSColordPickerOptions.html index 1a5747a1..d56f3a1d 100644 --- a/docs/types/_standard_component.TJSColordPickerOptions.html +++ b/docs/types/_standard_component.TJSColordPickerOptions.html @@ -1,19 +1,20 @@ -TJSColordPickerOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                            Type alias TJSColordPickerOptions

                                                                                                                                                                                                                                                                                                                            TJSColordPickerOptions: {
                                                                                                                                                                                                                                                                                                                                addons?: Iterable<Function>;
                                                                                                                                                                                                                                                                                                                                components?: TJSColordPickerComponents;
                                                                                                                                                                                                                                                                                                                                format?: "hex" | "hsl" | "hsv" | "rgb";
                                                                                                                                                                                                                                                                                                                                formatType?: "object" | "string";
                                                                                                                                                                                                                                                                                                                                hasAddons?: boolean;
                                                                                                                                                                                                                                                                                                                                hasAlpha?: boolean;
                                                                                                                                                                                                                                                                                                                                hasButtonBar?: boolean;
                                                                                                                                                                                                                                                                                                                                hasEyeDropper?: boolean;
                                                                                                                                                                                                                                                                                                                                hasTextInput?: boolean;
                                                                                                                                                                                                                                                                                                                                inputName?: string;
                                                                                                                                                                                                                                                                                                                                isPopup?: boolean;
                                                                                                                                                                                                                                                                                                                                layout?: "chrome";
                                                                                                                                                                                                                                                                                                                                lockTextFormat?: boolean;
                                                                                                                                                                                                                                                                                                                                precision?: number;
                                                                                                                                                                                                                                                                                                                                store?: Writable<TJSColordPickerColor>;
                                                                                                                                                                                                                                                                                                                                styles?: object;
                                                                                                                                                                                                                                                                                                                                width?: number | string;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                            • Optional addons?: Iterable<Function>

                                                                                                                                                                                                                                                                                                                              Iterable list of addon class constructor functions.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional components?: TJSColordPickerComponents

                                                                                                                                                                                                                                                                                                                              User defined picker component overrides.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional format?: "hex" | "hsl" | "hsv" | "rgb"

                                                                                                                                                                                                                                                                                                                              The user defined color format.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional formatType?: "object" | "string"

                                                                                                                                                                                                                                                                                                                              The user defined color format type.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional hasAddons?: boolean

                                                                                                                                                                                                                                                                                                                              Enables the addons panel / can set to false to hide panel when addons loaded.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional hasAlpha?: boolean

                                                                                                                                                                                                                                                                                                                              Enables alpha / opacity color selection and output.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional hasButtonBar?: boolean

                                                                                                                                                                                                                                                                                                                              Enables the button bar.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional hasEyeDropper?: boolean

                                                                                                                                                                                                                                                                                                                              Enables eye dropper support if available (requires secure context).

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional hasTextInput?: boolean

                                                                                                                                                                                                                                                                                                                              Enables text input component.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional inputName?: string

                                                                                                                                                                                                                                                                                                                              Name attribute for hidden input element / form submission.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional isPopup?: boolean

                                                                                                                                                                                                                                                                                                                              Is the picker configured as a pop-up.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional layout?: "chrome"

                                                                                                                                                                                                                                                                                                                              Picker layout variant.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional lockTextFormat?: boolean

                                                                                                                                                                                                                                                                                                                              When true text input format can not be changed from current format.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional precision?: number

                                                                                                                                                                                                                                                                                                                              A positive integer defining rounding precision.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional store?: Writable<TJSColordPickerColor>

                                                                                                                                                                                                                                                                                                                              An external store to update current color.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional styles?: object

                                                                                                                                                                                                                                                                                                                              Inline styles to apply to TJSColordPicker span; useful to set CSS variables.

                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                            • Optional width?: number | string

                                                                                                                                                                                                                                                                                                                              A positive integer greater than 50 defining the main container width in +TJSColordPickerOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Type Alias TJSColordPickerOptions

                                                                                                                                                                                                                                                                                                                              TJSColordPickerOptions: {
                                                                                                                                                                                                                                                                                                                                  addons?: Iterable<Function>;
                                                                                                                                                                                                                                                                                                                                  components?: TJSColordPickerComponents;
                                                                                                                                                                                                                                                                                                                                  format?:
                                                                                                                                                                                                                                                                                                                                      | "hex"
                                                                                                                                                                                                                                                                                                                                      | "hsl"
                                                                                                                                                                                                                                                                                                                                      | "hsv"
                                                                                                                                                                                                                                                                                                                                      | "rgb";
                                                                                                                                                                                                                                                                                                                                  formatType?: "object" | "string";
                                                                                                                                                                                                                                                                                                                                  hasAddons?: boolean;
                                                                                                                                                                                                                                                                                                                                  hasAlpha?: boolean;
                                                                                                                                                                                                                                                                                                                                  hasButtonBar?: boolean;
                                                                                                                                                                                                                                                                                                                                  hasEyeDropper?: boolean;
                                                                                                                                                                                                                                                                                                                                  hasTextInput?: boolean;
                                                                                                                                                                                                                                                                                                                                  inputName?: string;
                                                                                                                                                                                                                                                                                                                                  isPopup?: boolean;
                                                                                                                                                                                                                                                                                                                                  layout?: "chrome";
                                                                                                                                                                                                                                                                                                                                  lockTextFormat?: boolean;
                                                                                                                                                                                                                                                                                                                                  precision?: number;
                                                                                                                                                                                                                                                                                                                                  store?: Writable<TJSColordPickerColor>;
                                                                                                                                                                                                                                                                                                                                  styles?: object;
                                                                                                                                                                                                                                                                                                                                  width?: number | string;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                              • Optionaladdons?: Iterable<Function>

                                                                                                                                                                                                                                                                                                                                Iterable list of addon class constructor functions.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • Optionalcomponents?: TJSColordPickerComponents

                                                                                                                                                                                                                                                                                                                                User defined picker component overrides.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • Optionalformat?:
                                                                                                                                                                                                                                                                                                                                    | "hex"
                                                                                                                                                                                                                                                                                                                                    | "hsl"
                                                                                                                                                                                                                                                                                                                                    | "hsv"
                                                                                                                                                                                                                                                                                                                                    | "rgb"

                                                                                                                                                                                                                                                                                                                                The user defined color format.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • OptionalformatType?: "object" | "string"

                                                                                                                                                                                                                                                                                                                                The user defined color format type.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • OptionalhasAddons?: boolean

                                                                                                                                                                                                                                                                                                                                Enables the addons panel / can set to false to hide panel when addons loaded.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • OptionalhasAlpha?: boolean

                                                                                                                                                                                                                                                                                                                                Enables alpha / opacity color selection and output.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • OptionalhasButtonBar?: boolean

                                                                                                                                                                                                                                                                                                                                Enables the button bar.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • OptionalhasEyeDropper?: boolean

                                                                                                                                                                                                                                                                                                                                Enables eye dropper support if available (requires secure context).

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • OptionalhasTextInput?: boolean

                                                                                                                                                                                                                                                                                                                                Enables text input component.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • OptionalinputName?: string

                                                                                                                                                                                                                                                                                                                                Name attribute for hidden input element / form submission.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • OptionalisPopup?: boolean

                                                                                                                                                                                                                                                                                                                                Is the picker configured as a pop-up.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • Optionallayout?: "chrome"

                                                                                                                                                                                                                                                                                                                                Picker layout variant.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • OptionallockTextFormat?: boolean

                                                                                                                                                                                                                                                                                                                                When true text input format can not be changed from current format.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • Optionalprecision?: number

                                                                                                                                                                                                                                                                                                                                A positive integer defining rounding precision.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • Optionalstore?: Writable<TJSColordPickerColor>

                                                                                                                                                                                                                                                                                                                                An external store to update current color.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • Optionalstyles?: object

                                                                                                                                                                                                                                                                                                                                Inline styles to apply to TJSColordPicker span; useful to set CSS variables.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • Optionalwidth?: number | string

                                                                                                                                                                                                                                                                                                                                A positive integer greater than 50 defining the main container width in pixels or a valid CSS dimension string.

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSContentEdit-1.Events.html b/docs/types/_standard_component.TJSContentEdit-1.Events.html index 689dac12..4061b910 100644 --- a/docs/types/_standard_component.TJSContentEdit-1.Events.html +++ b/docs/types/_standard_component.TJSContentEdit-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                            Type alias Events

                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                editor:cancel: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                editor:document:deleted: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                editor:enrichedContent: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                editor:save: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                editor:start: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                            } & {
                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Type Alias Events

                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                editor:cancel: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                editor:document:deleted: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                editor:enrichedContent: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                editor:save: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                editor:start: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                            } & {
                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSContentEdit-1.Props.html b/docs/types/_standard_component.TJSContentEdit-1.Props.html index 8e4b134f..a788c465 100644 --- a/docs/types/_standard_component.TJSContentEdit-1.Props.html +++ b/docs/types/_standard_component.TJSContentEdit-1.Props.html @@ -1,3 +1,4 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                            Type alias Props

                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                content?: string;
                                                                                                                                                                                                                                                                                                                                enrichedContent?: string;
                                                                                                                                                                                                                                                                                                                                options?: TJSContentEditOptions;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                            • Optional content?: string
                                                                                                                                                                                                                                                                                                                            • Optional enrichedContent?: string
                                                                                                                                                                                                                                                                                                                            • Optional options?: TJSContentEditOptions

                                                                                                                                                                                                                                                                                                                              Provides the options object that can be reactively updated. See documentation above.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Type Alias Props

                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                content?: string;
                                                                                                                                                                                                                                                                                                                                enrichedContent?: string;
                                                                                                                                                                                                                                                                                                                                options?: TJSContentEditOptions;
                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                            • Optionalcontent?: string
                                                                                                                                                                                                                                                                                                                            • OptionalenrichedContent?: string
                                                                                                                                                                                                                                                                                                                            • Optionaloptions?: TJSContentEditOptions

                                                                                                                                                                                                                                                                                                                              Provides the options object that can be reactively updated. See documentation above.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSContentEdit-1.Slots.html b/docs/types/_standard_component.TJSContentEdit-1.Slots.html index 1efbf579..0082274d 100644 --- a/docs/types/_standard_component.TJSContentEdit-1.Slots.html +++ b/docs/types/_standard_component.TJSContentEdit-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                            Type alias Slots

                                                                                                                                                                                                                                                                                                                            Slots: {}

                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Type Alias Slots

                                                                                                                                                                                                                                                                                                                              Slots: {}

                                                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSContentEditOptions.html b/docs/types/_standard_component.TJSContentEditOptions.html index 7ad2a832..1b1efbe7 100644 --- a/docs/types/_standard_component.TJSContentEditOptions.html +++ b/docs/types/_standard_component.TJSContentEditOptions.html @@ -1,29 +1,30 @@ -TJSContentEditOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                              Type alias TJSContentEditOptions

                                                                                                                                                                                                                                                                                                                              TJSContentEditOptions: {
                                                                                                                                                                                                                                                                                                                                  DOMPurify?: {
                                                                                                                                                                                                                                                                                                                                      sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                  button?: boolean;
                                                                                                                                                                                                                                                                                                                                  classes?: string[];
                                                                                                                                                                                                                                                                                                                                  clickToEdit?: boolean;
                                                                                                                                                                                                                                                                                                                                  document?: foundry.abstract.Document;
                                                                                                                                                                                                                                                                                                                                  editable?: boolean;
                                                                                                                                                                                                                                                                                                                                  enrichContent?: boolean;
                                                                                                                                                                                                                                                                                                                                  enrichOptions?: globalThis.EnrichmentOptions;
                                                                                                                                                                                                                                                                                                                                  fieldName?: string;
                                                                                                                                                                                                                                                                                                                                  initialSelection?: "all" | "end" | "start";
                                                                                                                                                                                                                                                                                                                                  keyCode?: string;
                                                                                                                                                                                                                                                                                                                                  maxCharacterLength?: number;
                                                                                                                                                                                                                                                                                                                                  preventEnterKey?: boolean;
                                                                                                                                                                                                                                                                                                                                  preventPaste?: boolean;
                                                                                                                                                                                                                                                                                                                                  saveOnBlur?: boolean;
                                                                                                                                                                                                                                                                                                                                  saveOnEnterKey?: boolean;
                                                                                                                                                                                                                                                                                                                                  styles?: {
                                                                                                                                                                                                                                                                                                                                      [x: string]: string;
                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                              • Optional DOMPurify?: {
                                                                                                                                                                                                                                                                                                                                    sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                The DOMPurify export from -@typhonjs-fvtt/runtime/security/client/dompurify. Sanitizes content client side. Note: TinyMCE already does essential -<script> sanitization, so this is just an extra option that is available as an extra precaution.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                              • Optional button?: boolean

                                                                                                                                                                                                                                                                                                                                Provides an edit button to start editing. When button is false editing is +TJSContentEditOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Alias TJSContentEditOptions

                                                                                                                                                                                                                                                                                                                                TJSContentEditOptions: {
                                                                                                                                                                                                                                                                                                                                    button?: boolean;
                                                                                                                                                                                                                                                                                                                                    classes?: string[];
                                                                                                                                                                                                                                                                                                                                    clickToEdit?: boolean;
                                                                                                                                                                                                                                                                                                                                    document?: foundry.abstract.Document;
                                                                                                                                                                                                                                                                                                                                    DOMPurify?: {
                                                                                                                                                                                                                                                                                                                                        sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                    editable?: boolean;
                                                                                                                                                                                                                                                                                                                                    enrichContent?: boolean;
                                                                                                                                                                                                                                                                                                                                    enrichOptions?: globalThis.EnrichmentOptions;
                                                                                                                                                                                                                                                                                                                                    fieldName?: string;
                                                                                                                                                                                                                                                                                                                                    initialSelection?: "all" | "end" | "start";
                                                                                                                                                                                                                                                                                                                                    keyCode?: string;
                                                                                                                                                                                                                                                                                                                                    maxCharacterLength?: number;
                                                                                                                                                                                                                                                                                                                                    preventEnterKey?: boolean;
                                                                                                                                                                                                                                                                                                                                    preventPaste?: boolean;
                                                                                                                                                                                                                                                                                                                                    saveOnBlur?: boolean;
                                                                                                                                                                                                                                                                                                                                    saveOnEnterKey?: boolean;
                                                                                                                                                                                                                                                                                                                                    styles?: {
                                                                                                                                                                                                                                                                                                                                        [x: string]: string;
                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                • Optionalbutton?: boolean

                                                                                                                                                                                                                                                                                                                                  Provides an edit button to start editing. When button is false editing is always enabled.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional classes?: string[]

                                                                                                                                                                                                                                                                                                                                  An array of strings to add to the .editor element classes. This allows easier +

                                                                                                                                                                                                                                                                                                                                • Optionalclasses?: string[]

                                                                                                                                                                                                                                                                                                                                  An array of strings to add to the .editor element classes. This allows easier setting of CSS variables across a range of various editor components.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional clickToEdit?: boolean

                                                                                                                                                                                                                                                                                                                                  When true the edit button is not shown and a click on the editor +

                                                                                                                                                                                                                                                                                                                                • OptionalclickToEdit?: boolean

                                                                                                                                                                                                                                                                                                                                  When true the edit button is not shown and a click on the editor content initializes the editor.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional document?: foundry.abstract.Document

                                                                                                                                                                                                                                                                                                                                  Set to a Foundry document to load and save content from it. +

                                                                                                                                                                                                                                                                                                                                • Optionaldocument?: foundry.abstract.Document

                                                                                                                                                                                                                                                                                                                                  Set to a Foundry document to load and save content from it. Requires fieldName to be set.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional editable?: boolean

                                                                                                                                                                                                                                                                                                                                  Prevents editing and hides button. When set to false any active editor +

                                                                                                                                                                                                                                                                                                                                • OptionalDOMPurify?: {
                                                                                                                                                                                                                                                                                                                                      sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  The DOMPurify export from +@typhonjs-fvtt/runtime/security/client/dompurify. Sanitizes content client side. Note: TinyMCE already does essential +<script> sanitization, so this is just an extra option that is available as an extra precaution.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • Optionaleditable?: boolean

                                                                                                                                                                                                                                                                                                                                  Prevents editing and hides button. When set to false any active editor is cancelled. Default: user is GM or when a document is assigned the user has ownership.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional enrichContent?: boolean

                                                                                                                                                                                                                                                                                                                                  When set to false content won't be enriched by TextEditor.enrichHTML.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional enrichOptions?: globalThis.EnrichmentOptions

                                                                                                                                                                                                                                                                                                                                  Additional TextEditor.enrichHTML options.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional fieldName?: string

                                                                                                                                                                                                                                                                                                                                  A field name to load and save to / from associated document. IE a.b.c.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional initialSelection?: "all" | "end" | "start"

                                                                                                                                                                                                                                                                                                                                  Initial selection range; 'all', 'end' or 'start'.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional keyCode?: string

                                                                                                                                                                                                                                                                                                                                  Defines the key event code to activate the editor when focused.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional maxCharacterLength?: number

                                                                                                                                                                                                                                                                                                                                  When defined as an integer greater than 0 this limits the max +

                                                                                                                                                                                                                                                                                                                                • OptionalenrichContent?: boolean

                                                                                                                                                                                                                                                                                                                                  When set to false content won't be enriched by TextEditor.enrichHTML.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalenrichOptions?: globalThis.EnrichmentOptions

                                                                                                                                                                                                                                                                                                                                  Additional TextEditor.enrichHTML options.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalfieldName?: string

                                                                                                                                                                                                                                                                                                                                  A field name to load and save to / from associated document. IE a.b.c.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalinitialSelection?: "all" | "end" | "start"

                                                                                                                                                                                                                                                                                                                                  Initial selection range; 'all', 'end' or 'start'.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalkeyCode?: string

                                                                                                                                                                                                                                                                                                                                  Defines the key event code to activate the editor when focused.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalmaxCharacterLength?: number

                                                                                                                                                                                                                                                                                                                                  When defined as an integer greater than 0 this limits the max characters that can be entered.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional preventEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                  When true this prevents enter key from creating a new line / +

                                                                                                                                                                                                                                                                                                                                • OptionalpreventEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                  When true this prevents enter key from creating a new line / paragraph.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional preventPaste?: boolean

                                                                                                                                                                                                                                                                                                                                  Prevents pasting content into the editor.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional saveOnBlur?: boolean

                                                                                                                                                                                                                                                                                                                                  When true any loss of focus / blur from the editor saves the editor +

                                                                                                                                                                                                                                                                                                                                • OptionalpreventPaste?: boolean

                                                                                                                                                                                                                                                                                                                                  Prevents pasting content into the editor.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalsaveOnBlur?: boolean

                                                                                                                                                                                                                                                                                                                                  When true any loss of focus / blur from the editor saves the editor state.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional saveOnEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                  When true saves the editor state when the enter key is pressed.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional styles?: {
                                                                                                                                                                                                                                                                                                                                      [x: string]: string;
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  Additional CSS property names and values to set as inline styles. +

                                                                                                                                                                                                                                                                                                                                • OptionalsaveOnEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                  When true saves the editor state when the enter key is pressed.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • Optionalstyles?: {
                                                                                                                                                                                                                                                                                                                                      [x: string]: string;
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  Additional CSS property names and values to set as inline styles. This is useful for dynamically overriding any built in styles and in particular setting CSS variables supported.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                  • [x: string]: string

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                • [x: string]: string

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSFolderData.html b/docs/types/_standard_component.TJSFolderData.html index 089dff8b..02c9c4ad 100644 --- a/docs/types/_standard_component.TJSFolderData.html +++ b/docs/types/_standard_component.TJSFolderData.html @@ -1,20 +1,21 @@ -TJSFolderData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                              Type alias TJSFolderData

                                                                                                                                                                                                                                                                                                                              TJSFolderData: {
                                                                                                                                                                                                                                                                                                                                  id?: string;
                                                                                                                                                                                                                                                                                                                                  keyCode?: string;
                                                                                                                                                                                                                                                                                                                                  label?: string;
                                                                                                                                                                                                                                                                                                                                  onClose?: (() => void);
                                                                                                                                                                                                                                                                                                                                  onContextMenu?: ((event?) => void);
                                                                                                                                                                                                                                                                                                                                  onOpen?: (() => void);
                                                                                                                                                                                                                                                                                                                                  options?: TJSFolderOptions;
                                                                                                                                                                                                                                                                                                                                  slotDefault?: {
                                                                                                                                                                                                                                                                                                                                      class: Function;
                                                                                                                                                                                                                                                                                                                                      props?: object;
                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                  slotLabel?: {
                                                                                                                                                                                                                                                                                                                                      class: Function;
                                                                                                                                                                                                                                                                                                                                      props?: object;
                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                  slotSummaryEnd?: {
                                                                                                                                                                                                                                                                                                                                      class: Function;
                                                                                                                                                                                                                                                                                                                                      props?: object;
                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                  store?: Writable<boolean>;
                                                                                                                                                                                                                                                                                                                                  styles?: object;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                              • Optional id?: string
                                                                                                                                                                                                                                                                                                                                  +TJSFolderData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                  Type Alias TJSFolderData

                                                                                                                                                                                                                                                                                                                                  TJSFolderData: {
                                                                                                                                                                                                                                                                                                                                      id?: string;
                                                                                                                                                                                                                                                                                                                                      keyCode?: string;
                                                                                                                                                                                                                                                                                                                                      label?: string;
                                                                                                                                                                                                                                                                                                                                      onClose?: (() => void);
                                                                                                                                                                                                                                                                                                                                      onContextMenu?: ((event?: MouseEvent) => void);
                                                                                                                                                                                                                                                                                                                                      onOpen?: (() => void);
                                                                                                                                                                                                                                                                                                                                      options?: TJSFolderOptions;
                                                                                                                                                                                                                                                                                                                                      slotDefault?: {
                                                                                                                                                                                                                                                                                                                                          class: Function;
                                                                                                                                                                                                                                                                                                                                          props?: object;
                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                      slotLabel?: {
                                                                                                                                                                                                                                                                                                                                          class: Function;
                                                                                                                                                                                                                                                                                                                                          props?: object;
                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                      slotSummaryEnd?: {
                                                                                                                                                                                                                                                                                                                                          class: Function;
                                                                                                                                                                                                                                                                                                                                          props?: object;
                                                                                                                                                                                                                                                                                                                                      };
                                                                                                                                                                                                                                                                                                                                      store?: Writable<boolean>;
                                                                                                                                                                                                                                                                                                                                      styles?: object;
                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                  • Optionalid?: string
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • Optional keyCode?: string

                                                                                                                                                                                                                                                                                                                                    Defines the key event code to open / close summary when focused.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • Optional label?: string
                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                  • OptionalkeyCode?: string

                                                                                                                                                                                                                                                                                                                                    Defines the key event code to open / close summary when focused.

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                  • Optionallabel?: string
                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • Optional onClose?: (() => void)

                                                                                                                                                                                                                                                                                                                                    Callback when folder closed.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                      • (): void

                                                                                                                                                                                                                                                                                                                                      • Returns void

                                                                                                                                                                                                                                                                                                                                  • Optional onContextMenu?: ((event?) => void)

                                                                                                                                                                                                                                                                                                                                    Callback for context menu.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                      • (event?): void

                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                  • Optional onOpen?: (() => void)

                                                                                                                                                                                                                                                                                                                                    Callback when folder opened.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                      • (): void

                                                                                                                                                                                                                                                                                                                                      • Returns void

                                                                                                                                                                                                                                                                                                                                  • Optional options?: TJSFolderOptions

                                                                                                                                                                                                                                                                                                                                    Additional folder options.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • Optional slotDefault?: {
                                                                                                                                                                                                                                                                                                                                        class: Function;
                                                                                                                                                                                                                                                                                                                                        props?: object;
                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                    A minimal Svelte config defining the default content +

                                                                                                                                                                                                                                                                                                                                  • OptionalonClose?: (() => void)

                                                                                                                                                                                                                                                                                                                                    Callback when folder closed.

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                      • (): void

                                                                                                                                                                                                                                                                                                                                      • Returns void

                                                                                                                                                                                                                                                                                                                                  • OptionalonContextMenu?: ((event?: MouseEvent) => void)

                                                                                                                                                                                                                                                                                                                                    Callback for context menu.

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                      • (event?): void

                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                  • OptionalonOpen?: (() => void)

                                                                                                                                                                                                                                                                                                                                    Callback when folder opened.

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                      • (): void

                                                                                                                                                                                                                                                                                                                                      • Returns void

                                                                                                                                                                                                                                                                                                                                  • Optionaloptions?: TJSFolderOptions

                                                                                                                                                                                                                                                                                                                                    Additional folder options.

                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                  • OptionalslotDefault?: {
                                                                                                                                                                                                                                                                                                                                        class: Function;
                                                                                                                                                                                                                                                                                                                                        props?: object;
                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                    A minimal Svelte config defining the default content component.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • Optional slotLabel?: {
                                                                                                                                                                                                                                                                                                                                        class: Function;
                                                                                                                                                                                                                                                                                                                                        props?: object;
                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                    A minimal Svelte config defining the summary label +

                                                                                                                                                                                                                                                                                                                                  • OptionalslotLabel?: {
                                                                                                                                                                                                                                                                                                                                        class: Function;
                                                                                                                                                                                                                                                                                                                                        props?: object;
                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                    A minimal Svelte config defining the summary label component.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • Optional slotSummaryEnd?: {
                                                                                                                                                                                                                                                                                                                                        class: Function;
                                                                                                                                                                                                                                                                                                                                        props?: object;
                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                    A minimal Svelte config defining the summary end +

                                                                                                                                                                                                                                                                                                                                  • OptionalslotSummaryEnd?: {
                                                                                                                                                                                                                                                                                                                                        class: Function;
                                                                                                                                                                                                                                                                                                                                        props?: object;
                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                    A minimal Svelte config defining the summary end component.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • Optional store?: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                    Folder open / close store.

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                  • Optional styles?: object

                                                                                                                                                                                                                                                                                                                                    Additional styles to apply.

                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                              • Optionalstore?: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                Folder open / close store.

                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                              • Optionalstyles?: object

                                                                                                                                                                                                                                                                                                                                Additional styles to apply.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSFolderOptions.html b/docs/types/_standard_component.TJSFolderOptions.html index 95a18fac..edad3cc2 100644 --- a/docs/types/_standard_component.TJSFolderOptions.html +++ b/docs/types/_standard_component.TJSFolderOptions.html @@ -1,6 +1,7 @@ -TJSFolderOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                              Type alias TJSFolderOptions

                                                                                                                                                                                                                                                                                                                              TJSFolderOptions: {
                                                                                                                                                                                                                                                                                                                                  chevronOnly?: boolean;
                                                                                                                                                                                                                                                                                                                                  focusChevron?: boolean;
                                                                                                                                                                                                                                                                                                                                  focusIndicator?: boolean;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                              • Optional chevronOnly?: boolean

                                                                                                                                                                                                                                                                                                                                When true only clicks on the folder chevron open / close the summary.

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                              • Optional focusChevron?: boolean

                                                                                                                                                                                                                                                                                                                                When true the focus-visible outline for the summary will only be around the +TJSFolderOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Alias TJSFolderOptions

                                                                                                                                                                                                                                                                                                                                TJSFolderOptions: {
                                                                                                                                                                                                                                                                                                                                    chevronOnly?: boolean;
                                                                                                                                                                                                                                                                                                                                    focusChevron?: boolean;
                                                                                                                                                                                                                                                                                                                                    focusIndicator?: boolean;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                • OptionalchevronOnly?: boolean

                                                                                                                                                                                                                                                                                                                                  When true only clicks on the folder chevron open / close the summary.

                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                • OptionalfocusChevron?: boolean

                                                                                                                                                                                                                                                                                                                                  When true the focus-visible outline for the summary will only be around the chevron.

                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                • Optional focusIndicator?: boolean

                                                                                                                                                                                                                                                                                                                                  When true a focus-visible focus indicator is inserted between the +

                                                                                                                                                                                                                                                                                                                                • OptionalfocusIndicator?: boolean

                                                                                                                                                                                                                                                                                                                                  When true a focus-visible focus indicator is inserted between the chevron and summary label. This is a useful a11y focus indicator when outline isn't suitable.

                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSIconButton-1.Events.html b/docs/types/_standard_component.TJSIconButton-1.Events.html index e8d38a6f..02968a73 100644 --- a/docs/types/_standard_component.TJSIconButton-1.Events.html +++ b/docs/types/_standard_component.TJSIconButton-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                              Type alias Events

                                                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                                                  click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                  contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                                  press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                              } & {
                                                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Type Alias Events

                                                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                                                  click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                  contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                                  press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                              } & {
                                                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSIconButton-1.Props.html b/docs/types/_standard_component.TJSIconButton-1.Props.html index 15d023b8..03f10e37 100644 --- a/docs/types/_standard_component.TJSIconButton-1.Props.html +++ b/docs/types/_standard_component.TJSIconButton-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                              Type alias Props

                                                                                                                                                                                                                                                                                                                              Props: {
                                                                                                                                                                                                                                                                                                                                  button?: any;
                                                                                                                                                                                                                                                                                                                                  clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                  disabled?: any;
                                                                                                                                                                                                                                                                                                                                  efx?: any;
                                                                                                                                                                                                                                                                                                                                  icon?: any;
                                                                                                                                                                                                                                                                                                                                  keyCode?: any;
                                                                                                                                                                                                                                                                                                                                  onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                                  onPress?: any;
                                                                                                                                                                                                                                                                                                                                  styles?: any;
                                                                                                                                                                                                                                                                                                                                  title?: any;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                              • Optional button?: any
                                                                                                                                                                                                                                                                                                                              • Optional clickPropagate?: any
                                                                                                                                                                                                                                                                                                                              • Optional disabled?: any
                                                                                                                                                                                                                                                                                                                              • Optional efx?: any
                                                                                                                                                                                                                                                                                                                              • Optional icon?: any
                                                                                                                                                                                                                                                                                                                              • Optional keyCode?: any
                                                                                                                                                                                                                                                                                                                              • Optional onContextMenu?: any
                                                                                                                                                                                                                                                                                                                              • Optional onPress?: any
                                                                                                                                                                                                                                                                                                                              • Optional styles?: any
                                                                                                                                                                                                                                                                                                                              • Optional title?: any

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Type Alias Props

                                                                                                                                                                                                                                                                                                                              Props: {
                                                                                                                                                                                                                                                                                                                                  button?: any;
                                                                                                                                                                                                                                                                                                                                  clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                  disabled?: any;
                                                                                                                                                                                                                                                                                                                                  efx?: any;
                                                                                                                                                                                                                                                                                                                                  icon?: any;
                                                                                                                                                                                                                                                                                                                                  keyCode?: any;
                                                                                                                                                                                                                                                                                                                                  onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                                  onPress?: any;
                                                                                                                                                                                                                                                                                                                                  styles?: any;
                                                                                                                                                                                                                                                                                                                                  title?: any;
                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                              Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSIconButton-1.Slots.html b/docs/types/_standard_component.TJSIconButton-1.Slots.html index 5321e2ba..f4fb63fa 100644 --- a/docs/types/_standard_component.TJSIconButton-1.Slots.html +++ b/docs/types/_standard_component.TJSIconButton-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                              Type alias Slots

                                                                                                                                                                                                                                                                                                                              Slots: {}

                                                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Alias Slots

                                                                                                                                                                                                                                                                                                                                Slots: {}

                                                                                                                                                                                                                                                                                                                                Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_standard_component.TJSIconFolder-1.Events.html b/docs/types/_standard_component.TJSIconFolder-1.Events.html index 2503b06f..5740eb0a 100644 --- a/docs/types/_standard_component.TJSIconFolder-1.Events.html +++ b/docs/types/_standard_component.TJSIconFolder-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                Type alias Events

                                                                                                                                                                                                                                                                                                                                Events: {
                                                                                                                                                                                                                                                                                                                                    click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                    close: Event;
                                                                                                                                                                                                                                                                                                                                    closeAny: KeyboardEvent | UIEvent | Event | PointerEvent | MouseEvent | ErrorEvent | AnimationEvent | ClipboardEvent | CompositionEvent | DragEvent | FocusEvent | FormDataEvent | InputEvent | ProgressEvent<EventTarget> | SecurityPolicyViolationEvent | SubmitEvent | TouchEvent | TransitionEvent | WheelEvent;
                                                                                                                                                                                                                                                                                                                                    keydown: KeyboardEvent;
                                                                                                                                                                                                                                                                                                                                    keyup: KeyboardEvent;
                                                                                                                                                                                                                                                                                                                                    open: KeyboardEvent | UIEvent | Event | PointerEvent | MouseEvent | ErrorEvent | AnimationEvent | ClipboardEvent | CompositionEvent | DragEvent | FocusEvent | FormDataEvent | InputEvent | ProgressEvent<EventTarget> | SecurityPolicyViolationEvent | SubmitEvent | TouchEvent | TransitionEvent | WheelEvent;
                                                                                                                                                                                                                                                                                                                                    openAny: KeyboardEvent | UIEvent | Event | PointerEvent | MouseEvent | ErrorEvent | AnimationEvent | ClipboardEvent | CompositionEvent | DragEvent | FocusEvent | FormDataEvent | InputEvent | ProgressEvent<EventTarget> | SecurityPolicyViolationEvent | SubmitEvent | TouchEvent | TransitionEvent | WheelEvent;
                                                                                                                                                                                                                                                                                                                                } & {
                                                                                                                                                                                                                                                                                                                                    [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Alias Events

                                                                                                                                                                                                                                                                                                                                Events: {
                                                                                                                                                                                                                                                                                                                                    click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                    close: Event;
                                                                                                                                                                                                                                                                                                                                    closeAny:
                                                                                                                                                                                                                                                                                                                                        | KeyboardEvent
                                                                                                                                                                                                                                                                                                                                        | UIEvent
                                                                                                                                                                                                                                                                                                                                        | Event
                                                                                                                                                                                                                                                                                                                                        | PointerEvent
                                                                                                                                                                                                                                                                                                                                        | MouseEvent
                                                                                                                                                                                                                                                                                                                                        | ErrorEvent
                                                                                                                                                                                                                                                                                                                                        | AnimationEvent
                                                                                                                                                                                                                                                                                                                                        | ClipboardEvent
                                                                                                                                                                                                                                                                                                                                        | CompositionEvent
                                                                                                                                                                                                                                                                                                                                        | DragEvent
                                                                                                                                                                                                                                                                                                                                        | FocusEvent
                                                                                                                                                                                                                                                                                                                                        | FormDataEvent
                                                                                                                                                                                                                                                                                                                                        | InputEvent
                                                                                                                                                                                                                                                                                                                                        | ProgressEvent<EventTarget>
                                                                                                                                                                                                                                                                                                                                        | SecurityPolicyViolationEvent
                                                                                                                                                                                                                                                                                                                                        | SubmitEvent
                                                                                                                                                                                                                                                                                                                                        | TouchEvent
                                                                                                                                                                                                                                                                                                                                        | TransitionEvent
                                                                                                                                                                                                                                                                                                                                        | WheelEvent;
                                                                                                                                                                                                                                                                                                                                    keydown: KeyboardEvent;
                                                                                                                                                                                                                                                                                                                                    keyup: KeyboardEvent;
                                                                                                                                                                                                                                                                                                                                    open:
                                                                                                                                                                                                                                                                                                                                        | KeyboardEvent
                                                                                                                                                                                                                                                                                                                                        | UIEvent
                                                                                                                                                                                                                                                                                                                                        | Event
                                                                                                                                                                                                                                                                                                                                        | PointerEvent
                                                                                                                                                                                                                                                                                                                                        | MouseEvent
                                                                                                                                                                                                                                                                                                                                        | ErrorEvent
                                                                                                                                                                                                                                                                                                                                        | AnimationEvent
                                                                                                                                                                                                                                                                                                                                        | ClipboardEvent
                                                                                                                                                                                                                                                                                                                                        | CompositionEvent
                                                                                                                                                                                                                                                                                                                                        | DragEvent
                                                                                                                                                                                                                                                                                                                                        | FocusEvent
                                                                                                                                                                                                                                                                                                                                        | FormDataEvent
                                                                                                                                                                                                                                                                                                                                        | InputEvent
                                                                                                                                                                                                                                                                                                                                        | ProgressEvent<EventTarget>
                                                                                                                                                                                                                                                                                                                                        | SecurityPolicyViolationEvent
                                                                                                                                                                                                                                                                                                                                        | SubmitEvent
                                                                                                                                                                                                                                                                                                                                        | TouchEvent
                                                                                                                                                                                                                                                                                                                                        | TransitionEvent
                                                                                                                                                                                                                                                                                                                                        | WheelEvent;
                                                                                                                                                                                                                                                                                                                                    openAny:
                                                                                                                                                                                                                                                                                                                                        | KeyboardEvent
                                                                                                                                                                                                                                                                                                                                        | UIEvent
                                                                                                                                                                                                                                                                                                                                        | Event
                                                                                                                                                                                                                                                                                                                                        | PointerEvent
                                                                                                                                                                                                                                                                                                                                        | MouseEvent
                                                                                                                                                                                                                                                                                                                                        | ErrorEvent
                                                                                                                                                                                                                                                                                                                                        | AnimationEvent
                                                                                                                                                                                                                                                                                                                                        | ClipboardEvent
                                                                                                                                                                                                                                                                                                                                        | CompositionEvent
                                                                                                                                                                                                                                                                                                                                        | DragEvent
                                                                                                                                                                                                                                                                                                                                        | FocusEvent
                                                                                                                                                                                                                                                                                                                                        | FormDataEvent
                                                                                                                                                                                                                                                                                                                                        | InputEvent
                                                                                                                                                                                                                                                                                                                                        | ProgressEvent<EventTarget>
                                                                                                                                                                                                                                                                                                                                        | SecurityPolicyViolationEvent
                                                                                                                                                                                                                                                                                                                                        | SubmitEvent
                                                                                                                                                                                                                                                                                                                                        | TouchEvent
                                                                                                                                                                                                                                                                                                                                        | TransitionEvent
                                                                                                                                                                                                                                                                                                                                        | WheelEvent;
                                                                                                                                                                                                                                                                                                                                } & {
                                                                                                                                                                                                                                                                                                                                    [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_standard_component.TJSIconFolder-1.Props.html b/docs/types/_standard_component.TJSIconFolder-1.Props.html index 67319754..62897483 100644 --- a/docs/types/_standard_component.TJSIconFolder-1.Props.html +++ b/docs/types/_standard_component.TJSIconFolder-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                Type alias Props

                                                                                                                                                                                                                                                                                                                                Props: {
                                                                                                                                                                                                                                                                                                                                    animate?: boolean;
                                                                                                                                                                                                                                                                                                                                    folder?: TJSIconFolderData;
                                                                                                                                                                                                                                                                                                                                    iconClosed?: string;
                                                                                                                                                                                                                                                                                                                                    iconOpen?: string;
                                                                                                                                                                                                                                                                                                                                    id?: string;
                                                                                                                                                                                                                                                                                                                                    keyCode?: string;
                                                                                                                                                                                                                                                                                                                                    label?: string;
                                                                                                                                                                                                                                                                                                                                    onClose?: ((data?) => void);
                                                                                                                                                                                                                                                                                                                                    onContextMenu?: ((data?) => void);
                                                                                                                                                                                                                                                                                                                                    onOpen?: ((data?) => void);
                                                                                                                                                                                                                                                                                                                                    options?: TJSFolderOptions;
                                                                                                                                                                                                                                                                                                                                    store?: Writable<boolean>;
                                                                                                                                                                                                                                                                                                                                    styles?: object;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Type Alias Props

                                                                                                                                                                                                                                                                                                                                Props: {
                                                                                                                                                                                                                                                                                                                                    animate?: boolean;
                                                                                                                                                                                                                                                                                                                                    folder?: TJSIconFolderData;
                                                                                                                                                                                                                                                                                                                                    iconClosed?: string;
                                                                                                                                                                                                                                                                                                                                    iconOpen?: string;
                                                                                                                                                                                                                                                                                                                                    id?: string;
                                                                                                                                                                                                                                                                                                                                    keyCode?: string;
                                                                                                                                                                                                                                                                                                                                    label?: string;
                                                                                                                                                                                                                                                                                                                                    onClose?: ((data?: {
                                                                                                                                                                                                                                                                                                                                        event?: KeyboardEvent | PointerEvent;
                                                                                                                                                                                                                                                                                                                                    }) => void);
                                                                                                                                                                                                                                                                                                                                    onContextMenu?: ((data?: {
                                                                                                                                                                                                                                                                                                                                        event?: PointerEvent;
                                                                                                                                                                                                                                                                                                                                    }) => void);
                                                                                                                                                                                                                                                                                                                                    onOpen?: ((data?: {
                                                                                                                                                                                                                                                                                                                                        event?: KeyboardEvent | PointerEvent;
                                                                                                                                                                                                                                                                                                                                    }) => void);
                                                                                                                                                                                                                                                                                                                                    options?: TJSFolderOptions;
                                                                                                                                                                                                                                                                                                                                    store?: Writable<boolean>;
                                                                                                                                                                                                                                                                                                                                    styles?: object;
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_standard_component.TJSIconFolder-1.Slots.html b/docs/types/_standard_component.TJSIconFolder-1.Slots.html index c5d60f1e..27059569 100644 --- a/docs/types/_standard_component.TJSIconFolder-1.Slots.html +++ b/docs/types/_standard_component.TJSIconFolder-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                Type alias Slots

                                                                                                                                                                                                                                                                                                                                Slots: {
                                                                                                                                                                                                                                                                                                                                    default: {};
                                                                                                                                                                                                                                                                                                                                    label: {};
                                                                                                                                                                                                                                                                                                                                    summary-end: {};
                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                • default: {}
                                                                                                                                                                                                                                                                                                                                  • label: {}
                                                                                                                                                                                                                                                                                                                                    • summary-end: {}

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Type Alias Slots

                                                                                                                                                                                                                                                                                                                                      Slots: {
                                                                                                                                                                                                                                                                                                                                          default: {};
                                                                                                                                                                                                                                                                                                                                          label: {};
                                                                                                                                                                                                                                                                                                                                          summary-end: {};
                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                      Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSIconFolderData.html b/docs/types/_standard_component.TJSIconFolderData.html index 06015c12..b5618341 100644 --- a/docs/types/_standard_component.TJSIconFolderData.html +++ b/docs/types/_standard_component.TJSIconFolderData.html @@ -1 +1,2 @@ -TJSIconFolderData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                      Type alias TJSIconFolderData

                                                                                                                                                                                                                                                                                                                                      TJSIconFolderData: TJSFolderData

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSIconFolderData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Type Alias TJSIconFolderData

                                                                                                                                                                                                                                                                                                                                      TJSIconFolderData: TJSFolderData

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInput-1.Events.html b/docs/types/_standard_component.TJSInput-1.Events.html index 51751e09..4e23f5b7 100644 --- a/docs/types/_standard_component.TJSInput-1.Events.html +++ b/docs/types/_standard_component.TJSInput-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                      Type alias Events

                                                                                                                                                                                                                                                                                                                                      Events: {
                                                                                                                                                                                                                                                                                                                                          click: any;
                                                                                                                                                                                                                                                                                                                                          contextmenu: any;
                                                                                                                                                                                                                                                                                                                                          press: any;
                                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                                          [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                      Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                      • click: any
                                                                                                                                                                                                                                                                                                                                      • contextmenu: any
                                                                                                                                                                                                                                                                                                                                      • press: any

                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Type Alias Events

                                                                                                                                                                                                                                                                                                                                      Events: {
                                                                                                                                                                                                                                                                                                                                          click: any;
                                                                                                                                                                                                                                                                                                                                          contextmenu: any;
                                                                                                                                                                                                                                                                                                                                          press: any;
                                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                                          [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                      Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInput-1.Props.html b/docs/types/_standard_component.TJSInput-1.Props.html index e8645f47..42e2f319 100644 --- a/docs/types/_standard_component.TJSInput-1.Props.html +++ b/docs/types/_standard_component.TJSInput-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                      Type alias Props

                                                                                                                                                                                                                                                                                                                                      Props: {
                                                                                                                                                                                                                                                                                                                                          input?: any;
                                                                                                                                                                                                                                                                                                                                          type?: any;
                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                      Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                      • Optional input?: any
                                                                                                                                                                                                                                                                                                                                      • Optional type?: any

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Type Alias Props

                                                                                                                                                                                                                                                                                                                                      Props: {
                                                                                                                                                                                                                                                                                                                                          input?: any;
                                                                                                                                                                                                                                                                                                                                          type?: any;
                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                      Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInput-1.Slots.html b/docs/types/_standard_component.TJSInput-1.Slots.html index 4908f203..f017ab41 100644 --- a/docs/types/_standard_component.TJSInput-1.Slots.html +++ b/docs/types/_standard_component.TJSInput-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                      Type alias Slots

                                                                                                                                                                                                                                                                                                                                      Slots: {}

                                                                                                                                                                                                                                                                                                                                      Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Type Alias Slots

                                                                                                                                                                                                                                                                                                                                        Slots: {}

                                                                                                                                                                                                                                                                                                                                        Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInputCheckbox-1.Events.html b/docs/types/_standard_component.TJSInputCheckbox-1.Events.html index a60fcd00..aea459a7 100644 --- a/docs/types/_standard_component.TJSInputCheckbox-1.Events.html +++ b/docs/types/_standard_component.TJSInputCheckbox-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                        Type alias Events

                                                                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                                                                            pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                        } & {
                                                                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Type Alias Events

                                                                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                                                                            pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                        } & {
                                                                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInputCheckbox-1.Props.html b/docs/types/_standard_component.TJSInputCheckbox-1.Props.html index caefbfb4..10ad4c98 100644 --- a/docs/types/_standard_component.TJSInputCheckbox-1.Props.html +++ b/docs/types/_standard_component.TJSInputCheckbox-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                        Type alias Props

                                                                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                                                                            disabled?: any;
                                                                                                                                                                                                                                                                                                                                            efx?: any;
                                                                                                                                                                                                                                                                                                                                            input?: any;
                                                                                                                                                                                                                                                                                                                                            label?: any;
                                                                                                                                                                                                                                                                                                                                            readonly?: any;
                                                                                                                                                                                                                                                                                                                                            store?: any;
                                                                                                                                                                                                                                                                                                                                            styles?: any;
                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                        • Optional disabled?: any
                                                                                                                                                                                                                                                                                                                                        • Optional efx?: any
                                                                                                                                                                                                                                                                                                                                        • Optional input?: any
                                                                                                                                                                                                                                                                                                                                        • Optional label?: any
                                                                                                                                                                                                                                                                                                                                        • Optional readonly?: any
                                                                                                                                                                                                                                                                                                                                        • Optional store?: any
                                                                                                                                                                                                                                                                                                                                        • Optional styles?: any

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Type Alias Props

                                                                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                                                                            disabled?: any;
                                                                                                                                                                                                                                                                                                                                            efx?: any;
                                                                                                                                                                                                                                                                                                                                            input?: any;
                                                                                                                                                                                                                                                                                                                                            label?: any;
                                                                                                                                                                                                                                                                                                                                            readonly?: any;
                                                                                                                                                                                                                                                                                                                                            store?: any;
                                                                                                                                                                                                                                                                                                                                            styles?: any;
                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInputCheckbox-1.Slots.html b/docs/types/_standard_component.TJSInputCheckbox-1.Slots.html index c1a7c018..47041578 100644 --- a/docs/types/_standard_component.TJSInputCheckbox-1.Slots.html +++ b/docs/types/_standard_component.TJSInputCheckbox-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                        Type alias Slots

                                                                                                                                                                                                                                                                                                                                        Slots: {}

                                                                                                                                                                                                                                                                                                                                        Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Type Alias Slots

                                                                                                                                                                                                                                                                                                                                          Slots: {}

                                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInputNumber-1.Events.html b/docs/types/_standard_component.TJSInputNumber-1.Events.html index 6f6feb30..c3247005 100644 --- a/docs/types/_standard_component.TJSInputNumber-1.Events.html +++ b/docs/types/_standard_component.TJSInputNumber-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                          Type alias Events

                                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                                              pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Type Alias Events

                                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                                              pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInputNumber-1.Props.html b/docs/types/_standard_component.TJSInputNumber-1.Props.html index 3a9fc979..191b2e8d 100644 --- a/docs/types/_standard_component.TJSInputNumber-1.Props.html +++ b/docs/types/_standard_component.TJSInputNumber-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                          Type alias Props

                                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                                              disabled?: any;
                                                                                                                                                                                                                                                                                                                                              efx?: any;
                                                                                                                                                                                                                                                                                                                                              input?: any;
                                                                                                                                                                                                                                                                                                                                              label?: any;
                                                                                                                                                                                                                                                                                                                                              max?: any;
                                                                                                                                                                                                                                                                                                                                              min?: any;
                                                                                                                                                                                                                                                                                                                                              options?: any;
                                                                                                                                                                                                                                                                                                                                              placeholder?: any;
                                                                                                                                                                                                                                                                                                                                              readonly?: any;
                                                                                                                                                                                                                                                                                                                                              step?: any;
                                                                                                                                                                                                                                                                                                                                              store?: any;
                                                                                                                                                                                                                                                                                                                                              storeIsValid?: any;
                                                                                                                                                                                                                                                                                                                                              styles?: any;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                          • Optional disabled?: any
                                                                                                                                                                                                                                                                                                                                          • Optional efx?: any
                                                                                                                                                                                                                                                                                                                                          • Optional input?: any
                                                                                                                                                                                                                                                                                                                                          • Optional label?: any
                                                                                                                                                                                                                                                                                                                                          • Optional max?: any
                                                                                                                                                                                                                                                                                                                                          • Optional min?: any
                                                                                                                                                                                                                                                                                                                                          • Optional options?: any
                                                                                                                                                                                                                                                                                                                                          • Optional placeholder?: any
                                                                                                                                                                                                                                                                                                                                          • Optional readonly?: any
                                                                                                                                                                                                                                                                                                                                          • Optional step?: any
                                                                                                                                                                                                                                                                                                                                          • Optional store?: any
                                                                                                                                                                                                                                                                                                                                          • Optional storeIsValid?: any
                                                                                                                                                                                                                                                                                                                                          • Optional styles?: any

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Type Alias Props

                                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                                              disabled?: any;
                                                                                                                                                                                                                                                                                                                                              efx?: any;
                                                                                                                                                                                                                                                                                                                                              input?: any;
                                                                                                                                                                                                                                                                                                                                              label?: any;
                                                                                                                                                                                                                                                                                                                                              max?: any;
                                                                                                                                                                                                                                                                                                                                              min?: any;
                                                                                                                                                                                                                                                                                                                                              options?: any;
                                                                                                                                                                                                                                                                                                                                              placeholder?: any;
                                                                                                                                                                                                                                                                                                                                              readonly?: any;
                                                                                                                                                                                                                                                                                                                                              step?: any;
                                                                                                                                                                                                                                                                                                                                              store?: any;
                                                                                                                                                                                                                                                                                                                                              storeIsValid?: any;
                                                                                                                                                                                                                                                                                                                                              styles?: any;
                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInputNumber-1.Slots.html b/docs/types/_standard_component.TJSInputNumber-1.Slots.html index b6331f15..4a0335a3 100644 --- a/docs/types/_standard_component.TJSInputNumber-1.Slots.html +++ b/docs/types/_standard_component.TJSInputNumber-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                          Type alias Slots

                                                                                                                                                                                                                                                                                                                                          Slots: {}

                                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Type Alias Slots

                                                                                                                                                                                                                                                                                                                                            Slots: {}

                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInputText-1.Events.html b/docs/types/_standard_component.TJSInputText-1.Events.html index 7ef2f6e3..c9394e83 100644 --- a/docs/types/_standard_component.TJSInputText-1.Events.html +++ b/docs/types/_standard_component.TJSInputText-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                            Type alias Events

                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                            } & {
                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Type Alias Events

                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                            } & {
                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInputText-1.Props.html b/docs/types/_standard_component.TJSInputText-1.Props.html index db3c7292..3ec6b42e 100644 --- a/docs/types/_standard_component.TJSInputText-1.Props.html +++ b/docs/types/_standard_component.TJSInputText-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                            Type alias Props

                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                disabled?: any;
                                                                                                                                                                                                                                                                                                                                                efx?: any;
                                                                                                                                                                                                                                                                                                                                                input?: any;
                                                                                                                                                                                                                                                                                                                                                label?: any;
                                                                                                                                                                                                                                                                                                                                                options?: any;
                                                                                                                                                                                                                                                                                                                                                placeholder?: any;
                                                                                                                                                                                                                                                                                                                                                readonly?: any;
                                                                                                                                                                                                                                                                                                                                                store?: any;
                                                                                                                                                                                                                                                                                                                                                storeIsValid?: any;
                                                                                                                                                                                                                                                                                                                                                styles?: any;
                                                                                                                                                                                                                                                                                                                                                type?: any;
                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                            • Optional disabled?: any
                                                                                                                                                                                                                                                                                                                                            • Optional efx?: any
                                                                                                                                                                                                                                                                                                                                            • Optional input?: any
                                                                                                                                                                                                                                                                                                                                            • Optional label?: any
                                                                                                                                                                                                                                                                                                                                            • Optional options?: any
                                                                                                                                                                                                                                                                                                                                            • Optional placeholder?: any
                                                                                                                                                                                                                                                                                                                                            • Optional readonly?: any
                                                                                                                                                                                                                                                                                                                                            • Optional store?: any
                                                                                                                                                                                                                                                                                                                                            • Optional storeIsValid?: any
                                                                                                                                                                                                                                                                                                                                            • Optional styles?: any
                                                                                                                                                                                                                                                                                                                                            • Optional type?: any

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Type Alias Props

                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                disabled?: any;
                                                                                                                                                                                                                                                                                                                                                efx?: any;
                                                                                                                                                                                                                                                                                                                                                input?: any;
                                                                                                                                                                                                                                                                                                                                                label?: any;
                                                                                                                                                                                                                                                                                                                                                options?: any;
                                                                                                                                                                                                                                                                                                                                                placeholder?: any;
                                                                                                                                                                                                                                                                                                                                                readonly?: any;
                                                                                                                                                                                                                                                                                                                                                store?: any;
                                                                                                                                                                                                                                                                                                                                                storeIsValid?: any;
                                                                                                                                                                                                                                                                                                                                                styles?: any;
                                                                                                                                                                                                                                                                                                                                                type?: any;
                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSInputText-1.Slots.html b/docs/types/_standard_component.TJSInputText-1.Slots.html index b879121a..dab9e8d0 100644 --- a/docs/types/_standard_component.TJSInputText-1.Slots.html +++ b/docs/types/_standard_component.TJSInputText-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                            Type alias Slots

                                                                                                                                                                                                                                                                                                                                            Slots: {}

                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Type Alias Slots

                                                                                                                                                                                                                                                                                                                                              Slots: {}

                                                                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSMenu-1.Events.html b/docs/types/_standard_component.TJSMenu-1.Events.html index 24771488..c8114155 100644 --- a/docs/types/_standard_component.TJSMenu-1.Events.html +++ b/docs/types/_standard_component.TJSMenu-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                              Type alias Events

                                                                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Type Alias Events

                                                                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSMenu-1.Props.html b/docs/types/_standard_component.TJSMenu-1.Props.html index ee7e2115..25e75001 100644 --- a/docs/types/_standard_component.TJSMenu-1.Props.html +++ b/docs/types/_standard_component.TJSMenu-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                              Type alias Props

                                                                                                                                                                                                                                                                                                                                              Props: {
                                                                                                                                                                                                                                                                                                                                                  efx?: Function;
                                                                                                                                                                                                                                                                                                                                                  focusEl?: HTMLElement | string;
                                                                                                                                                                                                                                                                                                                                                  items?: Iterable<TJSMenuItemData>;
                                                                                                                                                                                                                                                                                                                                                  keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                  menu?: TJSMenuData;
                                                                                                                                                                                                                                                                                                                                                  offset?: {
                                                                                                                                                                                                                                                                                                                                                      x?: number;
                                                                                                                                                                                                                                                                                                                                                      y?: number;
                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                  styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                  transitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                      duration: number;
                                                                                                                                                                                                                                                                                                                                                      easing: Function;
                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                              Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                              • Optional efx?: Function
                                                                                                                                                                                                                                                                                                                                              • Optional focusEl?: HTMLElement | string
                                                                                                                                                                                                                                                                                                                                              • Optional items?: Iterable<TJSMenuItemData>
                                                                                                                                                                                                                                                                                                                                              • Optional keyCode?: string
                                                                                                                                                                                                                                                                                                                                              • Optional menu?: TJSMenuData
                                                                                                                                                                                                                                                                                                                                              • Optional offset?: {
                                                                                                                                                                                                                                                                                                                                                    x?: number;
                                                                                                                                                                                                                                                                                                                                                    y?: number;
                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                • Optional x?: number
                                                                                                                                                                                                                                                                                                                                                • Optional y?: number
                                                                                                                                                                                                                                                                                                                                              • Optional styles?: Record<string, string>
                                                                                                                                                                                                                                                                                                                                              • Optional transitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                    duration: number;
                                                                                                                                                                                                                                                                                                                                                    easing: Function;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Type Alias Props

                                                                                                                                                                                                                                                                                                                                              Props: {
                                                                                                                                                                                                                                                                                                                                                  efx?: Function;
                                                                                                                                                                                                                                                                                                                                                  focusEl?: HTMLElement | string;
                                                                                                                                                                                                                                                                                                                                                  items?: Iterable<TJSMenuItemData>;
                                                                                                                                                                                                                                                                                                                                                  keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                  menu?: TJSMenuData;
                                                                                                                                                                                                                                                                                                                                                  offset?: {
                                                                                                                                                                                                                                                                                                                                                      x?: number;
                                                                                                                                                                                                                                                                                                                                                      y?: number;
                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                  styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                  transitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                      duration: number;
                                                                                                                                                                                                                                                                                                                                                      easing: Function;
                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                              Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSMenu-1.Slots.html b/docs/types/_standard_component.TJSMenu-1.Slots.html index 4637560d..272ffeaf 100644 --- a/docs/types/_standard_component.TJSMenu-1.Slots.html +++ b/docs/types/_standard_component.TJSMenu-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                              Type alias Slots

                                                                                                                                                                                                                                                                                                                                              Slots: {
                                                                                                                                                                                                                                                                                                                                                  after: {};
                                                                                                                                                                                                                                                                                                                                                  before: {};
                                                                                                                                                                                                                                                                                                                                                  default: {};
                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                              • after: {}
                                                                                                                                                                                                                                                                                                                                                • before: {}
                                                                                                                                                                                                                                                                                                                                                  • default: {}

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                    Slots: {
                                                                                                                                                                                                                                                                                                                                                        after: {};
                                                                                                                                                                                                                                                                                                                                                        before: {};
                                                                                                                                                                                                                                                                                                                                                        default: {};
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component.TJSMenuData.html b/docs/types/_standard_component.TJSMenuData.html index d3e9e3ee..3d0cbd74 100644 --- a/docs/types/_standard_component.TJSMenuData.html +++ b/docs/types/_standard_component.TJSMenuData.html @@ -1,14 +1,15 @@ -TJSMenuData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                    Type alias TJSMenuData

                                                                                                                                                                                                                                                                                                                                                    TJSMenuData: {
                                                                                                                                                                                                                                                                                                                                                        efx?: Function;
                                                                                                                                                                                                                                                                                                                                                        items?: Iterable<TJSMenuItemData>;
                                                                                                                                                                                                                                                                                                                                                        keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                        offset?: {
                                                                                                                                                                                                                                                                                                                                                            x?: number;
                                                                                                                                                                                                                                                                                                                                                            y?: number;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        slotAfter?: {
                                                                                                                                                                                                                                                                                                                                                            class: Function;
                                                                                                                                                                                                                                                                                                                                                            props?: object;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        slotBefore?: {
                                                                                                                                                                                                                                                                                                                                                            class: Function;
                                                                                                                                                                                                                                                                                                                                                            props?: object;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        slotDefault?: {
                                                                                                                                                                                                                                                                                                                                                            class: Function;
                                                                                                                                                                                                                                                                                                                                                            props?: object;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                        transitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                            duration: number;
                                                                                                                                                                                                                                                                                                                                                            easing: EasingReference;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optional efx?: Function

                                                                                                                                                                                                                                                                                                                                                      Currently unused; for any future action effects.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optional items?: Iterable<TJSMenuItemData>

                                                                                                                                                                                                                                                                                                                                                      The data driven menu items.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optional keyCode?: string

                                                                                                                                                                                                                                                                                                                                                      The key code to activate menu items.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optional offset?: {
                                                                                                                                                                                                                                                                                                                                                          x?: number;
                                                                                                                                                                                                                                                                                                                                                          y?: number;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Optional X / Y offsets for the menu display.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      • Optional x?: number
                                                                                                                                                                                                                                                                                                                                                      • Optional y?: number
                                                                                                                                                                                                                                                                                                                                                    • Optional slotAfter?: {
                                                                                                                                                                                                                                                                                                                                                          class: Function;
                                                                                                                                                                                                                                                                                                                                                          props?: object;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      A minimal Svelte config defining a menu item component +TJSMenuData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias TJSMenuData

                                                                                                                                                                                                                                                                                                                                                      TJSMenuData: {
                                                                                                                                                                                                                                                                                                                                                          efx?: Function;
                                                                                                                                                                                                                                                                                                                                                          items?: Iterable<TJSMenuItemData>;
                                                                                                                                                                                                                                                                                                                                                          keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                          offset?: {
                                                                                                                                                                                                                                                                                                                                                              x?: number;
                                                                                                                                                                                                                                                                                                                                                              y?: number;
                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                          slotAfter?: {
                                                                                                                                                                                                                                                                                                                                                              class: Function;
                                                                                                                                                                                                                                                                                                                                                              props?: object;
                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                          slotBefore?: {
                                                                                                                                                                                                                                                                                                                                                              class: Function;
                                                                                                                                                                                                                                                                                                                                                              props?: object;
                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                          slotDefault?: {
                                                                                                                                                                                                                                                                                                                                                              class: Function;
                                                                                                                                                                                                                                                                                                                                                              props?: object;
                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                          styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                          transitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                              duration: number;
                                                                                                                                                                                                                                                                                                                                                              easing: EasingReference;
                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      • Optionalefx?: Function

                                                                                                                                                                                                                                                                                                                                                        Currently unused; for any future action effects.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionalitems?: Iterable<TJSMenuItemData>

                                                                                                                                                                                                                                                                                                                                                        The data driven menu items.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalkeyCode?: string

                                                                                                                                                                                                                                                                                                                                                        The key code to activate menu items.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionaloffset?: {
                                                                                                                                                                                                                                                                                                                                                            x?: number;
                                                                                                                                                                                                                                                                                                                                                            y?: number;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Optional X / Y offsets for the menu display.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                        • Optionalx?: number
                                                                                                                                                                                                                                                                                                                                                        • Optionaly?: number
                                                                                                                                                                                                                                                                                                                                                      • OptionalslotAfter?: {
                                                                                                                                                                                                                                                                                                                                                            class: Function;
                                                                                                                                                                                                                                                                                                                                                            props?: object;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        A minimal Svelte config defining a menu item component after the main data driven menu items.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional slotBefore?: {
                                                                                                                                                                                                                                                                                                                                                            class: Function;
                                                                                                                                                                                                                                                                                                                                                            props?: object;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        A minimal Svelte config defining a menu item component +

                                                                                                                                                                                                                                                                                                                                                      • OptionalslotBefore?: {
                                                                                                                                                                                                                                                                                                                                                            class: Function;
                                                                                                                                                                                                                                                                                                                                                            props?: object;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        A minimal Svelte config defining a menu item component before the main data driven menu items.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional slotDefault?: {
                                                                                                                                                                                                                                                                                                                                                            class: Function;
                                                                                                                                                                                                                                                                                                                                                            props?: object;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        A minimal Svelte config defining the default content +

                                                                                                                                                                                                                                                                                                                                                      • OptionalslotDefault?: {
                                                                                                                                                                                                                                                                                                                                                            class: Function;
                                                                                                                                                                                                                                                                                                                                                            props?: object;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        A minimal Svelte config defining the default content component replacing the data driven menu items.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional styles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                        Styles to be applied inline.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional transitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                            duration: number;
                                                                                                                                                                                                                                                                                                                                                            easing: EasingReference;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Custom transition options for duration and easing +

                                                                                                                                                                                                                                                                                                                                                      • Optionalstyles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                        Styles to be applied inline.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionaltransitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                            duration: number;
                                                                                                                                                                                                                                                                                                                                                            easing: EasingReference;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Custom transition options for duration and easing function reference. The default easing function is quintOut.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component.TJSMenuItemData.html b/docs/types/_standard_component.TJSMenuItemData.html index 4d2c7ba1..39eda761 100644 --- a/docs/types/_standard_component.TJSMenuItemData.html +++ b/docs/types/_standard_component.TJSMenuItemData.html @@ -1,12 +1,13 @@ -TJSMenuItemData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                    Type alias TJSMenuItemData

                                                                                                                                                                                                                                                                                                                                                    TJSMenuItemData: {
                                                                                                                                                                                                                                                                                                                                                        class?: Function;
                                                                                                                                                                                                                                                                                                                                                        condition?: boolean | Function;
                                                                                                                                                                                                                                                                                                                                                        icon?: string;
                                                                                                                                                                                                                                                                                                                                                        image?: string;
                                                                                                                                                                                                                                                                                                                                                        imageAlt?: string;
                                                                                                                                                                                                                                                                                                                                                        label?: string;
                                                                                                                                                                                                                                                                                                                                                        onPress?: ((data?) => any);
                                                                                                                                                                                                                                                                                                                                                        props?: object;
                                                                                                                                                                                                                                                                                                                                                        separator?: "hr";
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optional class?: Function

                                                                                                                                                                                                                                                                                                                                                      A Svelte component class.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optional condition?: boolean | Function

                                                                                                                                                                                                                                                                                                                                                      If a boolean and false or a function that invoked returns a falsy value +TJSMenuItemData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias TJSMenuItemData

                                                                                                                                                                                                                                                                                                                                                      TJSMenuItemData: {
                                                                                                                                                                                                                                                                                                                                                          class?: Function;
                                                                                                                                                                                                                                                                                                                                                          condition?: boolean | Function;
                                                                                                                                                                                                                                                                                                                                                          icon?: string;
                                                                                                                                                                                                                                                                                                                                                          image?: string;
                                                                                                                                                                                                                                                                                                                                                          imageAlt?: string;
                                                                                                                                                                                                                                                                                                                                                          label?: string;
                                                                                                                                                                                                                                                                                                                                                          onPress?: ((data?: {
                                                                                                                                                                                                                                                                                                                                                              event?: KeyboardEvent | PointerEvent;
                                                                                                                                                                                                                                                                                                                                                              focusSource?: A11yFocusSource;
                                                                                                                                                                                                                                                                                                                                                              item?: TJSMenuItemData;
                                                                                                                                                                                                                                                                                                                                                          }) => any);
                                                                                                                                                                                                                                                                                                                                                          props?: object;
                                                                                                                                                                                                                                                                                                                                                          separator?: "hr";
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      • Optionalclass?: Function

                                                                                                                                                                                                                                                                                                                                                        A Svelte component class.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionalcondition?: boolean | Function

                                                                                                                                                                                                                                                                                                                                                        If a boolean and false or a function that invoked returns a falsy value this item is not added.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional icon?: string

                                                                                                                                                                                                                                                                                                                                                        A string containing icon classes.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional image?: string

                                                                                                                                                                                                                                                                                                                                                        An image icon path.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional imageAlt?: string

                                                                                                                                                                                                                                                                                                                                                        An image 'alt' text description.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional label?: string

                                                                                                                                                                                                                                                                                                                                                        A text string that is passed through localization.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional onPress?: ((data?) => any)

                                                                                                                                                                                                                                                                                                                                                        A callback function to invoke; The object contains the item menu item data and an A11yFocusSource object +

                                                                                                                                                                                                                                                                                                                                                      • Optionalicon?: string

                                                                                                                                                                                                                                                                                                                                                        A string containing icon classes.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionalimage?: string

                                                                                                                                                                                                                                                                                                                                                        An image icon path.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalimageAlt?: string

                                                                                                                                                                                                                                                                                                                                                        An image 'alt' text description.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionallabel?: string

                                                                                                                                                                                                                                                                                                                                                        A text string that is passed through localization.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalonPress?: ((data?: {
                                                                                                                                                                                                                                                                                                                                                            event?: KeyboardEvent | PointerEvent;
                                                                                                                                                                                                                                                                                                                                                            focusSource?: A11yFocusSource;
                                                                                                                                                                                                                                                                                                                                                            item?: TJSMenuItemData;
                                                                                                                                                                                                                                                                                                                                                        }) => any)

                                                                                                                                                                                                                                                                                                                                                        A callback function to invoke; The object contains the item menu item data and an A11yFocusSource object to potentially pass to a new application.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional props?: object

                                                                                                                                                                                                                                                                                                                                                        An object passed on as props for any Svelte component.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optional separator?: "hr"

                                                                                                                                                                                                                                                                                                                                                        A menu item separator; only 'hr' supported.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                    • Optionalprops?: object

                                                                                                                                                                                                                                                                                                                                                      An object passed on as props for any Svelte component.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • Optionalseparator?: "hr"

                                                                                                                                                                                                                                                                                                                                                      A menu item separator; only 'hr' supported.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component.TJSPositionControlLayer-1.Events.html b/docs/types/_standard_component.TJSPositionControlLayer-1.Events.html index 81a6d0a0..110660ba 100644 --- a/docs/types/_standard_component.TJSPositionControlLayer-1.Events.html +++ b/docs/types/_standard_component.TJSPositionControlLayer-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                    Type alias Events

                                                                                                                                                                                                                                                                                                                                                    Events: {
                                                                                                                                                                                                                                                                                                                                                        [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Events

                                                                                                                                                                                                                                                                                                                                                    Events: {
                                                                                                                                                                                                                                                                                                                                                        [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component.TJSPositionControlLayer-1.Props.html b/docs/types/_standard_component.TJSPositionControlLayer-1.Props.html index 54a20164..3d92dba1 100644 --- a/docs/types/_standard_component.TJSPositionControlLayer-1.Props.html +++ b/docs/types/_standard_component.TJSPositionControlLayer-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                    Type alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        boundingRect?: any;
                                                                                                                                                                                                                                                                                                                                                        components?: any;
                                                                                                                                                                                                                                                                                                                                                        controls?: ControlsStore;
                                                                                                                                                                                                                                                                                                                                                        enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                        validate?: boolean;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optional boundingRect?: any
                                                                                                                                                                                                                                                                                                                                                    • Optional components?: any
                                                                                                                                                                                                                                                                                                                                                    • Optional controls?: ControlsStore
                                                                                                                                                                                                                                                                                                                                                    • Optional enabled?: boolean
                                                                                                                                                                                                                                                                                                                                                    • Optional validate?: boolean

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        boundingRect?: any;
                                                                                                                                                                                                                                                                                                                                                        components?: any;
                                                                                                                                                                                                                                                                                                                                                        controls?: ControlsStore;
                                                                                                                                                                                                                                                                                                                                                        enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                        validate?: boolean;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component.TJSPositionControlLayer-1.Slots.html b/docs/types/_standard_component.TJSPositionControlLayer-1.Slots.html index cea3b093..52767de0 100644 --- a/docs/types/_standard_component.TJSPositionControlLayer-1.Slots.html +++ b/docs/types/_standard_component.TJSPositionControlLayer-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                    Type alias Slots

                                                                                                                                                                                                                                                                                                                                                    Slots: {
                                                                                                                                                                                                                                                                                                                                                        default: {};
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • default: {}

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                      Slots: {
                                                                                                                                                                                                                                                                                                                                                          default: {};
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSProseMirror-1.Events.html b/docs/types/_standard_component.TJSProseMirror-1.Events.html index 6b13d436..e000a5ad 100644 --- a/docs/types/_standard_component.TJSProseMirror-1.Events.html +++ b/docs/types/_standard_component.TJSProseMirror-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                      Type alias Events

                                                                                                                                                                                                                                                                                                                                                      Events: {
                                                                                                                                                                                                                                                                                                                                                          editor:cancel: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          editor:document:deleted: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          editor:enrichedContent: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          editor:save: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          editor:start: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                                                          [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias Events

                                                                                                                                                                                                                                                                                                                                                      Events: {
                                                                                                                                                                                                                                                                                                                                                          editor:cancel: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          editor:document:deleted: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          editor:enrichedContent: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          editor:save: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          editor:start: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                                                          [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSProseMirror-1.Props.html b/docs/types/_standard_component.TJSProseMirror-1.Props.html index f55686d8..06e99a0f 100644 --- a/docs/types/_standard_component.TJSProseMirror-1.Props.html +++ b/docs/types/_standard_component.TJSProseMirror-1.Props.html @@ -1,3 +1,4 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                      Type alias Props

                                                                                                                                                                                                                                                                                                                                                      Props: {
                                                                                                                                                                                                                                                                                                                                                          content?: string;
                                                                                                                                                                                                                                                                                                                                                          enrichedContent?: string;
                                                                                                                                                                                                                                                                                                                                                          options?: TJSProseMirrorOptions;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      • Optional content?: string
                                                                                                                                                                                                                                                                                                                                                      • Optional enrichedContent?: string
                                                                                                                                                                                                                                                                                                                                                      • Optional options?: TJSProseMirrorOptions

                                                                                                                                                                                                                                                                                                                                                        Provides the options object that can be reactively updated. See documentation above.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias Props

                                                                                                                                                                                                                                                                                                                                                      Props: {
                                                                                                                                                                                                                                                                                                                                                          content?: string;
                                                                                                                                                                                                                                                                                                                                                          enrichedContent?: string;
                                                                                                                                                                                                                                                                                                                                                          options?: TJSProseMirrorOptions;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      • Optionalcontent?: string
                                                                                                                                                                                                                                                                                                                                                      • OptionalenrichedContent?: string
                                                                                                                                                                                                                                                                                                                                                      • Optionaloptions?: TJSProseMirrorOptions

                                                                                                                                                                                                                                                                                                                                                        Provides the options object that can be reactively updated. See documentation above.

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component.TJSProseMirror-1.Slots.html b/docs/types/_standard_component.TJSProseMirror-1.Slots.html index f04e18a3..6c8b5f3c 100644 --- a/docs/types/_standard_component.TJSProseMirror-1.Slots.html +++ b/docs/types/_standard_component.TJSProseMirror-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                      Type alias Slots

                                                                                                                                                                                                                                                                                                                                                      Slots: {}

                                                                                                                                                                                                                                                                                                                                                      Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                        Slots: {}

                                                                                                                                                                                                                                                                                                                                                        Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSProseMirrorOptions.html b/docs/types/_standard_component.TJSProseMirrorOptions.html index 426022f9..75977d1e 100644 --- a/docs/types/_standard_component.TJSProseMirrorOptions.html +++ b/docs/types/_standard_component.TJSProseMirrorOptions.html @@ -1,24 +1,25 @@ -TJSProseMirrorOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                        Type alias TJSProseMirrorOptions

                                                                                                                                                                                                                                                                                                                                                        TJSProseMirrorOptions: {
                                                                                                                                                                                                                                                                                                                                                            DOMPurify?: {
                                                                                                                                                                                                                                                                                                                                                                sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            button?: boolean;
                                                                                                                                                                                                                                                                                                                                                            classes?: string[];
                                                                                                                                                                                                                                                                                                                                                            clickToEdit?: boolean;
                                                                                                                                                                                                                                                                                                                                                            collaborate?: boolean;
                                                                                                                                                                                                                                                                                                                                                            document?: foundry.abstract.Document;
                                                                                                                                                                                                                                                                                                                                                            editable?: boolean;
                                                                                                                                                                                                                                                                                                                                                            enrichContent?: boolean;
                                                                                                                                                                                                                                                                                                                                                            enrichOptions?: globalThis.EnrichmentOptions;
                                                                                                                                                                                                                                                                                                                                                            fieldName?: string;
                                                                                                                                                                                                                                                                                                                                                            initialSelection?: "all" | "end" | "start";
                                                                                                                                                                                                                                                                                                                                                            keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                            menuCompact?: boolean;
                                                                                                                                                                                                                                                                                                                                                            plugins?: Record<string, globalThis.ProseMirror.Plugin>;
                                                                                                                                                                                                                                                                                                                                                            styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                        • Optional DOMPurify?: {
                                                                                                                                                                                                                                                                                                                                                              sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          The DOMPurify export from -@typhonjs-fvtt/runtime/security/client/dompurify. Sanitizes content client side. Note: TinyMCE already does essential -<script> sanitization, so this is just an extra option that is available as an extra precaution.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • Optional button?: boolean

                                                                                                                                                                                                                                                                                                                                                          Provides an edit button to start editing. When button is false editing is +TJSProseMirrorOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Type Alias TJSProseMirrorOptions

                                                                                                                                                                                                                                                                                                                                                          TJSProseMirrorOptions: {
                                                                                                                                                                                                                                                                                                                                                              button?: boolean;
                                                                                                                                                                                                                                                                                                                                                              classes?: string[];
                                                                                                                                                                                                                                                                                                                                                              clickToEdit?: boolean;
                                                                                                                                                                                                                                                                                                                                                              collaborate?: boolean;
                                                                                                                                                                                                                                                                                                                                                              document?: foundry.abstract.Document;
                                                                                                                                                                                                                                                                                                                                                              DOMPurify?: {
                                                                                                                                                                                                                                                                                                                                                                  sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                                              };
                                                                                                                                                                                                                                                                                                                                                              editable?: boolean;
                                                                                                                                                                                                                                                                                                                                                              enrichContent?: boolean;
                                                                                                                                                                                                                                                                                                                                                              enrichOptions?: globalThis.EnrichmentOptions;
                                                                                                                                                                                                                                                                                                                                                              fieldName?: string;
                                                                                                                                                                                                                                                                                                                                                              initialSelection?: "all" | "end" | "start";
                                                                                                                                                                                                                                                                                                                                                              keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                              menuCompact?: boolean;
                                                                                                                                                                                                                                                                                                                                                              plugins?: Record<string, globalThis.ProseMirror.Plugin>;
                                                                                                                                                                                                                                                                                                                                                              styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                          • Optionalbutton?: boolean

                                                                                                                                                                                                                                                                                                                                                            Provides an edit button to start editing. When button is false editing is always enabled.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional classes?: string[]

                                                                                                                                                                                                                                                                                                                                                            An array of strings to add to the .editor element classes. This allows easier +

                                                                                                                                                                                                                                                                                                                                                          • Optionalclasses?: string[]

                                                                                                                                                                                                                                                                                                                                                            An array of strings to add to the .editor element classes. This allows easier setting of CSS variables across a range of various editor components.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional clickToEdit?: boolean

                                                                                                                                                                                                                                                                                                                                                            When true the edit button is not shown and a click on the editor +

                                                                                                                                                                                                                                                                                                                                                          • OptionalclickToEdit?: boolean

                                                                                                                                                                                                                                                                                                                                                            When true the edit button is not shown and a click on the editor content initializes the editor.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional collaborate?: boolean

                                                                                                                                                                                                                                                                                                                                                            Enables ProseMirror collaboration; requires a document to be set.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional document?: foundry.abstract.Document

                                                                                                                                                                                                                                                                                                                                                            Set to a Foundry document to load and save content from it. +

                                                                                                                                                                                                                                                                                                                                                          • Optionalcollaborate?: boolean

                                                                                                                                                                                                                                                                                                                                                            Enables ProseMirror collaboration; requires a document to be set.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • Optionaldocument?: foundry.abstract.Document

                                                                                                                                                                                                                                                                                                                                                            Set to a Foundry document to load and save content from it. Requires fieldName to be set.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional editable?: boolean

                                                                                                                                                                                                                                                                                                                                                            Prevents editing and hides button. When set to false any active editor +

                                                                                                                                                                                                                                                                                                                                                          • OptionalDOMPurify?: {
                                                                                                                                                                                                                                                                                                                                                                sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            The DOMPurify export from +@typhonjs-fvtt/runtime/security/client/dompurify. Sanitizes content client side. Note: TinyMCE already does essential +<script> sanitization, so this is just an extra option that is available as an extra precaution.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • Optionaleditable?: boolean

                                                                                                                                                                                                                                                                                                                                                            Prevents editing and hides button. When set to false any active editor is cancelled. Default: user is GM or when a document is assigned the user has ownership.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional enrichContent?: boolean

                                                                                                                                                                                                                                                                                                                                                            When set to false content won't be enriched by TextEditor.enrichHTML.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional enrichOptions?: globalThis.EnrichmentOptions

                                                                                                                                                                                                                                                                                                                                                            Additional TextEditor.enrichHTML options.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional fieldName?: string

                                                                                                                                                                                                                                                                                                                                                            A field name to load and save to / from associated document. IE a.b.c.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional initialSelection?: "all" | "end" | "start"

                                                                                                                                                                                                                                                                                                                                                            Initial selection range; 'all', 'end' or 'start'.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional keyCode?: string

                                                                                                                                                                                                                                                                                                                                                            Defines the key event code to activate the editor when focused.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional menuCompact?: boolean

                                                                                                                                                                                                                                                                                                                                                            Initializes the ProseMirror editor with a compact menu.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional plugins?: Record<string, globalThis.ProseMirror.Plugin>

                                                                                                                                                                                                                                                                                                                                                            Additional ProseMirror plugins to load.

                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                          • Optional styles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                            Additional CSS property names and values to set as inline styles. +

                                                                                                                                                                                                                                                                                                                                                          • OptionalenrichContent?: boolean

                                                                                                                                                                                                                                                                                                                                                            When set to false content won't be enriched by TextEditor.enrichHTML.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • OptionalenrichOptions?: globalThis.EnrichmentOptions

                                                                                                                                                                                                                                                                                                                                                            Additional TextEditor.enrichHTML options.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • OptionalfieldName?: string

                                                                                                                                                                                                                                                                                                                                                            A field name to load and save to / from associated document. IE a.b.c.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • OptionalinitialSelection?: "all" | "end" | "start"

                                                                                                                                                                                                                                                                                                                                                            Initial selection range; 'all', 'end' or 'start'.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • OptionalkeyCode?: string

                                                                                                                                                                                                                                                                                                                                                            Defines the key event code to activate the editor when focused.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • OptionalmenuCompact?: boolean

                                                                                                                                                                                                                                                                                                                                                            Initializes the ProseMirror editor with a compact menu.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • Optionalplugins?: Record<string, globalThis.ProseMirror.Plugin>

                                                                                                                                                                                                                                                                                                                                                            Additional ProseMirror plugins to load.

                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                          • Optionalstyles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                            Additional CSS property names and values to set as inline styles. This is useful for dynamically overriding any built in styles and in particular setting CSS variables supported.

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSScrollContainer-1.Events.html b/docs/types/_standard_component.TJSScrollContainer-1.Events.html index d7319256..beeb4c15 100644 --- a/docs/types/_standard_component.TJSScrollContainer-1.Events.html +++ b/docs/types/_standard_component.TJSScrollContainer-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                        Type alias Events

                                                                                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Type Alias Events

                                                                                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSScrollContainer-1.Props.html b/docs/types/_standard_component.TJSScrollContainer-1.Props.html index 21e2c59f..9d64fd7b 100644 --- a/docs/types/_standard_component.TJSScrollContainer-1.Props.html +++ b/docs/types/_standard_component.TJSScrollContainer-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                        Type alias Props

                                                                                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                                                                                            container?: TJSScrollContainerData;
                                                                                                                                                                                                                                                                                                                                                            scrollTop?: Writable<number>;
                                                                                                                                                                                                                                                                                                                                                            styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Type Alias Props

                                                                                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                                                                                            container?: TJSScrollContainerData;
                                                                                                                                                                                                                                                                                                                                                            scrollTop?: Writable<number>;
                                                                                                                                                                                                                                                                                                                                                            styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component.TJSScrollContainer-1.Slots.html b/docs/types/_standard_component.TJSScrollContainer-1.Slots.html index 73c6125b..5e6e4447 100644 --- a/docs/types/_standard_component.TJSScrollContainer-1.Slots.html +++ b/docs/types/_standard_component.TJSScrollContainer-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                        Type alias Slots

                                                                                                                                                                                                                                                                                                                                                        Slots: {
                                                                                                                                                                                                                                                                                                                                                            default: {};
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                        • default: {}

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                          Slots: {
                                                                                                                                                                                                                                                                                                                                                              default: {};
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSScrollContainerData.html b/docs/types/_standard_component.TJSScrollContainerData.html index dbd4f1f5..a1d00b3f 100644 --- a/docs/types/_standard_component.TJSScrollContainerData.html +++ b/docs/types/_standard_component.TJSScrollContainerData.html @@ -1,8 +1,9 @@ -TJSScrollContainerData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                          Type alias TJSScrollContainerData

                                                                                                                                                                                                                                                                                                                                                          TJSScrollContainerData: {
                                                                                                                                                                                                                                                                                                                                                              class?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                                              props?: object;
                                                                                                                                                                                                                                                                                                                                                              scrollTop?: Writable<number>;
                                                                                                                                                                                                                                                                                                                                                              styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                          • Optional class?: SvelteComponent

                                                                                                                                                                                                                                                                                                                                                            A svelte component class used as the content component when +TJSScrollContainerData | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Alias TJSScrollContainerData

                                                                                                                                                                                                                                                                                                                                                            TJSScrollContainerData: {
                                                                                                                                                                                                                                                                                                                                                                class?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                                                props?: object;
                                                                                                                                                                                                                                                                                                                                                                scrollTop?: Writable<number>;
                                                                                                                                                                                                                                                                                                                                                                styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                            • Optionalclass?: SvelteComponent

                                                                                                                                                                                                                                                                                                                                                              A svelte component class used as the content component when there is no slotted component defined.

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                            • Optional props?: object

                                                                                                                                                                                                                                                                                                                                                              An object to apply to any data defined Svelte component when there is no slotted +

                                                                                                                                                                                                                                                                                                                                                            • Optionalprops?: object

                                                                                                                                                                                                                                                                                                                                                              An object to apply to any data defined Svelte component when there is no slotted component defined.

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                            • Optional scrollTop?: Writable<number>

                                                                                                                                                                                                                                                                                                                                                              A Svelte store that serializes the scroll top +

                                                                                                                                                                                                                                                                                                                                                            • OptionalscrollTop?: Writable<number>

                                                                                                                                                                                                                                                                                                                                                              A Svelte store that serializes the scroll top position of the scrollable container.

                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                            • Optional styles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                              Inline styles to assign to the container.

                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                          • Optionalstyles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                            Inline styles to assign to the container.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSelect-1.Events.html b/docs/types/_standard_component.TJSSelect-1.Events.html index d5494e57..bb4f0950 100644 --- a/docs/types/_standard_component.TJSSelect-1.Events.html +++ b/docs/types/_standard_component.TJSSelect-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                          Type alias Events

                                                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                                                              change: Event;
                                                                                                                                                                                                                                                                                                                                                              pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Type Alias Events

                                                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                                                              change: Event;
                                                                                                                                                                                                                                                                                                                                                              pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSelect-1.Props.html b/docs/types/_standard_component.TJSSelect-1.Props.html index 0577085e..832ab834 100644 --- a/docs/types/_standard_component.TJSSelect-1.Props.html +++ b/docs/types/_standard_component.TJSSelect-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                          Type alias Props

                                                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                                                              disabled?: any;
                                                                                                                                                                                                                                                                                                                                                              efx?: any;
                                                                                                                                                                                                                                                                                                                                                              label?: any;
                                                                                                                                                                                                                                                                                                                                                              options?: any;
                                                                                                                                                                                                                                                                                                                                                              select?: any;
                                                                                                                                                                                                                                                                                                                                                              selected?: any;
                                                                                                                                                                                                                                                                                                                                                              store?: any;
                                                                                                                                                                                                                                                                                                                                                              styles?: any;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                          • Optional disabled?: any
                                                                                                                                                                                                                                                                                                                                                          • Optional efx?: any
                                                                                                                                                                                                                                                                                                                                                          • Optional label?: any
                                                                                                                                                                                                                                                                                                                                                          • Optional options?: any
                                                                                                                                                                                                                                                                                                                                                          • Optional select?: any
                                                                                                                                                                                                                                                                                                                                                          • Optional selected?: any
                                                                                                                                                                                                                                                                                                                                                          • Optional store?: any
                                                                                                                                                                                                                                                                                                                                                          • Optional styles?: any

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Type Alias Props

                                                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                                                              disabled?: any;
                                                                                                                                                                                                                                                                                                                                                              efx?: any;
                                                                                                                                                                                                                                                                                                                                                              label?: any;
                                                                                                                                                                                                                                                                                                                                                              options?: any;
                                                                                                                                                                                                                                                                                                                                                              select?: any;
                                                                                                                                                                                                                                                                                                                                                              selected?: any;
                                                                                                                                                                                                                                                                                                                                                              store?: any;
                                                                                                                                                                                                                                                                                                                                                              styles?: any;
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSelect-1.Slots.html b/docs/types/_standard_component.TJSSelect-1.Slots.html index 6eb677d8..2f7fe49a 100644 --- a/docs/types/_standard_component.TJSSelect-1.Slots.html +++ b/docs/types/_standard_component.TJSSelect-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                          Type alias Slots

                                                                                                                                                                                                                                                                                                                                                          Slots: {}

                                                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                            Slots: {}

                                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSettingsEdit-1.Events.html b/docs/types/_standard_component.TJSSettingsEdit-1.Events.html index c00478e5..e7d4fb98 100644 --- a/docs/types/_standard_component.TJSSettingsEdit-1.Events.html +++ b/docs/types/_standard_component.TJSSettingsEdit-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                            Type alias Events

                                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Alias Events

                                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSettingsEdit-1.Props.html b/docs/types/_standard_component.TJSSettingsEdit-1.Props.html index 7b8dbb97..fa06e322 100644 --- a/docs/types/_standard_component.TJSSettingsEdit-1.Props.html +++ b/docs/types/_standard_component.TJSSettingsEdit-1.Props.html @@ -1,3 +1,4 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                            Type alias Props

                                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                                options?: TJSSettingsCreateOptions;
                                                                                                                                                                                                                                                                                                                                                                settings?: TJSGameSettings;
                                                                                                                                                                                                                                                                                                                                                                styles?: object;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Alias Props

                                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                                options?: TJSSettingsCreateOptions;
                                                                                                                                                                                                                                                                                                                                                                settings?: TJSGameSettings;
                                                                                                                                                                                                                                                                                                                                                                styles?: object;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSettingsEdit-1.Slots.html b/docs/types/_standard_component.TJSSettingsEdit-1.Slots.html index 296ad40f..5faa2ff8 100644 --- a/docs/types/_standard_component.TJSSettingsEdit-1.Slots.html +++ b/docs/types/_standard_component.TJSSettingsEdit-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                            Type alias Slots

                                                                                                                                                                                                                                                                                                                                                            Slots: {
                                                                                                                                                                                                                                                                                                                                                                settings-footer: {
                                                                                                                                                                                                                                                                                                                                                                    options: any;
                                                                                                                                                                                                                                                                                                                                                                    settings: any;
                                                                                                                                                                                                                                                                                                                                                                    uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                settings-header: {
                                                                                                                                                                                                                                                                                                                                                                    options: any;
                                                                                                                                                                                                                                                                                                                                                                    settings: any;
                                                                                                                                                                                                                                                                                                                                                                    uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                            • settings-footer: {
                                                                                                                                                                                                                                                                                                                                                                  options: any;
                                                                                                                                                                                                                                                                                                                                                                  settings: any;
                                                                                                                                                                                                                                                                                                                                                                  uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              • options: any
                                                                                                                                                                                                                                                                                                                                                              • settings: any
                                                                                                                                                                                                                                                                                                                                                              • uiSettings: any
                                                                                                                                                                                                                                                                                                                                                            • settings-header: {
                                                                                                                                                                                                                                                                                                                                                                  options: any;
                                                                                                                                                                                                                                                                                                                                                                  settings: any;
                                                                                                                                                                                                                                                                                                                                                                  uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                              }
                                                                                                                                                                                                                                                                                                                                                              • options: any
                                                                                                                                                                                                                                                                                                                                                              • settings: any
                                                                                                                                                                                                                                                                                                                                                              • uiSettings: any

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                            Slots: {
                                                                                                                                                                                                                                                                                                                                                                settings-footer: {
                                                                                                                                                                                                                                                                                                                                                                    options: any;
                                                                                                                                                                                                                                                                                                                                                                    settings: any;
                                                                                                                                                                                                                                                                                                                                                                    uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                settings-header: {
                                                                                                                                                                                                                                                                                                                                                                    options: any;
                                                                                                                                                                                                                                                                                                                                                                    settings: any;
                                                                                                                                                                                                                                                                                                                                                                    uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSettingsSwap-1.Events.html b/docs/types/_standard_component.TJSSettingsSwap-1.Events.html index 1c035075..b44d137f 100644 --- a/docs/types/_standard_component.TJSSettingsSwap-1.Events.html +++ b/docs/types/_standard_component.TJSSettingsSwap-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                            Type alias Events

                                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Alias Events

                                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSettingsSwap-1.Props.html b/docs/types/_standard_component.TJSSettingsSwap-1.Props.html index f282b7f4..ab5564d5 100644 --- a/docs/types/_standard_component.TJSSettingsSwap-1.Props.html +++ b/docs/types/_standard_component.TJSSettingsSwap-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                            Type alias Props

                                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                                options?: TJSSettingsCreateOptions;
                                                                                                                                                                                                                                                                                                                                                                settings?: TJSGameSettings;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Type Alias Props

                                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                                options?: TJSSettingsCreateOptions;
                                                                                                                                                                                                                                                                                                                                                                settings?: TJSGameSettings;
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSettingsSwap-1.Slots.html b/docs/types/_standard_component.TJSSettingsSwap-1.Slots.html index 7274a5f3..d5128d1f 100644 --- a/docs/types/_standard_component.TJSSettingsSwap-1.Slots.html +++ b/docs/types/_standard_component.TJSSettingsSwap-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                            Type alias Slots

                                                                                                                                                                                                                                                                                                                                                            Slots: {
                                                                                                                                                                                                                                                                                                                                                                default: {};
                                                                                                                                                                                                                                                                                                                                                                settings-footer: {
                                                                                                                                                                                                                                                                                                                                                                    options: any;
                                                                                                                                                                                                                                                                                                                                                                    settings: any;
                                                                                                                                                                                                                                                                                                                                                                    slot: string;
                                                                                                                                                                                                                                                                                                                                                                    uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                settings-header: {
                                                                                                                                                                                                                                                                                                                                                                    options: any;
                                                                                                                                                                                                                                                                                                                                                                    settings: any;
                                                                                                                                                                                                                                                                                                                                                                    slot: string;
                                                                                                                                                                                                                                                                                                                                                                    uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                            • default: {}
                                                                                                                                                                                                                                                                                                                                                              • settings-footer: {
                                                                                                                                                                                                                                                                                                                                                                    options: any;
                                                                                                                                                                                                                                                                                                                                                                    settings: any;
                                                                                                                                                                                                                                                                                                                                                                    slot: string;
                                                                                                                                                                                                                                                                                                                                                                    uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                • options: any
                                                                                                                                                                                                                                                                                                                                                                • settings: any
                                                                                                                                                                                                                                                                                                                                                                • slot: string
                                                                                                                                                                                                                                                                                                                                                                • uiSettings: any
                                                                                                                                                                                                                                                                                                                                                              • settings-header: {
                                                                                                                                                                                                                                                                                                                                                                    options: any;
                                                                                                                                                                                                                                                                                                                                                                    settings: any;
                                                                                                                                                                                                                                                                                                                                                                    slot: string;
                                                                                                                                                                                                                                                                                                                                                                    uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                }
                                                                                                                                                                                                                                                                                                                                                                • options: any
                                                                                                                                                                                                                                                                                                                                                                • settings: any
                                                                                                                                                                                                                                                                                                                                                                • slot: string
                                                                                                                                                                                                                                                                                                                                                                • uiSettings: any

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                              Slots: {
                                                                                                                                                                                                                                                                                                                                                                  default: {};
                                                                                                                                                                                                                                                                                                                                                                  settings-footer: {
                                                                                                                                                                                                                                                                                                                                                                      options: any;
                                                                                                                                                                                                                                                                                                                                                                      settings: any;
                                                                                                                                                                                                                                                                                                                                                                      slot: string;
                                                                                                                                                                                                                                                                                                                                                                      uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                  settings-header: {
                                                                                                                                                                                                                                                                                                                                                                      options: any;
                                                                                                                                                                                                                                                                                                                                                                      settings: any;
                                                                                                                                                                                                                                                                                                                                                                      slot: string;
                                                                                                                                                                                                                                                                                                                                                                      uiSettings: any;
                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSideSlideLayer-1.Events.html b/docs/types/_standard_component.TJSSideSlideLayer-1.Events.html index 8e17c805..ddc116c5 100644 --- a/docs/types/_standard_component.TJSSideSlideLayer-1.Events.html +++ b/docs/types/_standard_component.TJSSideSlideLayer-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                              Type alias Events

                                                                                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Type Alias Events

                                                                                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSideSlideLayer-1.Props.html b/docs/types/_standard_component.TJSSideSlideLayer-1.Props.html index 2e33fad0..96557e62 100644 --- a/docs/types/_standard_component.TJSSideSlideLayer-1.Props.html +++ b/docs/types/_standard_component.TJSSideSlideLayer-1.Props.html @@ -1,20 +1,21 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                              Type alias Props

                                                                                                                                                                                                                                                                                                                                                              Props: {
                                                                                                                                                                                                                                                                                                                                                                  allowLocking?: boolean;
                                                                                                                                                                                                                                                                                                                                                                  classes?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                                                                  clickToOpen?: boolean;
                                                                                                                                                                                                                                                                                                                                                                  duration?: number;
                                                                                                                                                                                                                                                                                                                                                                  easingIn?: EasingReference;
                                                                                                                                                                                                                                                                                                                                                                  easingOut?: EasingReference;
                                                                                                                                                                                                                                                                                                                                                                  items?: Iterable<{
                                                                                                                                                                                                                                                                                                                                                                      condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                                                                      icon: string | TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                                      svelte: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                                      title?: string;
                                                                                                                                                                                                                                                                                                                                                                  }>;
                                                                                                                                                                                                                                                                                                                                                                  side?: "left" | "right";
                                                                                                                                                                                                                                                                                                                                                                  styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                  top?: string | number;
                                                                                                                                                                                                                                                                                                                                                                  topUnit?: string;
                                                                                                                                                                                                                                                                                                                                                                  zIndex?: number;
                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                              Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                              • Optional allowLocking?: boolean

                                                                                                                                                                                                                                                                                                                                                                Controls whether items can be locked when clickToOpen is false. By default, items can be locked.

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                              • Optional classes?: Iterable<string>

                                                                                                                                                                                                                                                                                                                                                                An iterable list of additional classes to add to the main slide layer element

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                              • Optional clickToOpen?: boolean

                                                                                                                                                                                                                                                                                                                                                                When true items are only opened / closed by click / keyboard interaction.

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                              • Optional duration?: number

                                                                                                                                                                                                                                                                                                                                                                Duration of transition effect.

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                              • Optional easingIn?: EasingReference

                                                                                                                                                                                                                                                                                                                                                                Either the name of a Svelte easing function or a Svelte compatible easing function.

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                              • Optional easingOut?: EasingReference

                                                                                                                                                                                                                                                                                                                                                                Either the name of a Svelte easing function or a Svelte compatible easing function.

                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                              • Optional items?: Iterable<{
                                                                                                                                                                                                                                                                                                                                                                    condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                                                                    icon: string | TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                                    svelte: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                                    title?: string;
                                                                                                                                                                                                                                                                                                                                                                }>

                                                                                                                                                                                                                                                                                                                                                                An iterable list of side slide items including icon (Font awesome string), a Svelte configuration object, and +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                Props: {
                                                                                                                                                                                                                                                                                                                                                                    allowLocking?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    classes?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                                                                    clickToOpen?: boolean;
                                                                                                                                                                                                                                                                                                                                                                    duration?: number;
                                                                                                                                                                                                                                                                                                                                                                    easingIn?: EasingReference;
                                                                                                                                                                                                                                                                                                                                                                    easingOut?: EasingReference;
                                                                                                                                                                                                                                                                                                                                                                    items?: Iterable<{
                                                                                                                                                                                                                                                                                                                                                                        condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                                                                        icon: string | TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                                        svelte: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                                        title?: string;
                                                                                                                                                                                                                                                                                                                                                                    }>;
                                                                                                                                                                                                                                                                                                                                                                    side?: "left" | "right";
                                                                                                                                                                                                                                                                                                                                                                    styles?: Record<string, string>;
                                                                                                                                                                                                                                                                                                                                                                    top?: string | number;
                                                                                                                                                                                                                                                                                                                                                                    topUnit?: string;
                                                                                                                                                                                                                                                                                                                                                                    zIndex?: number;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                • OptionalallowLocking?: boolean

                                                                                                                                                                                                                                                                                                                                                                  Controls whether items can be locked when clickToOpen is false. By default, items can be locked.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • Optionalclasses?: Iterable<string>

                                                                                                                                                                                                                                                                                                                                                                  An iterable list of additional classes to add to the main slide layer element

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • OptionalclickToOpen?: boolean

                                                                                                                                                                                                                                                                                                                                                                  When true items are only opened / closed by click / keyboard interaction.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • Optionalduration?: number

                                                                                                                                                                                                                                                                                                                                                                  Duration of transition effect.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • OptionaleasingIn?: EasingReference

                                                                                                                                                                                                                                                                                                                                                                  Either the name of a Svelte easing function or a Svelte compatible easing function.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • OptionaleasingOut?: EasingReference

                                                                                                                                                                                                                                                                                                                                                                  Either the name of a Svelte easing function or a Svelte compatible easing function.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • Optionalitems?: Iterable<{
                                                                                                                                                                                                                                                                                                                                                                      condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                                                                      icon: string | TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                                      svelte: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                                      title?: string;
                                                                                                                                                                                                                                                                                                                                                                  }>

                                                                                                                                                                                                                                                                                                                                                                  An iterable list of side slide items including icon (Font awesome string), a Svelte configuration object, and title.

                                                                                                                                                                                                                                                                                                                                                                  You may provide a condition boolean or function that returns a boolean to hide the item. This is useful for adding items / panels only visible for the GM amongst other conditional tests.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                • Optional side?: "left" | "right"

                                                                                                                                                                                                                                                                                                                                                                  The side in layers parent element to display.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                • Optional styles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                  Additional inline styles to apply to the side slide layer. Useful for setting CSS variables.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                • Optional top?: string | number

                                                                                                                                                                                                                                                                                                                                                                  A valid CSS value for the top positioning attribute for the top of the side slide layer.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • Optionalside?: "left" | "right"

                                                                                                                                                                                                                                                                                                                                                                  The side in layers parent element to display.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • Optionalstyles?: Record<string, string>

                                                                                                                                                                                                                                                                                                                                                                  Additional inline styles to apply to the side slide layer. Useful for setting CSS variables.

                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                • Optionaltop?: string | number

                                                                                                                                                                                                                                                                                                                                                                  A valid CSS value for the top positioning attribute for the top of the side slide layer.

                                                                                                                                                                                                                                                                                                                                                                  When top is a number it will be treated as pixels unless topUnit is defined.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                • Optional topUnit?: string

                                                                                                                                                                                                                                                                                                                                                                  When top is defined as a number and topUnit is defined then it is used to create the top style. This +

                                                                                                                                                                                                                                                                                                                                                                • OptionaltopUnit?: string

                                                                                                                                                                                                                                                                                                                                                                  When top is defined as a number and topUnit is defined then it is used to create the top style. This facilitates creating a UI for editing side slide layer via a range input and separately storing the unit type.

                                                                                                                                                                                                                                                                                                                                                                  Examples are: px, %, em, rem. Either px or % make the most sense depending on the layout constraints.

                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                • Optional zIndex?: number

                                                                                                                                                                                                                                                                                                                                                                  The z-index for the side slide layer inside the parent element.

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                              • OptionalzIndex?: number

                                                                                                                                                                                                                                                                                                                                                                The z-index for the side slide layer inside the parent element.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSideSlideLayer-1.Slots.html b/docs/types/_standard_component.TJSSideSlideLayer-1.Slots.html index 9def3a49..dde6ecc6 100644 --- a/docs/types/_standard_component.TJSSideSlideLayer-1.Slots.html +++ b/docs/types/_standard_component.TJSSideSlideLayer-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                              Type alias Slots

                                                                                                                                                                                                                                                                                                                                                              Slots: {}

                                                                                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                Slots: {}

                                                                                                                                                                                                                                                                                                                                                                Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSlotButton-1.Events.html b/docs/types/_standard_component.TJSSlotButton-1.Events.html index f8add107..b91e8681 100644 --- a/docs/types/_standard_component.TJSSlotButton-1.Events.html +++ b/docs/types/_standard_component.TJSSlotButton-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                Type alias Events

                                                                                                                                                                                                                                                                                                                                                                Events: {
                                                                                                                                                                                                                                                                                                                                                                    click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                    contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                    press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                } & {
                                                                                                                                                                                                                                                                                                                                                                    [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                Events: {
                                                                                                                                                                                                                                                                                                                                                                    click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                    contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                    press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                } & {
                                                                                                                                                                                                                                                                                                                                                                    [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSlotButton-1.Props.html b/docs/types/_standard_component.TJSSlotButton-1.Props.html index 962b83aa..3b33df96 100644 --- a/docs/types/_standard_component.TJSSlotButton-1.Props.html +++ b/docs/types/_standard_component.TJSSlotButton-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                Type alias Props

                                                                                                                                                                                                                                                                                                                                                                Props: {
                                                                                                                                                                                                                                                                                                                                                                    button?: any;
                                                                                                                                                                                                                                                                                                                                                                    clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                                    disabled?: any;
                                                                                                                                                                                                                                                                                                                                                                    efx?: any;
                                                                                                                                                                                                                                                                                                                                                                    keyCode?: any;
                                                                                                                                                                                                                                                                                                                                                                    onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                                                                    onPress?: any;
                                                                                                                                                                                                                                                                                                                                                                    styles?: any;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                • Optional button?: any
                                                                                                                                                                                                                                                                                                                                                                • Optional clickPropagate?: any
                                                                                                                                                                                                                                                                                                                                                                • Optional disabled?: any
                                                                                                                                                                                                                                                                                                                                                                • Optional efx?: any
                                                                                                                                                                                                                                                                                                                                                                • Optional keyCode?: any
                                                                                                                                                                                                                                                                                                                                                                • Optional onContextMenu?: any
                                                                                                                                                                                                                                                                                                                                                                • Optional onPress?: any
                                                                                                                                                                                                                                                                                                                                                                • Optional styles?: any

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                Props: {
                                                                                                                                                                                                                                                                                                                                                                    button?: any;
                                                                                                                                                                                                                                                                                                                                                                    clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                                    disabled?: any;
                                                                                                                                                                                                                                                                                                                                                                    efx?: any;
                                                                                                                                                                                                                                                                                                                                                                    keyCode?: any;
                                                                                                                                                                                                                                                                                                                                                                    onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                                                                    onPress?: any;
                                                                                                                                                                                                                                                                                                                                                                    styles?: any;
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSlotButton-1.Slots.html b/docs/types/_standard_component.TJSSlotButton-1.Slots.html index 4c898796..caf03edd 100644 --- a/docs/types/_standard_component.TJSSlotButton-1.Slots.html +++ b/docs/types/_standard_component.TJSSlotButton-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                Slots: {
                                                                                                                                                                                                                                                                                                                                                                    default: {};
                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                • default: {}

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                  Slots: {
                                                                                                                                                                                                                                                                                                                                                                      default: {};
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSlotLabel-1.Events.html b/docs/types/_standard_component.TJSSlotLabel-1.Events.html index f47c968d..c19a6310 100644 --- a/docs/types/_standard_component.TJSSlotLabel-1.Events.html +++ b/docs/types/_standard_component.TJSSlotLabel-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                  Type alias Events

                                                                                                                                                                                                                                                                                                                                                                  Events: {
                                                                                                                                                                                                                                                                                                                                                                      [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                  Events: {
                                                                                                                                                                                                                                                                                                                                                                      [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSlotLabel-1.Props.html b/docs/types/_standard_component.TJSSlotLabel-1.Props.html index b7a0f508..50ff2484 100644 --- a/docs/types/_standard_component.TJSSlotLabel-1.Props.html +++ b/docs/types/_standard_component.TJSSlotLabel-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                  Type alias Props

                                                                                                                                                                                                                                                                                                                                                                  Props: {
                                                                                                                                                                                                                                                                                                                                                                      disabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      label?: any;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  • Optional disabled?: boolean
                                                                                                                                                                                                                                                                                                                                                                  • Optional label?: any

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                                                                                  Theme

                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                  Props: {
                                                                                                                                                                                                                                                                                                                                                                      disabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                                      label?: any;
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSlotLabel-1.Slots.html b/docs/types/_standard_component.TJSSlotLabel-1.Slots.html index 87b1decd..bd07e16c 100644 --- a/docs/types/_standard_component.TJSSlotLabel-1.Slots.html +++ b/docs/types/_standard_component.TJSSlotLabel-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                  Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                  Slots: {
                                                                                                                                                                                                                                                                                                                                                                      default: {};
                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                  Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                  Type declaration

                                                                                                                                                                                                                                                                                                                                                                  • default: {}

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                    Slots: {
                                                                                                                                                                                                                                                                                                                                                                        default: {};
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSvgFolder-1.Events.html b/docs/types/_standard_component.TJSSvgFolder-1.Events.html index 76f56b4e..304a91ba 100644 --- a/docs/types/_standard_component.TJSSvgFolder-1.Events.html +++ b/docs/types/_standard_component.TJSSvgFolder-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                    Type alias Events

                                                                                                                                                                                                                                                                                                                                                                    Events: {
                                                                                                                                                                                                                                                                                                                                                                        click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                        close: Event;
                                                                                                                                                                                                                                                                                                                                                                        closeAny: KeyboardEvent | UIEvent | Event | PointerEvent | MouseEvent | ErrorEvent | AnimationEvent | ClipboardEvent | CompositionEvent | DragEvent | FocusEvent | FormDataEvent | InputEvent | ProgressEvent<EventTarget> | SecurityPolicyViolationEvent | SubmitEvent | TouchEvent | TransitionEvent | WheelEvent;
                                                                                                                                                                                                                                                                                                                                                                        keydown: KeyboardEvent;
                                                                                                                                                                                                                                                                                                                                                                        keyup: KeyboardEvent;
                                                                                                                                                                                                                                                                                                                                                                        open: KeyboardEvent | UIEvent | Event | PointerEvent | MouseEvent | ErrorEvent | AnimationEvent | ClipboardEvent | CompositionEvent | DragEvent | FocusEvent | FormDataEvent | InputEvent | ProgressEvent<EventTarget> | SecurityPolicyViolationEvent | SubmitEvent | TouchEvent | TransitionEvent | WheelEvent;
                                                                                                                                                                                                                                                                                                                                                                        openAny: KeyboardEvent | UIEvent | Event | PointerEvent | MouseEvent | ErrorEvent | AnimationEvent | ClipboardEvent | CompositionEvent | DragEvent | FocusEvent | FormDataEvent | InputEvent | ProgressEvent<EventTarget> | SecurityPolicyViolationEvent | SubmitEvent | TouchEvent | TransitionEvent | WheelEvent;
                                                                                                                                                                                                                                                                                                                                                                    } & {
                                                                                                                                                                                                                                                                                                                                                                        [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                    Events: {
                                                                                                                                                                                                                                                                                                                                                                        click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                        close: Event;
                                                                                                                                                                                                                                                                                                                                                                        closeAny:
                                                                                                                                                                                                                                                                                                                                                                            | KeyboardEvent
                                                                                                                                                                                                                                                                                                                                                                            | UIEvent
                                                                                                                                                                                                                                                                                                                                                                            | Event
                                                                                                                                                                                                                                                                                                                                                                            | PointerEvent
                                                                                                                                                                                                                                                                                                                                                                            | MouseEvent
                                                                                                                                                                                                                                                                                                                                                                            | ErrorEvent
                                                                                                                                                                                                                                                                                                                                                                            | AnimationEvent
                                                                                                                                                                                                                                                                                                                                                                            | ClipboardEvent
                                                                                                                                                                                                                                                                                                                                                                            | CompositionEvent
                                                                                                                                                                                                                                                                                                                                                                            | DragEvent
                                                                                                                                                                                                                                                                                                                                                                            | FocusEvent
                                                                                                                                                                                                                                                                                                                                                                            | FormDataEvent
                                                                                                                                                                                                                                                                                                                                                                            | InputEvent
                                                                                                                                                                                                                                                                                                                                                                            | ProgressEvent<EventTarget>
                                                                                                                                                                                                                                                                                                                                                                            | SecurityPolicyViolationEvent
                                                                                                                                                                                                                                                                                                                                                                            | SubmitEvent
                                                                                                                                                                                                                                                                                                                                                                            | TouchEvent
                                                                                                                                                                                                                                                                                                                                                                            | TransitionEvent
                                                                                                                                                                                                                                                                                                                                                                            | WheelEvent;
                                                                                                                                                                                                                                                                                                                                                                        keydown: KeyboardEvent;
                                                                                                                                                                                                                                                                                                                                                                        keyup: KeyboardEvent;
                                                                                                                                                                                                                                                                                                                                                                        open:
                                                                                                                                                                                                                                                                                                                                                                            | KeyboardEvent
                                                                                                                                                                                                                                                                                                                                                                            | UIEvent
                                                                                                                                                                                                                                                                                                                                                                            | Event
                                                                                                                                                                                                                                                                                                                                                                            | PointerEvent
                                                                                                                                                                                                                                                                                                                                                                            | MouseEvent
                                                                                                                                                                                                                                                                                                                                                                            | ErrorEvent
                                                                                                                                                                                                                                                                                                                                                                            | AnimationEvent
                                                                                                                                                                                                                                                                                                                                                                            | ClipboardEvent
                                                                                                                                                                                                                                                                                                                                                                            | CompositionEvent
                                                                                                                                                                                                                                                                                                                                                                            | DragEvent
                                                                                                                                                                                                                                                                                                                                                                            | FocusEvent
                                                                                                                                                                                                                                                                                                                                                                            | FormDataEvent
                                                                                                                                                                                                                                                                                                                                                                            | InputEvent
                                                                                                                                                                                                                                                                                                                                                                            | ProgressEvent<EventTarget>
                                                                                                                                                                                                                                                                                                                                                                            | SecurityPolicyViolationEvent
                                                                                                                                                                                                                                                                                                                                                                            | SubmitEvent
                                                                                                                                                                                                                                                                                                                                                                            | TouchEvent
                                                                                                                                                                                                                                                                                                                                                                            | TransitionEvent
                                                                                                                                                                                                                                                                                                                                                                            | WheelEvent;
                                                                                                                                                                                                                                                                                                                                                                        openAny:
                                                                                                                                                                                                                                                                                                                                                                            | KeyboardEvent
                                                                                                                                                                                                                                                                                                                                                                            | UIEvent
                                                                                                                                                                                                                                                                                                                                                                            | Event
                                                                                                                                                                                                                                                                                                                                                                            | PointerEvent
                                                                                                                                                                                                                                                                                                                                                                            | MouseEvent
                                                                                                                                                                                                                                                                                                                                                                            | ErrorEvent
                                                                                                                                                                                                                                                                                                                                                                            | AnimationEvent
                                                                                                                                                                                                                                                                                                                                                                            | ClipboardEvent
                                                                                                                                                                                                                                                                                                                                                                            | CompositionEvent
                                                                                                                                                                                                                                                                                                                                                                            | DragEvent
                                                                                                                                                                                                                                                                                                                                                                            | FocusEvent
                                                                                                                                                                                                                                                                                                                                                                            | FormDataEvent
                                                                                                                                                                                                                                                                                                                                                                            | InputEvent
                                                                                                                                                                                                                                                                                                                                                                            | ProgressEvent<EventTarget>
                                                                                                                                                                                                                                                                                                                                                                            | SecurityPolicyViolationEvent
                                                                                                                                                                                                                                                                                                                                                                            | SubmitEvent
                                                                                                                                                                                                                                                                                                                                                                            | TouchEvent
                                                                                                                                                                                                                                                                                                                                                                            | TransitionEvent
                                                                                                                                                                                                                                                                                                                                                                            | WheelEvent;
                                                                                                                                                                                                                                                                                                                                                                    } & {
                                                                                                                                                                                                                                                                                                                                                                        [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSvgFolder-1.Props.html b/docs/types/_standard_component.TJSSvgFolder-1.Props.html index ed90ee8a..c14ea727 100644 --- a/docs/types/_standard_component.TJSSvgFolder-1.Props.html +++ b/docs/types/_standard_component.TJSSvgFolder-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                    Type alias Props

                                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                                        animate?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        folder?: TJSFolderData;
                                                                                                                                                                                                                                                                                                                                                                        id?: string;
                                                                                                                                                                                                                                                                                                                                                                        keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                                        label?: string;
                                                                                                                                                                                                                                                                                                                                                                        onClose?: ((data?) => void);
                                                                                                                                                                                                                                                                                                                                                                        onContextMenu?: ((data?) => void);
                                                                                                                                                                                                                                                                                                                                                                        onOpen?: ((data?) => void);
                                                                                                                                                                                                                                                                                                                                                                        options?: TJSFolderOptions;
                                                                                                                                                                                                                                                                                                                                                                        store?: Writable<boolean>;
                                                                                                                                                                                                                                                                                                                                                                        styles?: object;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                                                    Theme

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                                        animate?: boolean;
                                                                                                                                                                                                                                                                                                                                                                        folder?: TJSFolderData;
                                                                                                                                                                                                                                                                                                                                                                        id?: string;
                                                                                                                                                                                                                                                                                                                                                                        keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                                        label?: string;
                                                                                                                                                                                                                                                                                                                                                                        onClose?: ((data?: {
                                                                                                                                                                                                                                                                                                                                                                            event?: KeyboardEvent | PointerEvent;
                                                                                                                                                                                                                                                                                                                                                                        }) => void);
                                                                                                                                                                                                                                                                                                                                                                        onContextMenu?: ((data?: {
                                                                                                                                                                                                                                                                                                                                                                            event?: PointerEvent;
                                                                                                                                                                                                                                                                                                                                                                        }) => void);
                                                                                                                                                                                                                                                                                                                                                                        onOpen?: ((data?: {
                                                                                                                                                                                                                                                                                                                                                                            event?: KeyboardEvent | PointerEvent;
                                                                                                                                                                                                                                                                                                                                                                        }) => void);
                                                                                                                                                                                                                                                                                                                                                                        options?: TJSFolderOptions;
                                                                                                                                                                                                                                                                                                                                                                        store?: Writable<boolean>;
                                                                                                                                                                                                                                                                                                                                                                        styles?: object;
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component.TJSSvgFolder-1.Slots.html b/docs/types/_standard_component.TJSSvgFolder-1.Slots.html index f5b1e342..be669d9b 100644 --- a/docs/types/_standard_component.TJSSvgFolder-1.Slots.html +++ b/docs/types/_standard_component.TJSSvgFolder-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                    Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                    Slots: {
                                                                                                                                                                                                                                                                                                                                                                        default: {};
                                                                                                                                                                                                                                                                                                                                                                        label: {};
                                                                                                                                                                                                                                                                                                                                                                        summary-end: {};
                                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                                    Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                                    • default: {}
                                                                                                                                                                                                                                                                                                                                                                      • label: {}
                                                                                                                                                                                                                                                                                                                                                                        • summary-end: {}

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                          Slots: {
                                                                                                                                                                                                                                                                                                                                                                              default: {};
                                                                                                                                                                                                                                                                                                                                                                              label: {};
                                                                                                                                                                                                                                                                                                                                                                              summary-end: {};
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSTinyMCE-1.Events.html b/docs/types/_standard_component.TJSTinyMCE-1.Events.html index 69a0571b..ce41ddb0 100644 --- a/docs/types/_standard_component.TJSTinyMCE-1.Events.html +++ b/docs/types/_standard_component.TJSTinyMCE-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                          Type alias Events

                                                                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                                                                              editor:cancel: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              editor:document:deleted: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              editor:enrichedContent: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              editor:save: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              editor:start: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                                                                              editor:cancel: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              editor:document:deleted: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              editor:enrichedContent: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              editor:save: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              editor:start: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSTinyMCE-1.Props.html b/docs/types/_standard_component.TJSTinyMCE-1.Props.html index b67d5454..81afb82a 100644 --- a/docs/types/_standard_component.TJSTinyMCE-1.Props.html +++ b/docs/types/_standard_component.TJSTinyMCE-1.Props.html @@ -1,3 +1,4 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                          Type alias Props

                                                                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                                                                              content?: string;
                                                                                                                                                                                                                                                                                                                                                                              enrichedContent?: string;
                                                                                                                                                                                                                                                                                                                                                                              options?: TJSTinyMCEOptions;
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                          • Optional content?: string
                                                                                                                                                                                                                                                                                                                                                                          • Optional enrichedContent?: string
                                                                                                                                                                                                                                                                                                                                                                          • Optional options?: TJSTinyMCEOptions

                                                                                                                                                                                                                                                                                                                                                                            Provides the options object that can be reactively updated. See documentation above.

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                                                                              content?: string;
                                                                                                                                                                                                                                                                                                                                                                              enrichedContent?: string;
                                                                                                                                                                                                                                                                                                                                                                              options?: TJSTinyMCEOptions;
                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                          • Optionalcontent?: string
                                                                                                                                                                                                                                                                                                                                                                          • OptionalenrichedContent?: string
                                                                                                                                                                                                                                                                                                                                                                          • Optionaloptions?: TJSTinyMCEOptions

                                                                                                                                                                                                                                                                                                                                                                            Provides the options object that can be reactively updated. See documentation above.

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component.TJSTinyMCE-1.Slots.html b/docs/types/_standard_component.TJSTinyMCE-1.Slots.html index 153d69d5..932032e2 100644 --- a/docs/types/_standard_component.TJSTinyMCE-1.Slots.html +++ b/docs/types/_standard_component.TJSTinyMCE-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                          Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                          Slots: {}

                                                                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                            Slots: {}

                                                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSTinyMCEOptions.html b/docs/types/_standard_component.TJSTinyMCEOptions.html index 7423f2f4..626621a1 100644 --- a/docs/types/_standard_component.TJSTinyMCEOptions.html +++ b/docs/types/_standard_component.TJSTinyMCEOptions.html @@ -1,37 +1,38 @@ -TJSTinyMCEOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                            Type alias TJSTinyMCEOptions

                                                                                                                                                                                                                                                                                                                                                                            TJSTinyMCEOptions: {
                                                                                                                                                                                                                                                                                                                                                                                DOMPurify?: {
                                                                                                                                                                                                                                                                                                                                                                                    sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                                button?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                classes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                clickToEdit?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                document?: foundry.abstract.Document;
                                                                                                                                                                                                                                                                                                                                                                                editable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                enrichContent?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                enrichOptions?: globalThis.EnrichmentOptions;
                                                                                                                                                                                                                                                                                                                                                                                fieldName?: string;
                                                                                                                                                                                                                                                                                                                                                                                fonts?: any;
                                                                                                                                                                                                                                                                                                                                                                                initialSelection?: "all" | "end" | "start";
                                                                                                                                                                                                                                                                                                                                                                                keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                                                maxCharacterLength?: number;
                                                                                                                                                                                                                                                                                                                                                                                mceConfig?: object;
                                                                                                                                                                                                                                                                                                                                                                                preventEnterKey?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                preventPaste?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                saveOnBlur?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                saveOnEnterKey?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                styles?: {
                                                                                                                                                                                                                                                                                                                                                                                    [x: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                            • Optional DOMPurify?: {
                                                                                                                                                                                                                                                                                                                                                                                  sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              The DOMPurify export from -@typhonjs-fvtt/runtime/security/client/dompurify. Sanitizes content client side. Note: TinyMCE already does essential -<script> sanitization, so this is just an extra option that is available as an extra precaution.

                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                            • Optional button?: boolean

                                                                                                                                                                                                                                                                                                                                                                              Provides an edit button to start editing. When button is false editing is +TJSTinyMCEOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Type Alias TJSTinyMCEOptions

                                                                                                                                                                                                                                                                                                                                                                              TJSTinyMCEOptions: {
                                                                                                                                                                                                                                                                                                                                                                                  button?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  classes?: string[];
                                                                                                                                                                                                                                                                                                                                                                                  clickToEdit?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  document?: foundry.abstract.Document;
                                                                                                                                                                                                                                                                                                                                                                                  DOMPurify?: {
                                                                                                                                                                                                                                                                                                                                                                                      sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                                  editable?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  enrichContent?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  enrichOptions?: globalThis.EnrichmentOptions;
                                                                                                                                                                                                                                                                                                                                                                                  fieldName?: string;
                                                                                                                                                                                                                                                                                                                                                                                  fonts?: any;
                                                                                                                                                                                                                                                                                                                                                                                  initialSelection?: "all" | "end" | "start";
                                                                                                                                                                                                                                                                                                                                                                                  keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                                                  maxCharacterLength?: number;
                                                                                                                                                                                                                                                                                                                                                                                  mceConfig?: object;
                                                                                                                                                                                                                                                                                                                                                                                  preventEnterKey?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  preventPaste?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  saveOnBlur?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  saveOnEnterKey?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                  styles?: {
                                                                                                                                                                                                                                                                                                                                                                                      [x: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                  };
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                              • Optionalbutton?: boolean

                                                                                                                                                                                                                                                                                                                                                                                Provides an edit button to start editing. When button is false editing is always enabled.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional classes?: string[]

                                                                                                                                                                                                                                                                                                                                                                                An array of strings to add to the .editor element classes. This allows easier +

                                                                                                                                                                                                                                                                                                                                                                              • Optionalclasses?: string[]

                                                                                                                                                                                                                                                                                                                                                                                An array of strings to add to the .editor element classes. This allows easier setting of CSS variables across a range of various editor components.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional clickToEdit?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When true the edit button is not shown and a click on the editor +

                                                                                                                                                                                                                                                                                                                                                                              • OptionalclickToEdit?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When true the edit button is not shown and a click on the editor content initializes the editor.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional document?: foundry.abstract.Document

                                                                                                                                                                                                                                                                                                                                                                                Set to a Foundry document to load and save content from it. +

                                                                                                                                                                                                                                                                                                                                                                              • Optionaldocument?: foundry.abstract.Document

                                                                                                                                                                                                                                                                                                                                                                                Set to a Foundry document to load and save content from it. Requires fieldName to be set.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional editable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                Prevents editing and hides button. When set to false any active editor +

                                                                                                                                                                                                                                                                                                                                                                              • OptionalDOMPurify?: {
                                                                                                                                                                                                                                                                                                                                                                                    sanitizeWithVideo: Function;
                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                The DOMPurify export from +@typhonjs-fvtt/runtime/security/client/dompurify. Sanitizes content client side. Note: TinyMCE already does essential +<script> sanitization, so this is just an extra option that is available as an extra precaution.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • Optionaleditable?: boolean

                                                                                                                                                                                                                                                                                                                                                                                Prevents editing and hides button. When set to false any active editor is cancelled. Default: user is GM or when a document is assigned the user has ownership.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional enrichContent?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When set to false content won't be enriched by TextEditor.enrichHTML.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional enrichOptions?: globalThis.EnrichmentOptions

                                                                                                                                                                                                                                                                                                                                                                                Additional TextEditor.enrichHTML options.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional fieldName?: string

                                                                                                                                                                                                                                                                                                                                                                                A field name to load and save to / from associated document. IE a.b.c.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional fonts?: any

                                                                                                                                                                                                                                                                                                                                                                                An additional object defining module / custom fonts to load +

                                                                                                                                                                                                                                                                                                                                                                              • OptionalenrichContent?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When set to false content won't be enriched by TextEditor.enrichHTML.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • OptionalenrichOptions?: globalThis.EnrichmentOptions

                                                                                                                                                                                                                                                                                                                                                                                Additional TextEditor.enrichHTML options.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • OptionalfieldName?: string

                                                                                                                                                                                                                                                                                                                                                                                A field name to load and save to / from associated document. IE a.b.c.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • Optionalfonts?: any

                                                                                                                                                                                                                                                                                                                                                                                An additional object defining module / custom fonts to load specific to this editor.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional initialSelection?: "all" | "end" | "start"

                                                                                                                                                                                                                                                                                                                                                                                Initial selection range; 'all', 'end' or 'start'.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional keyCode?: string

                                                                                                                                                                                                                                                                                                                                                                                Defines the key event code to activate the editor when focused.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional maxCharacterLength?: number

                                                                                                                                                                                                                                                                                                                                                                                When defined as an integer greater than 0 this limits the max +

                                                                                                                                                                                                                                                                                                                                                                              • OptionalinitialSelection?: "all" | "end" | "start"

                                                                                                                                                                                                                                                                                                                                                                                Initial selection range; 'all', 'end' or 'start'.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • OptionalkeyCode?: string

                                                                                                                                                                                                                                                                                                                                                                                Defines the key event code to activate the editor when focused.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • OptionalmaxCharacterLength?: number

                                                                                                                                                                                                                                                                                                                                                                                When defined as an integer greater than 0 this limits the max characters that can be entered.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional mceConfig?: object

                                                                                                                                                                                                                                                                                                                                                                                User defined TinyMCE config object. Please see TinyMCE documentation and also +

                                                                                                                                                                                                                                                                                                                                                                              • OptionalmceConfig?: object

                                                                                                                                                                                                                                                                                                                                                                                User defined TinyMCE config object. Please see TinyMCE documentation and also take into consideration that there are differences between Foundry v9 (TinyMCE v5) and Foundry v10+ (TinyMCE v6). Note: There are several pre-made configurations available in TinyMCEHelper. If not defined TinyMCEHelper.configStandard is used.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional preventEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When true this prevents enter key from creating a new line / +

                                                                                                                                                                                                                                                                                                                                                                              • OptionalpreventEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When true this prevents enter key from creating a new line / paragraph.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional preventPaste?: boolean

                                                                                                                                                                                                                                                                                                                                                                                Prevents pasting content into the editor.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional saveOnBlur?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When true any loss of focus / blur from the editor saves the editor +

                                                                                                                                                                                                                                                                                                                                                                              • OptionalpreventPaste?: boolean

                                                                                                                                                                                                                                                                                                                                                                                Prevents pasting content into the editor.

                                                                                                                                                                                                                                                                                                                                                                                +
                                                                                                                                                                                                                                                                                                                                                                              • OptionalsaveOnBlur?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When true any loss of focus / blur from the editor saves the editor state.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional saveOnEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When true saves the editor state when the enter key is pressed. +

                                                                                                                                                                                                                                                                                                                                                                              • OptionalsaveOnEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                                                                When true saves the editor state when the enter key is pressed. This is useful when configuring the editor for single line entry. For an automatic setup for single line entry refer to TinyMCEHelper.optionsSingleLine.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                              • Optional styles?: {
                                                                                                                                                                                                                                                                                                                                                                                    [x: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                Additional CSS property names and values to set as inline styles. +

                                                                                                                                                                                                                                                                                                                                                                              • Optionalstyles?: {
                                                                                                                                                                                                                                                                                                                                                                                    [x: string]: string;
                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                Additional CSS property names and values to set as inline styles. This is useful for dynamically overriding any built in styles and in particular setting CSS variables supported.

                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                • [x: string]: string

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                              • [x: string]: string

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSToggleIconButton-1.Events.html b/docs/types/_standard_component.TJSToggleIconButton-1.Events.html index 46a07b8a..d3199f40 100644 --- a/docs/types/_standard_component.TJSToggleIconButton-1.Events.html +++ b/docs/types/_standard_component.TJSToggleIconButton-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                            Type alias Events

                                                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                                                click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                                contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                                press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                            } & {
                                                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                                                click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                                contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                                press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                            } & {
                                                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSToggleIconButton-1.Props.html b/docs/types/_standard_component.TJSToggleIconButton-1.Props.html index 4a8741c5..4be683f7 100644 --- a/docs/types/_standard_component.TJSToggleIconButton-1.Props.html +++ b/docs/types/_standard_component.TJSToggleIconButton-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                            Type alias Props

                                                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                                                button?: any;
                                                                                                                                                                                                                                                                                                                                                                                clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                                                disabled?: any;
                                                                                                                                                                                                                                                                                                                                                                                efx?: any;
                                                                                                                                                                                                                                                                                                                                                                                icon?: any;
                                                                                                                                                                                                                                                                                                                                                                                keyCode?: any;
                                                                                                                                                                                                                                                                                                                                                                                onClose?: any;
                                                                                                                                                                                                                                                                                                                                                                                onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                                                                                onPress?: any;
                                                                                                                                                                                                                                                                                                                                                                                store?: any;
                                                                                                                                                                                                                                                                                                                                                                                styles?: any;
                                                                                                                                                                                                                                                                                                                                                                                title?: any;
                                                                                                                                                                                                                                                                                                                                                                                titleSelected?: any;
                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                            • Optional button?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional clickPropagate?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional disabled?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional efx?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional icon?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional keyCode?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional onClose?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional onContextMenu?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional onPress?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional store?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional styles?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional title?: any
                                                                                                                                                                                                                                                                                                                                                                            • Optional titleSelected?: any

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                                                button?: any;
                                                                                                                                                                                                                                                                                                                                                                                clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                                                disabled?: any;
                                                                                                                                                                                                                                                                                                                                                                                efx?: any;
                                                                                                                                                                                                                                                                                                                                                                                icon?: any;
                                                                                                                                                                                                                                                                                                                                                                                keyCode?: any;
                                                                                                                                                                                                                                                                                                                                                                                onClose?: any;
                                                                                                                                                                                                                                                                                                                                                                                onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                                                                                onPress?: any;
                                                                                                                                                                                                                                                                                                                                                                                store?: any;
                                                                                                                                                                                                                                                                                                                                                                                styles?: any;
                                                                                                                                                                                                                                                                                                                                                                                title?: any;
                                                                                                                                                                                                                                                                                                                                                                                titleSelected?: any;
                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component.TJSToggleIconButton-1.Slots.html b/docs/types/_standard_component.TJSToggleIconButton-1.Slots.html index b3204237..2deb356f 100644 --- a/docs/types/_standard_component.TJSToggleIconButton-1.Slots.html +++ b/docs/types/_standard_component.TJSToggleIconButton-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                            Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                            Slots: {
                                                                                                                                                                                                                                                                                                                                                                                default: {};
                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                            • default: {}

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                              Slots: {
                                                                                                                                                                                                                                                                                                                                                                                  default: {};
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSToggleLabel-1.Events.html b/docs/types/_standard_component.TJSToggleLabel-1.Events.html index e2073583..4ed083f1 100644 --- a/docs/types/_standard_component.TJSToggleLabel-1.Events.html +++ b/docs/types/_standard_component.TJSToggleLabel-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                              Type alias Events

                                                                                                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                                                                                                  click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                                  contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                                  pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                                                                  press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              } & {
                                                                                                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                              Events: {
                                                                                                                                                                                                                                                                                                                                                                                  click: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                                  contextmenu: MouseEvent;
                                                                                                                                                                                                                                                                                                                                                                                  pointerdown: PointerEvent;
                                                                                                                                                                                                                                                                                                                                                                                  press: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              } & {
                                                                                                                                                                                                                                                                                                                                                                                  [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSToggleLabel-1.Props.html b/docs/types/_standard_component.TJSToggleLabel-1.Props.html index 589fd3ab..455bd169 100644 --- a/docs/types/_standard_component.TJSToggleLabel-1.Props.html +++ b/docs/types/_standard_component.TJSToggleLabel-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                              Type alias Props

                                                                                                                                                                                                                                                                                                                                                                              Props: {
                                                                                                                                                                                                                                                                                                                                                                                  clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                                                  comp?: any;
                                                                                                                                                                                                                                                                                                                                                                                  disabled?: any;
                                                                                                                                                                                                                                                                                                                                                                                  efx?: any;
                                                                                                                                                                                                                                                                                                                                                                                  keyCode?: any;
                                                                                                                                                                                                                                                                                                                                                                                  label?: any;
                                                                                                                                                                                                                                                                                                                                                                                  onClose?: any;
                                                                                                                                                                                                                                                                                                                                                                                  onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                                                                                  onPress?: any;
                                                                                                                                                                                                                                                                                                                                                                                  store?: any;
                                                                                                                                                                                                                                                                                                                                                                                  styles?: any;
                                                                                                                                                                                                                                                                                                                                                                                  text?: any;
                                                                                                                                                                                                                                                                                                                                                                                  title?: any;
                                                                                                                                                                                                                                                                                                                                                                                  titleSelected?: any;
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                              • Optional clickPropagate?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional comp?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional disabled?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional efx?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional keyCode?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional label?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional onClose?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional onContextMenu?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional onPress?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional store?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional styles?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional text?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional title?: any
                                                                                                                                                                                                                                                                                                                                                                              • Optional titleSelected?: any

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                              Props: {
                                                                                                                                                                                                                                                                                                                                                                                  clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                                                  comp?: any;
                                                                                                                                                                                                                                                                                                                                                                                  disabled?: any;
                                                                                                                                                                                                                                                                                                                                                                                  efx?: any;
                                                                                                                                                                                                                                                                                                                                                                                  keyCode?: any;
                                                                                                                                                                                                                                                                                                                                                                                  label?: any;
                                                                                                                                                                                                                                                                                                                                                                                  onClose?: any;
                                                                                                                                                                                                                                                                                                                                                                                  onContextMenu?: any;
                                                                                                                                                                                                                                                                                                                                                                                  onPress?: any;
                                                                                                                                                                                                                                                                                                                                                                                  store?: any;
                                                                                                                                                                                                                                                                                                                                                                                  styles?: any;
                                                                                                                                                                                                                                                                                                                                                                                  text?: any;
                                                                                                                                                                                                                                                                                                                                                                                  title?: any;
                                                                                                                                                                                                                                                                                                                                                                                  titleSelected?: any;
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_component.TJSToggleLabel-1.Slots.html b/docs/types/_standard_component.TJSToggleLabel-1.Slots.html index 42f8ffce..4f348e9e 100644 --- a/docs/types/_standard_component.TJSToggleLabel-1.Slots.html +++ b/docs/types/_standard_component.TJSToggleLabel-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                              Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                              Slots: {
                                                                                                                                                                                                                                                                                                                                                                                  default: {};
                                                                                                                                                                                                                                                                                                                                                                                  left: {};
                                                                                                                                                                                                                                                                                                                                                                                  outer: {};
                                                                                                                                                                                                                                                                                                                                                                                  right: {};
                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                              • default: {}
                                                                                                                                                                                                                                                                                                                                                                                • left: {}
                                                                                                                                                                                                                                                                                                                                                                                  • outer: {}
                                                                                                                                                                                                                                                                                                                                                                                    • right: {}

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                                      Slots: {
                                                                                                                                                                                                                                                                                                                                                                                          default: {};
                                                                                                                                                                                                                                                                                                                                                                                          left: {};
                                                                                                                                                                                                                                                                                                                                                                                          outer: {};
                                                                                                                                                                                                                                                                                                                                                                                          right: {};
                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                      Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSFileButton-1.Events.html b/docs/types/_standard_component_fvtt.TJSFileButton-1.Events.html index 25746ab2..3db09adc 100644 --- a/docs/types/_standard_component_fvtt.TJSFileButton-1.Events.html +++ b/docs/types/_standard_component_fvtt.TJSFileButton-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                      Type alias Events

                                                                                                                                                                                                                                                                                                                                                                                      Events: {
                                                                                                                                                                                                                                                                                                                                                                                          filepath: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                                                                                          [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                      Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                                      Events: {
                                                                                                                                                                                                                                                                                                                                                                                          filepath: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                      } & {
                                                                                                                                                                                                                                                                                                                                                                                          [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                      Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSFileButton-1.Props.html b/docs/types/_standard_component_fvtt.TJSFileButton-1.Props.html index b1ea1167..83d094ba 100644 --- a/docs/types/_standard_component_fvtt.TJSFileButton-1.Props.html +++ b/docs/types/_standard_component_fvtt.TJSFileButton-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                      Type alias Props

                                                                                                                                                                                                                                                                                                                                                                                      Props: {
                                                                                                                                                                                                                                                                                                                                                                                          button?: any;
                                                                                                                                                                                                                                                                                                                                                                                          filepath?: string;
                                                                                                                                                                                                                                                                                                                                                                                          pickerOptions?: FVTTFilePickerBrowseOptions;
                                                                                                                                                                                                                                                                                                                                                                                          [x: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                      Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                      Theme

                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                                      Props: {
                                                                                                                                                                                                                                                                                                                                                                                          button?: any;
                                                                                                                                                                                                                                                                                                                                                                                          filepath?: string;
                                                                                                                                                                                                                                                                                                                                                                                          pickerOptions?: FVTTFilePickerBrowseOptions;
                                                                                                                                                                                                                                                                                                                                                                                          [x: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                                                      Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSFileButton-1.Slots.html b/docs/types/_standard_component_fvtt.TJSFileButton-1.Slots.html index c9b355ed..75bafc5e 100644 --- a/docs/types/_standard_component_fvtt.TJSFileButton-1.Slots.html +++ b/docs/types/_standard_component_fvtt.TJSFileButton-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                      Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                                      Slots: {}

                                                                                                                                                                                                                                                                                                                                                                                      Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                                        Slots: {}

                                                                                                                                                                                                                                                                                                                                                                                        Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Events.html b/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Events.html index 7972d4e5..13165402 100644 --- a/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Events.html +++ b/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                        Type alias Events

                                                                                                                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                                                                                                                            filepath: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                        } & {
                                                                                                                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                                        Events: {
                                                                                                                                                                                                                                                                                                                                                                                            filepath: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                        } & {
                                                                                                                                                                                                                                                                                                                                                                                            [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                        Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Props.html b/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Props.html index 9c35d88f..f4fe8e4b 100644 --- a/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Props.html +++ b/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                        Type alias Props

                                                                                                                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                                                                                                                            button?: any;
                                                                                                                                                                                                                                                                                                                                                                                            filepath?: string;
                                                                                                                                                                                                                                                                                                                                                                                            pickerOptions?: any;
                                                                                                                                                                                                                                                                                                                                                                                            [x: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                        • [x: string]: any
                                                                                                                                                                                                                                                                                                                                                                                        • Optional button?: any
                                                                                                                                                                                                                                                                                                                                                                                        • Optional filepath?: string
                                                                                                                                                                                                                                                                                                                                                                                        • Optional pickerOptions?: any

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                        Theme

                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                                        Props: {
                                                                                                                                                                                                                                                                                                                                                                                            button?: any;
                                                                                                                                                                                                                                                                                                                                                                                            filepath?: string;
                                                                                                                                                                                                                                                                                                                                                                                            pickerOptions?: any;
                                                                                                                                                                                                                                                                                                                                                                                            [x: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                                                        Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Slots.html b/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Slots.html index 84a6aeb8..8ff7ac81 100644 --- a/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Slots.html +++ b/docs/types/_standard_component_fvtt.TJSFileIconButton-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                        Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                                        Slots: {}

                                                                                                                                                                                                                                                                                                                                                                                        Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                                                        Type declaration

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                                          Slots: {}

                                                                                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Events.html b/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Events.html index f100f1c9..50d266f2 100644 --- a/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Events.html +++ b/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                          Type alias Events

                                                                                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                                                                                              filepath: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                                          Events: {
                                                                                                                                                                                                                                                                                                                                                                                              filepath: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                          } & {
                                                                                                                                                                                                                                                                                                                                                                                              [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                          Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Props.html b/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Props.html index 7bc01efa..387c0dc3 100644 --- a/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Props.html +++ b/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Props.html @@ -1,2 +1,3 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                          Type alias Props

                                                                                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                                                                                              button?: any;
                                                                                                                                                                                                                                                                                                                                                                                              filepath?: string;
                                                                                                                                                                                                                                                                                                                                                                                              pickerOptions?: FVTTFilePickerBrowseOptions;
                                                                                                                                                                                                                                                                                                                                                                                              [x: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                          Theme

                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                                          Props: {
                                                                                                                                                                                                                                                                                                                                                                                              button?: any;
                                                                                                                                                                                                                                                                                                                                                                                              filepath?: string;
                                                                                                                                                                                                                                                                                                                                                                                              pickerOptions?: FVTTFilePickerBrowseOptions;
                                                                                                                                                                                                                                                                                                                                                                                              [x: string]: any;
                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                          Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Slots.html b/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Slots.html index 85e1d642..4112fdf6 100644 --- a/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Slots.html +++ b/docs/types/_standard_component_fvtt.TJSFileSlotButton-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                          Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                                          Slots: {
                                                                                                                                                                                                                                                                                                                                                                                              default: {};
                                                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                                                          Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                                                          • default: {}

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                                            Slots: {
                                                                                                                                                                                                                                                                                                                                                                                                default: {};
                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSMediaContent-1.Events.html b/docs/types/_standard_component_fvtt.TJSMediaContent-1.Events.html index a962e8ec..681a5e11 100644 --- a/docs/types/_standard_component_fvtt.TJSMediaContent-1.Events.html +++ b/docs/types/_standard_component_fvtt.TJSMediaContent-1.Events.html @@ -1,2 +1,3 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                            Type alias Events

                                                                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Events | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Events

                                                                                                                                                                                                                                                                                                                                                                                            Events: {
                                                                                                                                                                                                                                                                                                                                                                                                [evt: string]: CustomEvent<any>;
                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                            Events type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSMediaContent-1.Props.html b/docs/types/_standard_component_fvtt.TJSMediaContent-1.Props.html index 43420540..d4df24dc 100644 --- a/docs/types/_standard_component_fvtt.TJSMediaContent-1.Props.html +++ b/docs/types/_standard_component_fvtt.TJSMediaContent-1.Props.html @@ -1,11 +1,12 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                            Type alias Props

                                                                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                                                                defaultMedia?: {
                                                                                                                                                                                                                                                                                                                                                                                                    elementType: string;
                                                                                                                                                                                                                                                                                                                                                                                                    filepath: string;
                                                                                                                                                                                                                                                                                                                                                                                                    valid: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                                                filepath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                imgAlt?: string;
                                                                                                                                                                                                                                                                                                                                                                                                media?: any;
                                                                                                                                                                                                                                                                                                                                                                                                title?: string;
                                                                                                                                                                                                                                                                                                                                                                                                videoAutoplay?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                videoLoop?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                videoMuted?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                videoPlayOnHover?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                videoPlaybackRate?: number;
                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                            • Optional defaultMedia?: {
                                                                                                                                                                                                                                                                                                                                                                                                  elementType: string;
                                                                                                                                                                                                                                                                                                                                                                                                  filepath: string;
                                                                                                                                                                                                                                                                                                                                                                                                  valid: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              TODO: provide type

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                              • elementType: string
                                                                                                                                                                                                                                                                                                                                                                                              • filepath: string
                                                                                                                                                                                                                                                                                                                                                                                              • valid: boolean
                                                                                                                                                                                                                                                                                                                                                                                            • Optional filepath?: string

                                                                                                                                                                                                                                                                                                                                                                                              Prop for filepath media content.

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • Optional imgAlt?: string

                                                                                                                                                                                                                                                                                                                                                                                              Alternate image text.

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • Optional media?: any
                                                                                                                                                                                                                                                                                                                                                                                            • Optional title?: string

                                                                                                                                                                                                                                                                                                                                                                                              A title for the media element.

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • Optional videoAutoplay?: boolean

                                                                                                                                                                                                                                                                                                                                                                                              Automatically start video playback; default: true

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • Optional videoLoop?: boolean

                                                                                                                                                                                                                                                                                                                                                                                              Automatically loop video; default: true

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • Optional videoMuted?: boolean

                                                                                                                                                                                                                                                                                                                                                                                              Mute video playback audio; default: true

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • Optional videoPlayOnHover?: boolean

                                                                                                                                                                                                                                                                                                                                                                                              Play video on pointer hover.

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                            • Optional videoPlaybackRate?: number

                                                                                                                                                                                                                                                                                                                                                                                              Video playback rate - clamped internally between 0 - 2.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                            Theme

                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +Props | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Type Alias Props

                                                                                                                                                                                                                                                                                                                                                                                            Props: {
                                                                                                                                                                                                                                                                                                                                                                                                defaultMedia?: {
                                                                                                                                                                                                                                                                                                                                                                                                    elementType: string;
                                                                                                                                                                                                                                                                                                                                                                                                    filepath: string;
                                                                                                                                                                                                                                                                                                                                                                                                    valid: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                };
                                                                                                                                                                                                                                                                                                                                                                                                filepath?: string;
                                                                                                                                                                                                                                                                                                                                                                                                imgAlt?: string;
                                                                                                                                                                                                                                                                                                                                                                                                media?: any;
                                                                                                                                                                                                                                                                                                                                                                                                title?: string;
                                                                                                                                                                                                                                                                                                                                                                                                videoAutoplay?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                videoLoop?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                videoMuted?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                                videoPlaybackRate?: number;
                                                                                                                                                                                                                                                                                                                                                                                                videoPlayOnHover?: boolean;
                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                            Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                            • OptionaldefaultMedia?: {
                                                                                                                                                                                                                                                                                                                                                                                                  elementType: string;
                                                                                                                                                                                                                                                                                                                                                                                                  filepath: string;
                                                                                                                                                                                                                                                                                                                                                                                                  valid: boolean;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              TODO: provide type

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              • elementType: string
                                                                                                                                                                                                                                                                                                                                                                                              • filepath: string
                                                                                                                                                                                                                                                                                                                                                                                              • valid: boolean
                                                                                                                                                                                                                                                                                                                                                                                            • Optionalfilepath?: string

                                                                                                                                                                                                                                                                                                                                                                                              Prop for filepath media content.

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                            • OptionalimgAlt?: string

                                                                                                                                                                                                                                                                                                                                                                                              Alternate image text.

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                            • Optionalmedia?: any
                                                                                                                                                                                                                                                                                                                                                                                            • Optionaltitle?: string

                                                                                                                                                                                                                                                                                                                                                                                              A title for the media element.

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                            • OptionalvideoAutoplay?: boolean

                                                                                                                                                                                                                                                                                                                                                                                              Automatically start video playback; default: true

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                            • OptionalvideoLoop?: boolean

                                                                                                                                                                                                                                                                                                                                                                                              Automatically loop video; default: true

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                            • OptionalvideoMuted?: boolean

                                                                                                                                                                                                                                                                                                                                                                                              Mute video playback audio; default: true

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                            • OptionalvideoPlaybackRate?: number

                                                                                                                                                                                                                                                                                                                                                                                              Video playback rate - clamped internally between 0 - 2.

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                            • OptionalvideoPlayOnHover?: boolean

                                                                                                                                                                                                                                                                                                                                                                                              Play video on pointer hover.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt.TJSMediaContent-1.Slots.html b/docs/types/_standard_component_fvtt.TJSMediaContent-1.Slots.html index 95a1e279..70746153 100644 --- a/docs/types/_standard_component_fvtt.TJSMediaContent-1.Slots.html +++ b/docs/types/_standard_component_fvtt.TJSMediaContent-1.Slots.html @@ -1,2 +1,3 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                            Type alias Slots

                                                                                                                                                                                                                                                                                                                                                                                            Slots: {
                                                                                                                                                                                                                                                                                                                                                                                                video-fallback: {};
                                                                                                                                                                                                                                                                                                                                                                                            }

                                                                                                                                                                                                                                                                                                                                                                                            Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                            Type declaration

                                                                                                                                                                                                                                                                                                                                                                                            • video-fallback: {}

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Slots | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Slots

                                                                                                                                                                                                                                                                                                                                                                                              Slots: {
                                                                                                                                                                                                                                                                                                                                                                                                  video-fallback: {};
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Slots type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_store.TJSThemeStoreComponent.html b/docs/types/_standard_store.TJSThemeStoreComponent.html index f6049ff4..167fe856 100644 --- a/docs/types/_standard_store.TJSThemeStoreComponent.html +++ b/docs/types/_standard_store.TJSThemeStoreComponent.html @@ -1,5 +1,6 @@ -TJSThemeStoreComponent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias TJSThemeStoreComponent

                                                                                                                                                                                                                                                                                                                                                                                              TJSThemeStoreComponent: {
                                                                                                                                                                                                                                                                                                                                                                                                  default?: string;
                                                                                                                                                                                                                                                                                                                                                                                                  label?: string;
                                                                                                                                                                                                                                                                                                                                                                                                  type: string;
                                                                                                                                                                                                                                                                                                                                                                                                  var?: string;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              • Optional default?: string

                                                                                                                                                                                                                                                                                                                                                                                                An optional default value for a CSS variable.

                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                              • Optional label?: string

                                                                                                                                                                                                                                                                                                                                                                                                An optional label for any variable / setting related component.

                                                                                                                                                                                                                                                                                                                                                                                                +TJSThemeStoreComponent | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Type Alias TJSThemeStoreComponent

                                                                                                                                                                                                                                                                                                                                                                                                TJSThemeStoreComponent: {
                                                                                                                                                                                                                                                                                                                                                                                                    default?: string;
                                                                                                                                                                                                                                                                                                                                                                                                    label?: string;
                                                                                                                                                                                                                                                                                                                                                                                                    type: string;
                                                                                                                                                                                                                                                                                                                                                                                                    var?: string;
                                                                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • Optionaldefault?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional default value for a CSS variable.

                                                                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                                                                • Optionallabel?: string

                                                                                                                                                                                                                                                                                                                                                                                                  An optional label for any variable / setting related component.

                                                                                                                                                                                                                                                                                                                                                                                                • type: string

                                                                                                                                                                                                                                                                                                                                                                                                  Type of component / variable.

                                                                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                                                                • Optional var?: string

                                                                                                                                                                                                                                                                                                                                                                                                  A CSS variable name.

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                              • Optionalvar?: string

                                                                                                                                                                                                                                                                                                                                                                                                A CSS variable name.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_store.TJSThemeStoreConfig.html b/docs/types/_standard_store.TJSThemeStoreConfig.html index eebac3b9..d450315b 100644 --- a/docs/types/_standard_store.TJSThemeStoreConfig.html +++ b/docs/types/_standard_store.TJSThemeStoreConfig.html @@ -1,3 +1,4 @@ -TJSThemeStoreConfig | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias TJSThemeStoreConfig

                                                                                                                                                                                                                                                                                                                                                                                              TJSThemeStoreConfig: {
                                                                                                                                                                                                                                                                                                                                                                                                  components: Iterable<TJSThemeStoreComponent>;
                                                                                                                                                                                                                                                                                                                                                                                                  version: string;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/_standard_store.TJSThemeStoreOptions.html b/docs/types/_standard_store.TJSThemeStoreOptions.html index c2e99fa4..997a3800 100644 --- a/docs/types/_standard_store.TJSThemeStoreOptions.html +++ b/docs/types/_standard_store.TJSThemeStoreOptions.html @@ -1,6 +1,7 @@ -TJSThemeStoreOptions | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias TJSThemeStoreOptions

                                                                                                                                                                                                                                                                                                                                                                                              TJSThemeStoreOptions: {
                                                                                                                                                                                                                                                                                                                                                                                                  config: TJSThemeStoreConfig;
                                                                                                                                                                                                                                                                                                                                                                                                  gameSettings: TJSGameSettings;
                                                                                                                                                                                                                                                                                                                                                                                                  key: string;
                                                                                                                                                                                                                                                                                                                                                                                                  namespace: string;
                                                                                                                                                                                                                                                                                                                                                                                                  styleManager: TJSStyleManager;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte.ComponentEvents.html b/docs/types/svelte.ComponentEvents.html index 0357ab22..1e13e63f 100644 --- a/docs/types/svelte.ComponentEvents.html +++ b/docs/types/svelte.ComponentEvents.html @@ -1,4 +1,6 @@ -ComponentEvents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias ComponentEvents<Component>

                                                                                                                                                                                                                                                                                                                                                                                              ComponentEvents<Component>: Component extends SvelteComponent<any, infer Events>
                                                                                                                                                                                                                                                                                                                                                                                                  ? Events
                                                                                                                                                                                                                                                                                                                                                                                                  : never

                                                                                                                                                                                                                                                                                                                                                                                              Convenience type to get the events the given component expects. Example:

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                              <script lang="ts">
                                                                                                                                                                                                                                                                                                                                                                                                 import type { ComponentEvents } from 'svelte';
                                                                                                                                                                                                                                                                                                                                                                                                 import Component from './Component.svelte';

                                                                                                                                                                                                                                                                                                                                                                                                 function handleCloseEvent(event: ComponentEvents<Component>['close']) {
                                                                                                                                                                                                                                                                                                                                                                                                    console.log(event.detail);
                                                                                                                                                                                                                                                                                                                                                                                                 }
                                                                                                                                                                                                                                                                                                                                                                                              </script>

                                                                                                                                                                                                                                                                                                                                                                                              <Component on:close={handleCloseEvent} />
-
                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +ComponentEvents | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ComponentEvents<Component>

                                                                                                                                                                                                                                                                                                                                                                                              ComponentEvents<Component>: Component extends SvelteComponent<any, infer Events>
                                                                                                                                                                                                                                                                                                                                                                                                  ? Events
                                                                                                                                                                                                                                                                                                                                                                                                  : never

                                                                                                                                                                                                                                                                                                                                                                                              Convenience type to get the events the given component expects. Example:

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              <script lang="ts">
                                                                                                                                                                                                                                                                                                                                                                                                 import type { ComponentEvents } from 'svelte';
                                                                                                                                                                                                                                                                                                                                                                                                 import Component from './Component.svelte';

                                                                                                                                                                                                                                                                                                                                                                                                 function handleCloseEvent(event: ComponentEvents<Component>['close']) {
                                                                                                                                                                                                                                                                                                                                                                                                    console.log(event.detail);
                                                                                                                                                                                                                                                                                                                                                                                                 }
                                                                                                                                                                                                                                                                                                                                                                                              </script>

                                                                                                                                                                                                                                                                                                                                                                                              <Component on:close={handleCloseEvent} />
+
                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte.ComponentProps.html b/docs/types/svelte.ComponentProps.html index 89bff345..dad1083e 100644 --- a/docs/types/svelte.ComponentProps.html +++ b/docs/types/svelte.ComponentProps.html @@ -1,4 +1,6 @@ -ComponentProps | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias ComponentProps<Component>

                                                                                                                                                                                                                                                                                                                                                                                              ComponentProps<Component>: Component extends SvelteComponent<infer Props>
                                                                                                                                                                                                                                                                                                                                                                                                  ? Props
                                                                                                                                                                                                                                                                                                                                                                                                  : never

                                                                                                                                                                                                                                                                                                                                                                                              Convenience type to get the props the given component expects. Example:

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                              <script lang="ts">
                                                                                                                                                                                                                                                                                                                                                                                                  import type { ComponentProps } from 'svelte';
                                                                                                                                                                                                                                                                                                                                                                                                  import Component from './Component.svelte';

                                                                                                                                                                                                                                                                                                                                                                                                  const props: ComponentProps<Component> = { foo: 'bar' }; // Errors if these aren't the correct props
                                                                                                                                                                                                                                                                                                                                                                                              </script>
-
                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +ComponentProps | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ComponentProps<Component>

                                                                                                                                                                                                                                                                                                                                                                                              ComponentProps<Component>: Component extends SvelteComponent<infer Props>
                                                                                                                                                                                                                                                                                                                                                                                                  ? Props
                                                                                                                                                                                                                                                                                                                                                                                                  : never

                                                                                                                                                                                                                                                                                                                                                                                              Convenience type to get the props the given component expects. Example:

                                                                                                                                                                                                                                                                                                                                                                                              +
                                                                                                                                                                                                                                                                                                                                                                                              <script lang="ts">
                                                                                                                                                                                                                                                                                                                                                                                              	import type { ComponentProps } from 'svelte';
                                                                                                                                                                                                                                                                                                                                                                                              	import Component from './Component.svelte';

                                                                                                                                                                                                                                                                                                                                                                                              	const props: ComponentProps<Component> = { foo: 'bar' }; // Errors if these aren't the correct props
                                                                                                                                                                                                                                                                                                                                                                                              </script>
+
                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte.ComponentType.html b/docs/types/svelte.ComponentType.html index 9038c06c..337329ef 100644 --- a/docs/types/svelte.ComponentType.html +++ b/docs/types/svelte.ComponentType.html @@ -1,7 +1,9 @@ -ComponentType | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias ComponentType<Component>

                                                                                                                                                                                                                                                                                                                                                                                              ComponentType<Component>: (new (options) => Component) & {
                                                                                                                                                                                                                                                                                                                                                                                                  element?: typeof HTMLElement;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Convenience type to get the type of a Svelte component. Useful for example in combination with +ComponentType | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias ComponentType<Component>

                                                                                                                                                                                                                                                                                                                                                                                              ComponentType<Component>: (new (options: ComponentConstructorOptions<Component extends SvelteComponent<infer Props>
                                                                                                                                                                                                                                                                                                                                                                                                  ? Props
                                                                                                                                                                                                                                                                                                                                                                                                  : Record<string, any>>) => Component) & {
                                                                                                                                                                                                                                                                                                                                                                                                  element?: typeof HTMLElement;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Convenience type to get the type of a Svelte component. Useful for example in combination with dynamic components using <svelte:component>.

                                                                                                                                                                                                                                                                                                                                                                                              Example:

                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                              <script lang="ts">
                                                                                                                                                                                                                                                                                                                                                                                                  import type { ComponentType, SvelteComponent } from 'svelte';
                                                                                                                                                                                                                                                                                                                                                                                                  import Component1 from './Component1.svelte';
                                                                                                                                                                                                                                                                                                                                                                                                  import Component2 from './Component2.svelte';

                                                                                                                                                                                                                                                                                                                                                                                                  const component: ComponentType = someLogic() ? Component1 : Component2;
                                                                                                                                                                                                                                                                                                                                                                                                  const componentOfCertainSubType: ComponentType<SvelteComponent<{ needsThisProp: string }>> = someLogic() ? Component1 : Component2;
                                                                                                                                                                                                                                                                                                                                                                                              </script>

                                                                                                                                                                                                                                                                                                                                                                                              <svelte:component this={component} />
                                                                                                                                                                                                                                                                                                                                                                                              <svelte:component this={componentOfCertainSubType} needsThisProp="hello" />
-
                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              • Optional element?: typeof HTMLElement

                                                                                                                                                                                                                                                                                                                                                                                                The custom element version of the component. Only present if compiled with the customElement compiler option

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                                                              <script lang="ts">
                                                                                                                                                                                                                                                                                                                                                                                              	import type { ComponentType, SvelteComponent } from 'svelte';
                                                                                                                                                                                                                                                                                                                                                                                              	import Component1 from './Component1.svelte';
                                                                                                                                                                                                                                                                                                                                                                                              	import Component2 from './Component2.svelte';

                                                                                                                                                                                                                                                                                                                                                                                              	const component: ComponentType = someLogic() ? Component1 : Component2;
                                                                                                                                                                                                                                                                                                                                                                                              	const componentOfCertainSubType: ComponentType<SvelteComponent<{ needsThisProp: string }>> = someLogic() ? Component1 : Component2;
                                                                                                                                                                                                                                                                                                                                                                                              </script>

                                                                                                                                                                                                                                                                                                                                                                                              <svelte:component this={component} />
                                                                                                                                                                                                                                                                                                                                                                                              <svelte:component this={componentOfCertainSubType} needsThisProp="hello" />
+
                                                                                                                                                                                                                                                                                                                                                                                              + +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              • Optionalelement?: typeof HTMLElement

                                                                                                                                                                                                                                                                                                                                                                                                The custom element version of the component. Only present if compiled with the customElement compiler option

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte.NotFunction.html b/docs/types/svelte.NotFunction.html index 3bcd9d32..38572db1 100644 --- a/docs/types/svelte.NotFunction.html +++ b/docs/types/svelte.NotFunction.html @@ -1,2 +1,3 @@ -NotFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias NotFunction<T>

                                                                                                                                                                                                                                                                                                                                                                                              NotFunction<T>: T extends Function
                                                                                                                                                                                                                                                                                                                                                                                                  ? never
                                                                                                                                                                                                                                                                                                                                                                                                  : T

                                                                                                                                                                                                                                                                                                                                                                                              Anything except a function

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +NotFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias NotFunction<T>

                                                                                                                                                                                                                                                                                                                                                                                              NotFunction<T>: T extends Function
                                                                                                                                                                                                                                                                                                                                                                                                  ? never
                                                                                                                                                                                                                                                                                                                                                                                                  : T

                                                                                                                                                                                                                                                                                                                                                                                              Anything except a function

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_motion.Invalidator.html b/docs/types/svelte_motion.Invalidator.html index 270e138e..498b75e7 100644 --- a/docs/types/svelte_motion.Invalidator.html +++ b/docs/types/svelte_motion.Invalidator.html @@ -1,2 +1,3 @@ -Invalidator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias Invalidator<T>

                                                                                                                                                                                                                                                                                                                                                                                              Invalidator<T>: ((value?) => void)

                                                                                                                                                                                                                                                                                                                                                                                              Cleanup logic callback.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (value?): void

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • Optional value: T

                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Invalidator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Invalidator<T>

                                                                                                                                                                                                                                                                                                                                                                                              Invalidator<T>: ((value?: T) => void)

                                                                                                                                                                                                                                                                                                                                                                                              Cleanup logic callback.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_motion.Subscriber.html b/docs/types/svelte_motion.Subscriber.html index 2a356caa..d09e3dcb 100644 --- a/docs/types/svelte_motion.Subscriber.html +++ b/docs/types/svelte_motion.Subscriber.html @@ -1,2 +1,3 @@ -Subscriber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias Subscriber<T>

                                                                                                                                                                                                                                                                                                                                                                                              Subscriber<T>: ((value) => void)

                                                                                                                                                                                                                                                                                                                                                                                              Callback to inform of a value updates.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (value): void

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • value: T

                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Subscriber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Subscriber<T>

                                                                                                                                                                                                                                                                                                                                                                                              Subscriber<T>: ((value: T) => void)

                                                                                                                                                                                                                                                                                                                                                                                              Callback to inform of a value updates.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_motion.Unsubscriber.html b/docs/types/svelte_motion.Unsubscriber.html index a651bd1e..e260623e 100644 --- a/docs/types/svelte_motion.Unsubscriber.html +++ b/docs/types/svelte_motion.Unsubscriber.html @@ -1,2 +1,3 @@ -Unsubscriber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias Unsubscriber

                                                                                                                                                                                                                                                                                                                                                                                              Unsubscriber: (() => void)

                                                                                                                                                                                                                                                                                                                                                                                              Unsubscribes from value updates.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (): void

                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Unsubscriber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Unsubscriber

                                                                                                                                                                                                                                                                                                                                                                                              Unsubscriber: (() => void)

                                                                                                                                                                                                                                                                                                                                                                                              Unsubscribes from value updates.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_motion.Updater.html b/docs/types/svelte_motion.Updater.html index 06d4093f..c6bb41d4 100644 --- a/docs/types/svelte_motion.Updater.html +++ b/docs/types/svelte_motion.Updater.html @@ -1 +1,2 @@ -Updater | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias Updater<T>

                                                                                                                                                                                                                                                                                                                                                                                              Updater<T>: ((target_value, value) => T)

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (target_value, value): T

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • target_value: T
                                                                                                                                                                                                                                                                                                                                                                                                  • value: T

                                                                                                                                                                                                                                                                                                                                                                                                  Returns T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Updater | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Updater<T>

                                                                                                                                                                                                                                                                                                                                                                                              Updater<T>: ((target_value: T, value: T) => T)

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_store.Invalidator.html b/docs/types/svelte_store.Invalidator.html index 02bc689c..974df9ba 100644 --- a/docs/types/svelte_store.Invalidator.html +++ b/docs/types/svelte_store.Invalidator.html @@ -1,2 +1,3 @@ -Invalidator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias Invalidator<T>

                                                                                                                                                                                                                                                                                                                                                                                              Invalidator<T>: ((value?) => void)

                                                                                                                                                                                                                                                                                                                                                                                              Cleanup logic callback.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (value?): void

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • Optional value: T

                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Invalidator | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Invalidator<T>

                                                                                                                                                                                                                                                                                                                                                                                              Invalidator<T>: ((value?: T) => void)

                                                                                                                                                                                                                                                                                                                                                                                              Cleanup logic callback.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_store.StartStopNotifier.html b/docs/types/svelte_store.StartStopNotifier.html index 883ac8be..86a58293 100644 --- a/docs/types/svelte_store.StartStopNotifier.html +++ b/docs/types/svelte_store.StartStopNotifier.html @@ -1,7 +1,8 @@ -StartStopNotifier | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias StartStopNotifier<T>

                                                                                                                                                                                                                                                                                                                                                                                              StartStopNotifier<T>: ((set, update) => void | (() => void))

                                                                                                                                                                                                                                                                                                                                                                                              Start and stop notification callbacks. +StartStopNotifier | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias StartStopNotifier<T>

                                                                                                                                                                                                                                                                                                                                                                                              StartStopNotifier<T>: ((set: ((value: T) => void), update: ((fn: Updater<T>) => void)) => void | (() => void))

                                                                                                                                                                                                                                                                                                                                                                                              Start and stop notification callbacks. This function is called when the first subscriber subscribes.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (set, update): void | (() => void)

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • set: ((value) => void)

                                                                                                                                                                                                                                                                                                                                                                                                    Function that sets the value of the store.

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                      • (value): void

                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                        • value: T

                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  • update: ((fn) => void)

                                                                                                                                                                                                                                                                                                                                                                                                    Function that sets the value of the store after passing the current value to the update function.

                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                      • (fn): void

                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  Returns void | (() => void)

                                                                                                                                                                                                                                                                                                                                                                                              Returns

                                                                                                                                                                                                                                                                                                                                                                                              Optionally, a cleanup function that is called when the last remaining +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (set, update): void | (() => void)

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • set: ((value: T) => void)

                                                                                                                                                                                                                                                                                                                                                                                                    Function that sets the value of the store.

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                      • (value): void

                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                        • value: T

                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  • update: ((fn: Updater<T>) => void)

                                                                                                                                                                                                                                                                                                                                                                                                    Function that sets the value of the store after passing the current value to the update function.

                                                                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                                                                      • (fn): void

                                                                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                        Returns void

                                                                                                                                                                                                                                                                                                                                                                                                  Returns void | (() => void)

                                                                                                                                                                                                                                                                                                                                                                                                  Optionally, a cleanup function that is called when the last remaining subscriber unsubscribes.

                                                                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_store.Stores.html b/docs/types/svelte_store.Stores.html index d2ffc298..8bc56da2 100644 --- a/docs/types/svelte_store.Stores.html +++ b/docs/types/svelte_store.Stores.html @@ -1,2 +1,3 @@ -Stores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias Stores

                                                                                                                                                                                                                                                                                                                                                                                              Stores: Readable<any> | [Readable<any>, ...Readable<any>[]] | Readable<any>[]

                                                                                                                                                                                                                                                                                                                                                                                              One or more Readables.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Stores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Stores

                                                                                                                                                                                                                                                                                                                                                                                              Stores: Readable<any> | [Readable<any>, ...Readable<any>[]] | Readable<any>[]

                                                                                                                                                                                                                                                                                                                                                                                              One or more Readables.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_store.StoresValues.html b/docs/types/svelte_store.StoresValues.html index 3e0ba28d..7927dcee 100644 --- a/docs/types/svelte_store.StoresValues.html +++ b/docs/types/svelte_store.StoresValues.html @@ -1,2 +1,3 @@ -StoresValues | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias StoresValues<T>

                                                                                                                                                                                                                                                                                                                                                                                              StoresValues<T>: T extends Readable<infer U>
                                                                                                                                                                                                                                                                                                                                                                                                  ? U
                                                                                                                                                                                                                                                                                                                                                                                                  : {
                                                                                                                                                                                                                                                                                                                                                                                                      [K in keyof T]: T[K] extends Readable<infer U>
                                                                                                                                                                                                                                                                                                                                                                                                          ? U
                                                                                                                                                                                                                                                                                                                                                                                                          : never
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                              One or more values from Readable stores.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +StoresValues | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias StoresValues<T>

                                                                                                                                                                                                                                                                                                                                                                                              StoresValues<T>: T extends Readable<infer U>
                                                                                                                                                                                                                                                                                                                                                                                                  ? U
                                                                                                                                                                                                                                                                                                                                                                                                  : {
                                                                                                                                                                                                                                                                                                                                                                                                      [K in keyof T]: T[K] extends Readable<infer U>
                                                                                                                                                                                                                                                                                                                                                                                                          ? U
                                                                                                                                                                                                                                                                                                                                                                                                          : never
                                                                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                                                              One or more values from Readable stores.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_store.Subscriber.html b/docs/types/svelte_store.Subscriber.html index 512b8e2f..bb9d8652 100644 --- a/docs/types/svelte_store.Subscriber.html +++ b/docs/types/svelte_store.Subscriber.html @@ -1,2 +1,3 @@ -Subscriber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias Subscriber<T>

                                                                                                                                                                                                                                                                                                                                                                                              Subscriber<T>: ((value) => void)

                                                                                                                                                                                                                                                                                                                                                                                              Callback to inform of a value updates.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (value): void

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • value: T

                                                                                                                                                                                                                                                                                                                                                                                                  Returns void

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Subscriber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Subscriber<T>

                                                                                                                                                                                                                                                                                                                                                                                              Subscriber<T>: ((value: T) => void)

                                                                                                                                                                                                                                                                                                                                                                                              Callback to inform of a value updates.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_store.Unsubscriber.html b/docs/types/svelte_store.Unsubscriber.html index 76a6f313..85b57300 100644 --- a/docs/types/svelte_store.Unsubscriber.html +++ b/docs/types/svelte_store.Unsubscriber.html @@ -1,2 +1,3 @@ -Unsubscriber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias Unsubscriber

                                                                                                                                                                                                                                                                                                                                                                                              Unsubscriber: (() => void)

                                                                                                                                                                                                                                                                                                                                                                                              Unsubscribes from value updates.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (): void

                                                                                                                                                                                                                                                                                                                                                                                                • Returns void

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Unsubscriber | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Unsubscriber

                                                                                                                                                                                                                                                                                                                                                                                              Unsubscriber: (() => void)

                                                                                                                                                                                                                                                                                                                                                                                              Unsubscribes from value updates.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_store.Updater.html b/docs/types/svelte_store.Updater.html index 483957e1..bba61b55 100644 --- a/docs/types/svelte_store.Updater.html +++ b/docs/types/svelte_store.Updater.html @@ -1,2 +1,3 @@ -Updater | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias Updater<T>

                                                                                                                                                                                                                                                                                                                                                                                              Updater<T>: ((value) => T)

                                                                                                                                                                                                                                                                                                                                                                                              Callback to update a value.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (value): T

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • value: T

                                                                                                                                                                                                                                                                                                                                                                                                  Returns T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Updater | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias Updater<T>

                                                                                                                                                                                                                                                                                                                                                                                              Updater<T>: ((value: T) => T)

                                                                                                                                                                                                                                                                                                                                                                                              Callback to update a value.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Parameters

                                                                                                                                                                                                                                                                                                                                                                                              • T

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/types/svelte_transition.EasingFunction.html b/docs/types/svelte_transition.EasingFunction.html index 1a40aaba..b00277fa 100644 --- a/docs/types/svelte_transition.EasingFunction.html +++ b/docs/types/svelte_transition.EasingFunction.html @@ -1 +1,2 @@ -EasingFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Type alias EasingFunction

                                                                                                                                                                                                                                                                                                                                                                                              EasingFunction: ((t) => number)

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                • (t): number

                                                                                                                                                                                                                                                                                                                                                                                                • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                  • t: number

                                                                                                                                                                                                                                                                                                                                                                                                  Returns number

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +EasingFunction | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Type Alias EasingFunction

                                                                                                                                                                                                                                                                                                                                                                                              EasingFunction: ((t: number) => number)

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/variables/_runtime_data_compress.FlateErrorCode.html b/docs/variables/_runtime_data_compress.FlateErrorCode.html index 48c9d1f9..b3902dae 100644 --- a/docs/variables/_runtime_data_compress.FlateErrorCode.html +++ b/docs/variables/_runtime_data_compress.FlateErrorCode.html @@ -1,2 +1,3 @@ -FlateErrorCode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Variable FlateErrorCodeConst

                                                                                                                                                                                                                                                                                                                                                                                              FlateErrorCode: {
                                                                                                                                                                                                                                                                                                                                                                                                  ExtraFieldTooLong: 9;
                                                                                                                                                                                                                                                                                                                                                                                                  FilenameTooLong: 11;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidBlockType: 1;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidDate: 10;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidDistance: 3;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidHeader: 6;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidLengthLiteral: 2;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidUTF8: 8;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidZipData: 13;
                                                                                                                                                                                                                                                                                                                                                                                                  NoCallback: 7;
                                                                                                                                                                                                                                                                                                                                                                                                  NoStreamHandler: 5;
                                                                                                                                                                                                                                                                                                                                                                                                  StreamFinished: 4;
                                                                                                                                                                                                                                                                                                                                                                                                  StreamFinishing: 12;
                                                                                                                                                                                                                                                                                                                                                                                                  UnexpectedEOF: 0;
                                                                                                                                                                                                                                                                                                                                                                                                  UnknownCompressionMethod: 14;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Codes for errors generated within this library

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              • Readonly ExtraFieldTooLong: 9
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly FilenameTooLong: 11
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly InvalidBlockType: 1
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly InvalidDate: 10
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly InvalidDistance: 3
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly InvalidHeader: 6
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly InvalidLengthLiteral: 2
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly InvalidUTF8: 8
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly InvalidZipData: 13
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly NoCallback: 7
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly NoStreamHandler: 5
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly StreamFinished: 4
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly StreamFinishing: 12
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly UnexpectedEOF: 0
                                                                                                                                                                                                                                                                                                                                                                                              • Readonly UnknownCompressionMethod: 14

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +FlateErrorCode | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Variable FlateErrorCodeConst

                                                                                                                                                                                                                                                                                                                                                                                              FlateErrorCode: {
                                                                                                                                                                                                                                                                                                                                                                                                  ExtraFieldTooLong: 9;
                                                                                                                                                                                                                                                                                                                                                                                                  FilenameTooLong: 11;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidBlockType: 1;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidDate: 10;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidDistance: 3;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidHeader: 6;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidLengthLiteral: 2;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidUTF8: 8;
                                                                                                                                                                                                                                                                                                                                                                                                  InvalidZipData: 13;
                                                                                                                                                                                                                                                                                                                                                                                                  NoCallback: 7;
                                                                                                                                                                                                                                                                                                                                                                                                  NoStreamHandler: 5;
                                                                                                                                                                                                                                                                                                                                                                                                  StreamFinished: 4;
                                                                                                                                                                                                                                                                                                                                                                                                  StreamFinishing: 12;
                                                                                                                                                                                                                                                                                                                                                                                                  UnexpectedEOF: 0;
                                                                                                                                                                                                                                                                                                                                                                                                  UnknownCompressionMethod: 14;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Codes for errors generated within this library

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/variables/_runtime_data_format_base64.Base64.html b/docs/variables/_runtime_data_format_base64.Base64.html index 29d00bce..ea343a7b 100644 --- a/docs/variables/_runtime_data_format_base64.Base64.html +++ b/docs/variables/_runtime_data_format_base64.Base64.html @@ -1 +1,2 @@ -Base64 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Variable Base64Const

                                                                                                                                                                                                                                                                                                                                                                                              Base64: {
                                                                                                                                                                                                                                                                                                                                                                                                  VERSION: string;
                                                                                                                                                                                                                                                                                                                                                                                                  atob: ((asc) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  atobPolyfill: ((asc) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  btoa: ((bin) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  btoaPolyfill: ((bin) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  btou: ((b) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  decode: ((src) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  encode: ((src, urlsafe?) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  encodeURI: ((src) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  encodeURL: ((src) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  extendBuiltins: (() => void);
                                                                                                                                                                                                                                                                                                                                                                                                  extendString: (() => void);
                                                                                                                                                                                                                                                                                                                                                                                                  extendUint8Array: (() => void);
                                                                                                                                                                                                                                                                                                                                                                                                  fromBase64: ((src) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  fromUint8Array: ((u8a, urlsafe?) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  isValid: ((src) => boolean);
                                                                                                                                                                                                                                                                                                                                                                                                  toBase64: ((src, urlsafe?) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  toUint8Array: ((a) => Uint8Array);
                                                                                                                                                                                                                                                                                                                                                                                                  utob: ((u) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  version: string;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                              • VERSION: string
                                                                                                                                                                                                                                                                                                                                                                                              • atob: ((asc) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (asc): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • asc: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • atobPolyfill: ((asc) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (asc): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • asc: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • btoa: ((bin) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (bin): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • bin: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • btoaPolyfill: ((bin) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (bin): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • bin: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • btou: ((b) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (b): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • b: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • decode: ((src) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (src): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • src: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • encode: ((src, urlsafe?) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (src, urlsafe?): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • src: string
                                                                                                                                                                                                                                                                                                                                                                                                    • Optional urlsafe: boolean

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • encodeURI: ((src) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (src): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • src: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • encodeURL: ((src) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (src): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • src: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • extendBuiltins: (() => void)
                                                                                                                                                                                                                                                                                                                                                                                                  • (): void

                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                              • extendString: (() => void)
                                                                                                                                                                                                                                                                                                                                                                                                  • (): void

                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                              • extendUint8Array: (() => void)
                                                                                                                                                                                                                                                                                                                                                                                                  • (): void

                                                                                                                                                                                                                                                                                                                                                                                                  • Returns void

                                                                                                                                                                                                                                                                                                                                                                                              • fromBase64: ((src) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (src): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • src: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • fromUint8Array: ((u8a, urlsafe?) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (u8a, urlsafe?): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • isValid: ((src) => boolean)
                                                                                                                                                                                                                                                                                                                                                                                                  • (src): boolean

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • src: any

                                                                                                                                                                                                                                                                                                                                                                                                    Returns boolean

                                                                                                                                                                                                                                                                                                                                                                                              • toBase64: ((src, urlsafe?) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (src, urlsafe?): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • src: string
                                                                                                                                                                                                                                                                                                                                                                                                    • Optional urlsafe: boolean

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • toUint8Array: ((a) => Uint8Array)
                                                                                                                                                                                                                                                                                                                                                                                              • utob: ((u) => string)
                                                                                                                                                                                                                                                                                                                                                                                                  • (u): string

                                                                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • u: string

                                                                                                                                                                                                                                                                                                                                                                                                    Returns string

                                                                                                                                                                                                                                                                                                                                                                                              • version: string

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +Base64 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Variable Base64Const

                                                                                                                                                                                                                                                                                                                                                                                              Base64: {
                                                                                                                                                                                                                                                                                                                                                                                                  atob: ((asc: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  atobPolyfill: ((asc: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  btoa: ((bin: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  btoaPolyfill: ((bin: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  btou: ((b: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  decode: ((src: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  encode: ((src: string, urlsafe?: boolean) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  encodeURI: ((src: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  encodeURL: ((src: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  extendBuiltins: (() => void);
                                                                                                                                                                                                                                                                                                                                                                                                  extendString: (() => void);
                                                                                                                                                                                                                                                                                                                                                                                                  extendUint8Array: (() => void);
                                                                                                                                                                                                                                                                                                                                                                                                  fromBase64: ((src: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  fromUint8Array: ((u8a: Uint8Array, urlsafe?: boolean) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  isValid: ((src: any) => boolean);
                                                                                                                                                                                                                                                                                                                                                                                                  toBase64: ((src: string, urlsafe?: boolean) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  toUint8Array: ((a: string) => Uint8Array);
                                                                                                                                                                                                                                                                                                                                                                                                  utob: ((u: string) => string);
                                                                                                                                                                                                                                                                                                                                                                                                  version: string;
                                                                                                                                                                                                                                                                                                                                                                                                  VERSION: string;
                                                                                                                                                                                                                                                                                                                                                                                              }

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/variables/_runtime_data_format_base64.VERSION.html b/docs/variables/_runtime_data_format_base64.VERSION.html index 8b956b1e..ad51c82b 100644 --- a/docs/variables/_runtime_data_format_base64.VERSION.html +++ b/docs/variables/_runtime_data_format_base64.VERSION.html @@ -1,2 +1,8 @@ -VERSION | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Variable VERSIONConst

                                                                                                                                                                                                                                                                                                                                                                                              VERSION: "3.7.7" = '3.7.7'

                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                              use lowercase version.

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +version | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Variable versionConst

                                                                                                                                                                                                                                                                                                                                                                                              version: "3.7.7" = '3.7.7'

                                                                                                                                                                                                                                                                                                                                                                                              base64.ts

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Licensed under the BSD 3-Clause License. +http://opensource.org/licenses/BSD-3-Clause

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              References: +http://en.wikipedia.org/wiki/Base64

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Author

                                                                                                                                                                                                                                                                                                                                                                                              Dan Kogai (https://github.com/dankogai)

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/variables/_runtime_data_format_base64.version-1.html b/docs/variables/_runtime_data_format_base64.version-1.html index febac8fa..a5c614fe 100644 --- a/docs/variables/_runtime_data_format_base64.version-1.html +++ b/docs/variables/_runtime_data_format_base64.version-1.html @@ -1,7 +1,3 @@ -version | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Variable versionConst

                                                                                                                                                                                                                                                                                                                                                                                              version: "3.7.7" = '3.7.7'

                                                                                                                                                                                                                                                                                                                                                                                              base64.ts

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Licensed under the BSD 3-Clause License. - http://opensource.org/licenses/BSD-3-Clause

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              References: - http://en.wikipedia.org/wiki/Base64

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Author

                                                                                                                                                                                                                                                                                                                                                                                              Dan Kogai (https://github.com/dankogai)

                                                                                                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                              Theme

                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +VERSION | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Variable VERSIONConst

                                                                                                                                                                                                                                                                                                                                                                                              VERSION: "3.7.7" = '3.7.7'

                                                                                                                                                                                                                                                                                                                                                                                              Deprecated

                                                                                                                                                                                                                                                                                                                                                                                              use lowercase version.

                                                                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/variables/_runtime_data_format_msgpack.C1.html b/docs/variables/_runtime_data_format_msgpack.C1.html index da3c7984..126952fe 100644 --- a/docs/variables/_runtime_data_format_msgpack.C1.html +++ b/docs/variables/_runtime_data_format_msgpack.C1.html @@ -1 +1,2 @@ -C1 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                              Variable C1Const

                                                                                                                                                                                                                                                                                                                                                                                              C1: {}

                                                                                                                                                                                                                                                                                                                                                                                              Type declaration

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +C1 | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable C1Const

                                                                                                                                                                                                                                                                                                                                                                                                C1: {}

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_data_format_msgpack.isNativeAccelerationEnabled.html b/docs/variables/_runtime_data_format_msgpack.isNativeAccelerationEnabled.html index b380c316..bf56f2ea 100644 --- a/docs/variables/_runtime_data_format_msgpack.isNativeAccelerationEnabled.html +++ b/docs/variables/_runtime_data_format_msgpack.isNativeAccelerationEnabled.html @@ -1 +1,2 @@ -isNativeAccelerationEnabled | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable isNativeAccelerationEnabled

                                                                                                                                                                                                                                                                                                                                                                                                isNativeAccelerationEnabled: boolean

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +isNativeAccelerationEnabled | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable isNativeAccelerationEnabled

                                                                                                                                                                                                                                                                                                                                                                                                isNativeAccelerationEnabled: boolean

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_plugin_manager_eventbus_buses.eventbus.html b/docs/variables/_runtime_plugin_manager_eventbus_buses.eventbus.html index f899dc84..2e54a892 100644 --- a/docs/variables/_runtime_plugin_manager_eventbus_buses.eventbus.html +++ b/docs/variables/_runtime_plugin_manager_eventbus_buses.eventbus.html @@ -1,2 +1,3 @@ -eventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable eventbusConst

                                                                                                                                                                                                                                                                                                                                                                                                eventbus: Eventbus

                                                                                                                                                                                                                                                                                                                                                                                                Provides a main eventbus instance.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +eventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable eventbusConst

                                                                                                                                                                                                                                                                                                                                                                                                eventbus: Eventbus

                                                                                                                                                                                                                                                                                                                                                                                                Provides a main eventbus instance.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_plugin_manager_eventbus_buses.pluginEventbus.html b/docs/variables/_runtime_plugin_manager_eventbus_buses.pluginEventbus.html index f2564a33..0ba55540 100644 --- a/docs/variables/_runtime_plugin_manager_eventbus_buses.pluginEventbus.html +++ b/docs/variables/_runtime_plugin_manager_eventbus_buses.pluginEventbus.html @@ -1,2 +1,3 @@ -pluginEventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable pluginEventbusConst

                                                                                                                                                                                                                                                                                                                                                                                                pluginEventbus: Eventbus

                                                                                                                                                                                                                                                                                                                                                                                                Provides an eventbus instance potentially for use with a plugin system.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +pluginEventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable pluginEventbusConst

                                                                                                                                                                                                                                                                                                                                                                                                pluginEventbus: Eventbus

                                                                                                                                                                                                                                                                                                                                                                                                Provides an eventbus instance potentially for use with a plugin system.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_plugin_manager_eventbus_buses.testEventbus.html b/docs/variables/_runtime_plugin_manager_eventbus_buses.testEventbus.html index dc20d2ca..175f1f74 100644 --- a/docs/variables/_runtime_plugin_manager_eventbus_buses.testEventbus.html +++ b/docs/variables/_runtime_plugin_manager_eventbus_buses.testEventbus.html @@ -1,2 +1,3 @@ -testEventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable testEventbusConst

                                                                                                                                                                                                                                                                                                                                                                                                testEventbus: Eventbus

                                                                                                                                                                                                                                                                                                                                                                                                Provides an eventbus instance potentially for use for testing.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +testEventbus | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable testEventbusConst

                                                                                                                                                                                                                                                                                                                                                                                                testEventbus: Eventbus

                                                                                                                                                                                                                                                                                                                                                                                                Provides an eventbus instance potentially for use for testing.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_easing.easingFunc.html b/docs/variables/_runtime_svelte_easing.easingFunc.html index 8fe2f968..d1e98c2f 100644 --- a/docs/variables/_runtime_svelte_easing.easingFunc.html +++ b/docs/variables/_runtime_svelte_easing.easingFunc.html @@ -1 +1,2 @@ -easingFunc | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable easingFuncConst

                                                                                                                                                                                                                                                                                                                                                                                                easingFunc: Readonly<Record<EasingFunctionName, EasingFunction>>

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +easingFunc | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable easingFuncConst

                                                                                                                                                                                                                                                                                                                                                                                                easingFunc: Readonly<Record<EasingFunctionName, EasingFunction>>

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_easing.easingList.html b/docs/variables/_runtime_svelte_easing.easingList.html index 9f0cc89b..61e03ec7 100644 --- a/docs/variables/_runtime_svelte_easing.easingList.html +++ b/docs/variables/_runtime_svelte_easing.easingList.html @@ -1,2 +1,3 @@ -easingList | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable easingListConst

                                                                                                                                                                                                                                                                                                                                                                                                easingList: Readonly<EasingFunctionName[]>

                                                                                                                                                                                                                                                                                                                                                                                                Defines a read-only list of Svelte easing function names.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +easingList | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable easingListConst

                                                                                                                                                                                                                                                                                                                                                                                                easingList: Readonly<EasingFunctionName[]>

                                                                                                                                                                                                                                                                                                                                                                                                Defines a read-only list of Svelte easing function names.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_gsap.gsap.html b/docs/variables/_runtime_svelte_gsap.gsap.html index 00268dea..83b48a65 100644 --- a/docs/variables/_runtime_svelte_gsap.gsap.html +++ b/docs/variables/_runtime_svelte_gsap.gsap.html @@ -1,3 +1,4 @@ -gsap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable gsap

                                                                                                                                                                                                                                                                                                                                                                                                gsap: any

                                                                                                                                                                                                                                                                                                                                                                                                The main GSAP object.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                See

                                                                                                                                                                                                                                                                                                                                                                                                https://greensock.com/docs/v3/GSAP

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +gsap | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable gsap

                                                                                                                                                                                                                                                                                                                                                                                                gsap: any

                                                                                                                                                                                                                                                                                                                                                                                                The main GSAP object.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                See

                                                                                                                                                                                                                                                                                                                                                                                                https://greensock.com/docs/v3/GSAP

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_gsap.gsapEasingFunc.html b/docs/variables/_runtime_svelte_gsap.gsapEasingFunc.html index 037c4cae..21e11240 100644 --- a/docs/variables/_runtime_svelte_gsap.gsapEasingFunc.html +++ b/docs/variables/_runtime_svelte_gsap.gsapEasingFunc.html @@ -1,4 +1,5 @@ -gsapEasingFunc | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable gsapEasingFuncConst

                                                                                                                                                                                                                                                                                                                                                                                                gsapEasingFunc: Readonly<Record<any, EasingFunction>>

                                                                                                                                                                                                                                                                                                                                                                                                Provides an object of Gsap and Svelte easing functions that are preconfigured and registered with gsap. +gsapEasingFunc | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable gsapEasingFuncConst

                                                                                                                                                                                                                                                                                                                                                                                                gsapEasingFunc: Readonly<Record<any, EasingFunction>>

                                                                                                                                                                                                                                                                                                                                                                                                Provides an object of Gsap and Svelte easing functions that are preconfigured and registered with gsap. gsapEasingList is an index of all the function names that are available in the gsapEasingFunc object. You may use these functions with Gsap or Svelte.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_gsap.gsapEasingList.html b/docs/variables/_runtime_svelte_gsap.gsapEasingList.html index 4eca5526..11dc091c 100644 --- a/docs/variables/_runtime_svelte_gsap.gsapEasingList.html +++ b/docs/variables/_runtime_svelte_gsap.gsapEasingList.html @@ -1,4 +1,5 @@ -gsapEasingList | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable gsapEasingListConst

                                                                                                                                                                                                                                                                                                                                                                                                gsapEasingList: ReadonlyArray<GsapEasingFunctionName>

                                                                                                                                                                                                                                                                                                                                                                                                Provides a list of Gsap easing functions that are preconfigured and registered with gsap. gsapEasingList +gsapEasingList | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable gsapEasingListConst

                                                                                                                                                                                                                                                                                                                                                                                                gsapEasingList: ReadonlyArray<GsapEasingFunctionName>

                                                                                                                                                                                                                                                                                                                                                                                                Provides a list of Gsap easing functions that are preconfigured and registered with gsap. gsapEasingList is an index of all the function names that are available in the gsapEasingFunc object. Additionally, all Svelte easing functions are loaded and prepended with svelte-<function name>.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_store_fvtt.gameState.html b/docs/variables/_runtime_svelte_store_fvtt.gameState.html index c701ca19..aa3f356e 100644 --- a/docs/variables/_runtime_svelte_store_fvtt.gameState.html +++ b/docs/variables/_runtime_svelte_store_fvtt.gameState.html @@ -1 +1,2 @@ -gameState | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable gameStateConst

                                                                                                                                                                                                                                                                                                                                                                                                gameState: Readable<globalThis.game>

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +gameState | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable gameStateConst

                                                                                                                                                                                                                                                                                                                                                                                                gameState: Readable<globalThis.game>

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_store_web_storage.localStores.html b/docs/variables/_runtime_svelte_store_web_storage.localStores.html index 2cde6768..2f56f992 100644 --- a/docs/variables/_runtime_svelte_store_web_storage.localStores.html +++ b/docs/variables/_runtime_svelte_store_web_storage.localStores.html @@ -1,2 +1,3 @@ -localStores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable localStoresConst

                                                                                                                                                                                                                                                                                                                                                                                                localStores: StorageStores

                                                                                                                                                                                                                                                                                                                                                                                                Provides all Storage API enabled localStorage store helper functions. Data is serialized as JSON.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +localStores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable localStoresConst

                                                                                                                                                                                                                                                                                                                                                                                                localStores: StorageStores

                                                                                                                                                                                                                                                                                                                                                                                                Provides all Storage API enabled localStorage store helper functions. Data is serialized as JSON.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_store_web_storage.sessionStores.html b/docs/variables/_runtime_svelte_store_web_storage.sessionStores.html index 33a1540d..08b70c0e 100644 --- a/docs/variables/_runtime_svelte_store_web_storage.sessionStores.html +++ b/docs/variables/_runtime_svelte_store_web_storage.sessionStores.html @@ -1,2 +1,3 @@ -sessionStores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable sessionStoresConst

                                                                                                                                                                                                                                                                                                                                                                                                sessionStores: StorageStores

                                                                                                                                                                                                                                                                                                                                                                                                Provides all Storage API enabled sessionStorage store helper functions. Data is serialized as JSON.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +sessionStores | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable sessionStoresConst

                                                                                                                                                                                                                                                                                                                                                                                                sessionStores: StorageStores

                                                                                                                                                                                                                                                                                                                                                                                                Provides all Storage API enabled sessionStorage store helper functions. Data is serialized as JSON.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_store_web_storage_msgpack.localStoresBCMP.html b/docs/variables/_runtime_svelte_store_web_storage_msgpack.localStoresBCMP.html index a730dbcc..5ba45725 100644 --- a/docs/variables/_runtime_svelte_store_web_storage_msgpack.localStoresBCMP.html +++ b/docs/variables/_runtime_svelte_store_web_storage_msgpack.localStoresBCMP.html @@ -1,2 +1,3 @@ -localStoresBCMP | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable localStoresBCMPConst

                                                                                                                                                                                                                                                                                                                                                                                                localStoresBCMP: StorageStores

                                                                                                                                                                                                                                                                                                                                                                                                Provides all MessagePack enabled localStorage store helper functions. Data is compressed and converted to base64.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +localStoresBCMP | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable localStoresBCMPConst

                                                                                                                                                                                                                                                                                                                                                                                                localStoresBCMP: StorageStores

                                                                                                                                                                                                                                                                                                                                                                                                Provides all MessagePack enabled localStorage store helper functions. Data is compressed and converted to base64.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_store_web_storage_msgpack.sessionStoresBCMP.html b/docs/variables/_runtime_svelte_store_web_storage_msgpack.sessionStoresBCMP.html index 68b81da9..bb06cd83 100644 --- a/docs/variables/_runtime_svelte_store_web_storage_msgpack.sessionStoresBCMP.html +++ b/docs/variables/_runtime_svelte_store_web_storage_msgpack.sessionStoresBCMP.html @@ -1,2 +1,3 @@ -sessionStoresBCMP | TyphonJS Runtime Library (FVTT) 0.2.0-next.1

                                                                                                                                                                                                                                                                                                                                                                                                Variable sessionStoresBCMPConst

                                                                                                                                                                                                                                                                                                                                                                                                sessionStoresBCMP: StorageStores

                                                                                                                                                                                                                                                                                                                                                                                                Provides all MessagePack enabled sessionStorage store helper functions. Data is compressed and converted to base64.

                                                                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                                                                Theme

                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +sessionStoresBCMP | TyphonJS Runtime Library (FVTT) 0.2.0-next.1
                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Variable sessionStoresBCMPConst

                                                                                                                                                                                                                                                                                                                                                                                                sessionStoresBCMP: StorageStores

                                                                                                                                                                                                                                                                                                                                                                                                Provides all MessagePack enabled sessionStorage store helper functions. Data is compressed and converted to base64.

                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file